/* Version: 16.0.14704.10000 */
/*
Copyright (c) Microsoft Corporation. All rights reserved.
*/
/*
Your use of this file is governed by the Microsoft Services Agreement http://go.microsoft.com/fwlink/?LinkId=266419.
*/
if (!Office) {
var Office = new function () {
this._appContext = 127; // All hosts; see _officeintellisense.js in VS, with binary 1111111
this._showAll = true;
this._setContext = {};
}
}
Office._ExcelMask = 0x1;
Office._WordMask = 0x2;
Office._ProjectMask = 0x4;
Office._OutlookMask = 0x8;
Office._PowerPointMask = 0x10;
Office._OutlookComposeMask = 0x20;
Office._AccessWebAppMask = 0x40;
{
Office._extractedCallback = function (originalArgs, totalArgsCount, optionalArgsCount) {
var optionalArgs = Array.prototype.slice.call(originalArgs, totalArgsCount - optionalArgsCount);
var callback = function(){};
for (var i = Math.min(optionalArgs.length, optionalArgsCount) - 1; i >= 0; i--) {
if (typeof optionalArgs[i] == "function") {
callback = optionalArgs[i];
break;
}
}
return callback;
}
Office._BindingDataChangedEvents = function (eventType) {
this.binding = new Office._Binding(bindingType);
this.type = eventType;
this.startColumn = {};
this.startRow = {};
}
Office._DocumentEventArgs = function (eventType) {
Office._processContents(this, {
type: {
annotate: {
///
type: undefined
},
value: eventType
}
});
if (eventType == "activeViewChanged") {
Office._processItem(
this,
{
annotate: {
///
activeView: undefined
}
},
"activeView"
);
}
}
Office._DialogEventArgs = function (eventType) {
Office._processContents(this, {
type: {
annotate: {
///
type: undefined
},
value: eventType
}
});
if (eventType == "dialogMessageReceived") {
Office._processItem(
this,
{
annotate: {
///
message: undefined
}
},
"message"
);
} else if (eventType == "dialogEventReceived") {
Office._processItem(
this,
{
annotate: {
///
error: undefined
}
},
"error"
);
}
}
Office._CustomXmlNodeEvents = function (eventType) {
this.type = eventType;
this.inUndoRedo = {};
if (eventType == 'nodeDeleted') {
this.oldNode = new Office._CustomXmlNode();
this.oldNextSibling = new Office._CustomXmlNode();
}
if (eventType == 'nodeInserted') {
this.newNode = new Office._CustomXmlNode();
}
if (eventType == 'nodeReplaced') {
this.oldNode = new Office._CustomXmlNode();
this.newNode = new Office._CustomXmlNode();
}
}
Office._Error = function () {
this.id = {};
this.message = {};
this.name = {};
}
Office._CustomXmlNode = function () {
this.baseName = {};
this.namespaceUri = {};
this.nodeType = {};
this.getNodesAsync = function (xPath, callback) {
/// Gets the nodes associated with the xPath expression.
///The xPath expression
///The optional callback method
var result = new Office._AsyncResult("getNodesAsync");
callback(result);
};
this.getNodeValueAsync = function (callback) {
/// Gets the node value.
///The optional callback method
var result = new Office._AsyncResult("getNodeValueAsync");
callback(result);
};
this.getXmlAsync = function (callback) {
/// Gets the node's XML.
///The optional callback method
var result = new Office._AsyncResult("getXmlAsync");
callback(result);
};
this.setNodeValueAsync = function (value, callback) {
/// Sets the node value.
///The value to be set on the node
///The optional callback method
var result = new Office._AsyncResult("setNodeValueAsync");
callback(result);
};
this.setXmlAsync = function (xml, callback) {
/// Sets the node XML.
///The XML to be set on the node
///The optional callback method
var result = new Office._AsyncResult("setXmlAsync");
callback(result);
};
}
Office._context_document_customXmlParts_customXmlPrefixMappings = function () {
this.addNamespaceAsync = function (prefix, nsUri, callback) {
///Adds a namespace.
//////The namespace prefix
//////The namespace URI
///The optional callback method
var result = new Office._AsyncResult("addNamespaceAsync");
callback(result);
};
this.getNamespaceAsync = function (prefix, callback) {
/// Gets a namespace with the specified prefix
///The namespace prefix
///The optional callback method
var result = new Office._AsyncResult("getNamespaceAsync");
callback(result);
};
this.getPrefixAsync = function (nsUri, callback) {
/// Gets a prefix for the specified URI
///The namespace URI
///The optional callback method
var result = new Office._AsyncResult("getPrefixAsync");
callback(result);
};
}
Office._CustomXmlPart = function () {
this.builtIn = {};
this.id = {};
this.namespaceManager = new Office._context_document_customXmlParts_customXmlPrefixMappings();
this.deleteAsync = function (callback) {
/// Deletes the Custom XML Part.
///The optional callback method
var result = new Office._AsyncResult("deleteAsync");
callback(result);
};
this.getNodesAsync = function (xPath, callback) {
/// Gets the nodes associated with the xPath expression.
///The xPath expression
///The optional callback method
var result = new Office._AsyncResult("getNodesAsync");
callback(result);
};
this.getXmlAsync = function (callback) {
/// Gets the XML for the Custom XML Part.
///The optional callback method
var result = new Office._AsyncResult("getXmlAsync");
callback(result);
};
this.addHandlerAsync = function (eventType, handler, callback) {
/// Adds an event handler to the object using the specified event type.
///The event type. For CustomXmlPartNode it can be 'nodeDeleted', 'nodeInserted' or 'nodeReplaced'
///The name of the handler
///The optional callback method
var events = new Office._CustomXmlNodeEvents(eventType);
handler(events);
var result = new Office._AsyncResult("addHandlerAsync");
callback(result);
};
this.removeHandlerAsync = function (eventType, options, callback) {
/// Removes an event handler from the object using the specified event type.
///The event type. For CustomXmlPartNode it can be 'nodeDeleted', 'nodeInserted' or 'nodeReplaced'
///
/// Syntax example: {handler:eventHandler}
///
handler: Indicates a specific handler to be removed, if not specified all handlers are removed
///
asyncContext: Object keeping state for the callback
///
///The optional callback method
///
Office._extractedCallback(arguments, 3, 2)(new Office._AsyncResult("removeHandlerAsync"));
}
}
Office._Binding = function (bindingType) {
///Id of the Binding};
this.id = {};
this.type = {};
this.document = {};
this.setDataAsync = function (data, options, callback) {
/// Writes the specified data into the current selection.
///The data to be set. Either a string or value, 2d array or TableData object
///
/// Syntax example: {coercionType:Office.CoercionType.Matrix} or {coercionType: 'matrix'}
///
coercionType: Explicitly sets the shape of the data object. Use Office.CoercionType or text value. If not supplied is inferred from the data type.
///
startRow: Used in partial set for table/matrix. Indicates the start row.
///
startColumn: Used in partial set for table/matrix. Indicates the start column.
///
asyncContext: Object keeping state for the callback
///
///The optional callback method
Office._extractedCallback(arguments, 3, 2)(new Office._AsyncResult("setDataAsync"));
};
this.getDataAsync = function (options, callback) {
/// Returns the current selection.
///
/// Syntax example: {coercionType: 'matrix,'valueFormat: 'formatted', filterType:'all'}
///
coercionType: The expected shape of the selection. If not specified returns the bindingType shape. Use Office.CoercionType or text value.
///
valueFormat: Get data with or without format. Use Office.ValueFormat or text value.
///
startRow: Used in partial get for table/matrix. Indicates the start row.
///
startColumn: Used in partial get for table/matrix. Indicates the start column.
///
rowCount: Used in partial get for table/matrix. Indicates the number of rows from the start row.
///
columnCount: Used in partial get for table/matrix. Indicates the number of columns from the start column.
///
filterType: Get the visible or all the data. Useful when filtering data. Use Office.FilterType or text value.
///
asyncContext: Object keeping state for the callback
///
///The optional callback method
if (arguments.length == 1) {
callback = options;
}
var result = new Office._AsyncResult("getDataAsync", options.coercionType);
callback(result);
};
this.addHandlerAsync = function (eventType, handler, callback) {
/// Adds an event handler to the object using the specified event type.
///The event type. For binding it can be 'bindingDataChanged' and 'bindingSelectionChanged'
///The name of the handler
///The optional callback method
var events = new Office._BindingDataChangedEvents(eventType);
handler(events);
var result = new Office._AsyncResult("addHandlerAsync");
callback(result);
};
this.removeHandlerAsync = function (eventType, options, callback) {
/// Removes an event handler from the object using the specified event type.
///The event type. For binding can be 'bindingDataChanged' and 'bindingSelectionChanged'
///
/// Syntax example: {handler:eventHandler}
///
handler: Indicates a specific handler to be removed, if not specified all handlers are removed
///
asyncContext: Object keeping state for the callback
///
///The optional callback method
var events = new Office._BindingDataChangedEvents(eventType);
handler(events);
Office._extractedCallback(arguments, 3, 2)(new Office._AsyncResult("removeHandlerAsync"));
};
if ((bindingType == undefined) || (bindingType == Office.BindingType.Matrix) || (bindingType == Office.BindingType.Table)) {
this.columnCount = {};
this.rowCount = {};
}
if ((bindingType == undefined) || (bindingType == Office.BindingType.Table)) {
Office._processContents(this, {
hasHeaders: {
value: {}
},
addRowsAsync: {
value: function (data, callback) {
/// Adds the specified rows to the table
/// A 2D array with the rows to add
///The optional callback method
}
},
addColumnsAsync: {
value: function (tableData, callback) {
/// Adds the specified columns to the table
/// A TableData object with the headers and rows
///The optional callback method};
}
},
deleteAllDataValuesAsync: {
value: function (callback) {
/// Clears the table
///The optional callback method};
}
},
formattingSpecific: {
metaOnly: true,
conditions: {
hosts: ["excel"],
},
contents: {
clearFormatsAsync: {
conditions: {
reqs: ["method TableBinding.clearFormatsAsync"]
},
value: function (options, callback) {
/// Clears formatting on the bound table.
///
/// Syntax example: {asyncContext:context}
///
asyncContext: Object keeping state for the callback
///
///The optional callback method
Office._extractedCallback(arguments, 2, 2)(new Office._AsyncResult("clearFormatsAsync"));
}
},
getFormatsAsync: {
conditions: {
reqs: ["method TableBinding.getFormatsAsync"]
},
value: function (cellReference, formats, options, callback) {
/// Gets the formatting on specified items in the table.
///An object literal containing name-value pairs that specify the range of cells to get formatting from.
///An array specifying the format properties to get.
///
/// Syntax example: {asyncContext:context}
///
asyncContext: Object keeping state for the callback
///
///The optional callback method
Office._extractedCallback(arguments, 4, 4)(new Office._AsyncResult("getFormatsAsync"));
}
},
setFormatsAsync: {
conditions: {
reqs: ["method TableBinding.setFormatsAsync"]
},
value: function (formatsInfo, options, callback) {
/// Sets formatting on specified items and data in the table.
///
/// Array elements are themselves three-element arrays:
/// [target, type, formats]
///
target: The identifier of the item to format. String.
///
type: The kind of item to format. String.
///
formats: An object literal containing a list of property name-value pairs that define the formatting to apply.
///
///
/// Syntax example: {asyncContext:context}
///
asyncContext: Object keeping state for the callback
///
///The optional callback method
Office._extractedCallback(arguments, 3, 3)(new Office._AsyncResult("setFormatsAsync"));
}
},
setTableOptionsAsync: {
conditions: {
reqs: ["method TableBinding.setTableOptionsAsync"]
},
value: function (tableOptions, options, callback) {
/// Updates table formatting options on the bound table.
///An object literal containing a list of property name-value pairs that define the table options to apply.
///
/// Syntax example: {asyncContext:context}
///
asyncContext: Object keeping state for the callback
///
///The optional callback method
Office._extractedCallback(arguments, 3, 2)(new Office._AsyncResult("setTableOptionsAsync"));
}
}
}
}
});
}
}
Office._TableData = function () {
this.headers = new Array(new Array());
this.rows = new Array(new Array());
}
Office._File = function () {
this.size = {};
this.sliceCount = {};
this.getSliceAsync = function (sliceIndex, callback) {
/// Gets the specified slice.
///The index of the slice to be retrieved
///The optional callback method
var result = new Office._AsyncResult("getSliceAsync");
callback(result);
};
this.closeAsync = function (callback) {
/// Closes the File.
///The optional callback method
};
}
Office._Slice = function () {
this.data = {};
this.index = {};
this.size = {};
}
Office._Dialog = function () {
this.data = {};
this.close = function () {
/// Allows the add-in to close its dialog box.
};
this.addEventHandler = function (eventType, handler) {
/// Registers an event handler.
/// The two supported events are: DialogMessageReceived or DialogEventReceived
/// The name of the handler
handler(new Office._DialogEventArgs(eventType));
};
}
Office._AsyncResult = function (method, bindingType) {
this.asyncContext = {};
this.error = new Office._Error();
this.status = {};
if ((method == "addfromSelectionAsync") || (method == "addFromNamedItemAsync") || (method == "getByIdAsync") || (method == "addFromPromptAsync")) {
this.value = new Office._Binding(bindingType);
} else if ((method == "getDataAsync") || (method == "getSelectedDataAsync")) {
if (bindingType == "table")
this.value = new Office._TableData();
else if (bindingType == "matrix")
this.value = new Array(new Array);
else
this.value = {};
} else if (method == "getAllAsync") {
this.value = new Array(new Office._Binding(bindingType));
} else if (method == "getByNamespaceAsync") {
this.value = new Array(new Office._CustomXmlPart());
} else if (method == "getNodesAsync") {
this.value = new Array(new Office._CustomXmlNode());
} else if ((method == "XMLgetByIdAsync") || (method == "addAsync")) {
this.value = new Office._CustomXmlPart();
} else if (method == "refreshAsync") {
this.value = new Office._context_document_settings();
} else if (method == "getFileAsync") {
this.value = new Office._File();
} else if (method == "getSliceAsync") {
this.value = new Office._Slice();
} else if (method == "getActiveViewAsync") {
Office._processItem(this,
{
annotate: {
///The presentation's current view.
value: undefined
}
},
"value"
);
} else if (method == "getFilePropertiesAsync") {
this.value = new Office._FileProperties();
} else if (method == "displayDialogAsync") {
this.value = new Office._Dialog();
}else {
this.value = {};
}
}
Office._FileProperties = function () {
///File's URL
this.url = "";
}
Office._context_document_settings = function () {
this.get = function (settingName) {
///Retrieves the setting with the specified name.
///The name of the setting
};
this.remove = function (settingName) {
///Removes the setting with the specified name.
///The name of the setting
///
};
this.saveAsync = function (options, callback) {
///Saves all settings.
///
/// Syntax example: {overwriteIfStale:false}
///
overwriteIfStale: Indicates whether the setting will be replaced if stale.
///
asyncContext: Object keeping state for the callback
///
///The optional callback method
///
Office._extractedCallback(arguments, 2, 2)(new Office._AsyncResult("saveAsync", coercionType));
};
this.set = function (settingName, value) {
///Sets a value for the setting with the specified name.
///The name of the setting
///The value for the setting
};
};
Office._context_document_bindings = function () {
this.document = {};
if (Office._AccessWebAppMask & Office._appContext) {
this.addFromSelectionAsync = function (bindingType, options, callback) {
///Create a binding based on what the user's current selection.
///The Office BindingType for the data
///
/// addFromSelectionAsyncOptions- e.g. {id: "BindingID"}
///
id: Identifier.
///
asyncContext: Object keeping state for the callback
///
columns: The string[] of the columns involved in the binding
///
sampleData: A TableData that gives sample table in the Dialog.TableData.Headers is [][] of string.
///
///The optional callback method
if (arguments.length == 2) { callback = options; };
var result = new Office._AsyncResult("addfromSelectionAsync", bindingType);
callback(result);
}
} else {
this.addFromSelectionAsync = function (bindingType, options, callback) {
///Create a binding based on what the user's current selection.
///The Office BindingType for the data
///
/// addFromSelectionAsyncOptions- e.g. {id: "BindingID"}
///
id: Identifier.
///
asyncContext: Object keeping state for the callback
///
///The optional callback method
if (arguments.length == 2) { callback = options; };
var result = new Office._AsyncResult("addfromSelectionAsync", bindingType);
callback(result);
}
}
if (Office._AccessWebAppMask & Office._appContext) {
this.addFromNamedItemAsync = function (itemName, bindingType, options, callback) {
///Creates a binding against a named object in the document
///Name of the bindable object in the document. For Example 'MyExpenses' table in Excel."
///The Office BindingType for the data
///
/// Syntax example: {id: "BindingID"}
///
id: Name of the binding, autogenerated if not supplied.
///
asyncContext: Object keeping state for the callback
///
columns: The string[] of the columns involved in the binding
///
///The optional callback method
if (arguments.length == 3) { callback = options; };
var result = new Office._AsyncResult("addFromNamedItemAsync", bindingType);
callback(result);
}
} else {
this.addFromNamedItemAsync = function (itemName, bindingType, options, callback) {
///Creates a binding against a named object in the document
///Name of the bindable object in the document. For Example 'MyExpenses' table in Excel."
///The Office BindingType for the data
///
/// Syntax example: {id: "BindingID"}
///
id: Name of the binding, autogenerated if not supplied.
///
asyncContext: Object keeping state for the callback
///
///The optional callback method
if (arguments.length == 3) { callback = options; };
var result = new Office._AsyncResult("addFromNamedItemAsync", bindingType);
callback(result);
}
}
this.getByIdAsync = function (id, callback) {
///Retrieves a binding based on its Name
///The binding id
///The optional callback method
var result = new Office._AsyncResult("getByIdAsync")
callback(result);
}
this.getAllAsync = function (callback) {
///Gets an array with all the binding objects in the document.
///The optional callback method
var result = new Office._AsyncResult("getAllAsync")
callback(result);
};
this.releaseByIdAsync = function (id, callback) {
///Removes the binding from the document
///The binding id
///The optional callback method
var result = new Office._AsyncResult("releaseByIdAsync")
callback(result);
};
if (Office._AccessWebAppMask & Office._appContext) {
this.addFromPromptAsync = function (bindingType, options, callback) {
///(Access only with sample data) Create a binding by prompting the user to make a selection on the document.
///The Office BindingType for the data
///
/// addFromPromptAsyncOptions- e.g. {promptText: "Please select data", id: "mySales"}
///
promptText: Greet your users with a friendly word.
///
asyncContext: Object keeping state for the callback
///
id: Identifier.
///
sampleData: A TableData that gives sample table in the Dialog.TableData.Headers is [][] of string.
///
///The optional callback method
if (arguments.length == 2) { callback = options; };
var result = new Office._AsyncResult("addFromPromptAsync", bindingType)
callback(result);
}
} else if (Office._ExcelMask & Office._appContext) {
this.addFromPromptAsync = function (bindingType, options, callback) {
///(Excel only) Create a binding by prompting the user to make a selection on the document.
///The Office BindingType for the data
///
/// addFromPromptAsyncOptions- e.g. {promptText: "Please select data", id: "mySales"}
///
promptText: Greet your users with a friendly word.
///
asyncContext: Object keeping state for the callback
///
id: Identifier.
///
///The optional callback method
if (arguments.length == 2) { callback = options; };
var result = new Office._AsyncResult("addFromPromptAsync", bindingType)
callback(result);
}
}
};
Office._context_ui = {
displayDialogAsync: {
value: function (startAddress, options, callback) {
/// Displays a dialog box in an Office host.
/// Accepts the initial HTTPS(TLS) URL that opens in the dialog box.
///
/// Syntax example: {width:80}
///
width: Defines the width of the dialog box as a percentage of the current display.
///
height: Defines the height of the dialog box as a percentage of the current display.
///
displayInIFrame: false (defult): The dialog will be displayed as a new browser window
///
true: The dialog will be displayed as a floating overlay with an IFrame.
///
///The optional callback method
///
if (arguments.length == 2) { callback = options; };
var result = new Office._AsyncResult("displayDialogAsync");
callback(result);
}
},
closeContainer: {
value: function () {
///
/// Closes the UI container where the JavaScript is executing.
///
///
/// Supported hosts:
///
/// * Outlook. Minimum requirement set: Mailbox 1.5
///
///
/// The behavior of this method is specified as follows. When called from:
///
/// * A UI-less command button: No effect. Any dialogs opened by displayDialogAsync will remain open.
///
/// * A taskpane: The taskpane will close. Any dialogs opened by displayDialogAsync will also close. If the taskpane supports pinning and was pinned by the user, it will be un-pinned.
///
/// * A module extension: No effect.
///
}
},
messageParent: {
value: function (messageObject) {
/// Delivers a message from the dialog box to its parent/opener page. The page calling this API must be on the same domain as the parent.
/// Accepts a message from the dialog box to deliver to the add-in.
}
}
}
Office._context_document = {
mode: {
annotate: {
//Gets the document mode
mode: undefined
}
},
url: {
annotate: {
//Gets the document URL
url: undefined
}
},
addHandlerAsync: {
value: function (eventType, handler, callback) {
/// Adds an event handler for the specified event type.
///The event type. For document can be 'DocumentSelectionChanged'
///The name of the handler
///The optional callback method
var result = new Office._AsyncResult("addHandlerAsync");
callback(result);
handler(new Office._DocumentEventArgs(eventType));
}
},
removeHandlerAsync: {
value: function (eventType, handler, callback) {
/// Removes an event handler for the specified event type.
///The event type. For document can be 'DocumentSelectionChanged'
///The name of the handler. If not specified all handlers are removed
///The optional callback method
///
var result = new Office._AsyncResult("removeHandlerAsync", coercionType);
callback(result);
}
},
settings: {
conditions: {
hosts: ["word", "excel", "ppt", "accesswebapp"],
reqs: [
"set Settings GE 1.1",
"method Settings.get",
"method Settings.remove",
"method Settings.saveAsync",
"method Settings.set"
]
},
value: new Office._context_document_settings()
},
refreshableSettings: {
name: "settings",
conditions: {
hosts: ["excel", "ppt", "accesswebapp"],
reqs: []
},
partialConditions: true,
contents: {
addHandlerAsync: {
conditions: { reqs: ["method Settings.addHandlerAsync"] },
value: function (eventType, handler, callback) {
/// Adds an event handler for the object using the specified event type.
///The event type. For settings can be 'settingsChanged'
///The name of the handler
///The optional callback method
var result = new Office._AsyncResult("addHandlerAsync", coercionType);
callback(result);
}
},
refreshAsync: {
conditions: { reqs: ["method Settings.refreshAsync"] },
value: function (callback) {
///Gets the latest version of the settings object.
///The optional callback method
var result = new Office._AsyncResult("refreshAsync", coercionType);
callback(result);
}
},
removeHandlerAsync: {
conditions: { reqs: ["method Settings.removeHandlerAsync"] },
value: function (eventType, handler, callback) {
/// Removes an event handler for the specified event type.
///The event type. For settings can be 'settingsChanged'
///
/// Syntax example: {handler:eventHandler}
///
handler: Indicates a specific handler to be removed, if not specified all handlers are removed
///
asyncContext: Object keeping state for the callback
///
///The optional callback method
var result = new Office._AsyncResult("removeHandlerAsync", coercionType);
callback(result);
}
}
}
},
setSelectedDataAsync: {
conditions: {
hosts: ["word", "excel", "ppt"],
reqs: ["set Selection GE 1.1", "method Document.setSelectedDataAsync"]
},
value: function (data, options, callback) {
/// Writes the specified data into the current selection.
///The data to be set. Either a string or value, 2d array or TableData object
///
/// Syntax example: {coercionType:Office.CoercionType.Matrix} or {coercionType: 'matrix'}
///
coercionType: Explicitly sets the shape of the data object. Use Office.CoercionType or text value. If not supplied is inferred from the data type.
///
imageLeft: Used for image. Sets the left position of the image.
///
imageTop: Used for image. Sets the top position of the image.
///
imageWidth: Used for image. Sets the width of the image.
///
imageHeight: Used for image. Sets the height of the image.
///
asyncContext: Object keeping state for the callback
///
///The optional callback method
///
if (arguments.length == 2) { callback = options; };
var result = new Office._AsyncResult("setSelectedDataAsync");
callback(result);
}
},
bindings: {
conditions: {
hosts: ["word", "excel", "accesswebapp"],
reqs: [
"set TextBindings GE 1.1",
"set TableBindings GE 1.1",
"set MatrixBindings GE 1.1",
"method Bindings.addFromPromptAsync",
"method Bindings.addFromNamedItemAsync",
"method Bindings.addFromSelectionAsync",
"method Bindings.getAllAsync",
"method Bindings.getByIdAsync",
"method Bindings.releaseByIdAsync",
"method MatrixBinding.getDataAsync",
"method MatrixBinding.setDataAsync",
"method TableBinding.clearFormatsAsync",
"method TableBinding.setFormatsAsync",
"method TableBinding.setTableOptionsAsync",
"method TableBinding.addColumnsAsync",
"method TableBinding.addRowsAsync",
"method TableBinding.deleteAllDataValuesAsync",
"method TableBinding.getDataAsync",
"method TableBinding.setDataAsync",
"method TextBinding.getDataAsync",
"method TextBinding.setDataAsync"
]
},
value: new Office._context_document_bindings()
},
getFileAsync: {
conditions: {
hosts: ["word", "ppt","excel"],
reqs: ["set File GE 1.1", "method Document.getFileAsync", "method File.closeAsync", "method File.getSliceAsync"]
},
value: function (fileType, options, callback) {
///(Word and PowerPoint only) Gets the entire file in slices of up to 4MB.
///The format in which the file will be returned
///
/// Syntax example: {sliceSize:1024}
///
sliceSize: Specifies the desired slice size (in bytes) up to 4MB. If not specified a default slice size of 4MB will be used.
///
///The optional callback method
if (arguments.length == 2) { callback = options; };
var result = new Office._AsyncResult("getFileAsync");
callback(result);
}
},
getSelectedDataAsync: {
conditions: {
hosts: ["excel", "word", "project", "ppt"],
reqs: ["set Selection GE 1.1", "method Document.getSelectedDataAsync"]
},
value: function (coercionType, options, callback) {
/// Returns the current selection.
///The expected shape of the selection.
///
/// Syntax example: {valueFormat: 'formatted', filterType:'all'}
///
valueFormat: Get data with or without format. Use Office.ValueFormat or text value.
///
filterType: Get the visible or all the data. Useful when filtering data. Use Office.FilterType or text value.
///
asyncContext: Object keeping state for the callback
///
///The optional callback method
///
if (arguments.length == 2) { callback = options; };
var result = new Office._AsyncResult("getSelectedDataAsync", coercionType);
callback(result);
}
},
customXmlParts: {
conditions: {
hosts: ["word"],
reqs: [
"set CustomXmlParts GE 1.1",
"method CustomXmlNode.getNodesAsync",
"method CustomXmlNode.getNodeValueAsync",
"method CustomXmlNode.getXmlAsync",
"method CustomXmlNode.setNodeValueAsync",
"method CustomXmlNode.setXmlAsync",
"method CustomXmlPart.addHandlerAsync",
"method CustomXmlPart.deleteAsync",
"method CustomXmlPart.getNodesAsync",
"method CustomXmlPart.getXmlAsync",
"method CustomXmlPart.removeHandlerAsync",
"method CustomXmlPrefixMappings.addNamespaceAsync",
"method CustomXmlPrefixMappings.getNamespaceAsync",
"method CustomXmlPrefixMappings.getPrefixAsync"
]
},
partialConditions: true,
contents: {
addAsync: {
conditions: {
reqs: ["method CustomXmlParts.addAsync"]
},
value: function (xml, callback) {
///(Word Only) Asynchronously adds a new custom XML part to a file.
///The XML to add to the newly created custom XML part.
///A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
var result = new Office._AsyncResult("addAsync");
callback(result);
}
},
getByIdAsync: {
conditions: {
reqs: ["method CustomXmlParts.getByIdAsync"]
},
value: function (id, callback) {
///(Word Only) Asynchronously gets the specified custom XML part by its id.
///The id of the custom XML part.
///A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
var result = new Office._AsyncResult("XMLgetByIdAsync");
callback(result);
}
},
getByNamespaceAsync: {
conditions: {
reqs: ["method CustomXmlParts.getByNamespaceAsync"]
},
value: function (ns, callback) {
///(Word Only) Asynchronously gets the specified custom XML part(s) by its namespace.
/// The namespace to search.
///A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
var result = new Office._AsyncResult("getByNamespaceAsync");
callback(result);
}
}
}
},
getActiveViewAsync: {
conditions: {
hosts: ["ppt"],
reqs: ["set ActiveView GE 1.1", "method Document.getActiveViewAsync"]
},
value: function(options, callback) {
///(PowerPoint only) Returns the current view of the presentation.
///
/// Syntax example: {asyncContext:context}
///
asyncContext: Object keeping state for the callback
///
///The optional callback method
Office._extractedCallback(arguments, 2, 2)(new Office._AsyncResult("getActiveViewAsync"));
}
},
getFilePropertiesAsync: {
conditions: {
hosts: ["word", "ppt", "excel"],
reqs: ["method Document.getFilePropertiesAsync"]
},
value: function(options, callback) {
///Gets file properties of the current document.
///
/// Syntax example: {asyncContext:context}
///
asyncContext: Object keeping state for the callback
///
///The optional callback method
Office._extractedCallback(arguments, 2, 2)(new Office._AsyncResult("getFilePropertiesAsync"));
}
},
goToByIdAsync: {
conditions: {
hosts: ["excel", "ppt", "word"],
reqs: ["method Document.goToByIdAsync"]
},
value: function(id, goToType, options, callback) {
///Goes to the specified object or location in the document.
///The identifier of the object or location to go to.
///The type of the location to go to.
///
/// Syntax example: {asyncContext:context}
///
selectionMode: (Word only) Use Office.SelectionMode or text value.
///
asyncContext: Object keeping state for the callback
///
///The optional callback method
Office._extractedCallback(arguments, 4, 2)(new Office._AsyncResult("goToByIdAsync"));
}
}
}
}
Office._items = {
context: {
contents: {
host: "",
platform: "",
diagnostics: {},
contentLanguage: {},
displayLanguage: {},
license: {
contents: {
value: {
annotate: {
//License summary.
value: undefined
}
}
}
},
document: {
conditions: {
hosts: ["not outlook; not outlookcompose"]
},
annotate: {
// Office Document
document: undefined
},
contents: Office._context_document
},
officeTheme: {
conditions: {
hosts: ["excel", "outlook", "powerpoint", "project", "word"]
},
annotate: {
officeTheme: undefined
},
contents: {
"bodyBackgroundColor": {},
"bodyForegroundColor": {},
"controlBackgroundColor": {},
"controlForegroundColor": {}
}
},
touchEnabled: {},
commerceAllowed : {},
requirements: {
annotate: {
// Checks whether a given requirement set is supported by the current host.
requirements: undefined
},
contents: {
isSetSupported: {
value: function (name, minVersion) {
/// Check if the specified requirement set is supported by the host Office application
/// Set name. e.g.: "MatrixBindings"
/// The minimum required version
}
},
}
},
ui: {
annotate: {
// Office UI
ui: undefined
},
contents: Office._context_ui
}
}
},
initialize: {
value: function (reason) {
/// This method is called after the Office API was loaded.
/// Indicates how the app was initialized
}
},
useShortNamespace: {
value: function (useShortNamespace) {
/// Indicates if the large namespace for objects will be used or not.
/// Indicates if 'true' that the short namespace will be used
}
},
select: {
conditions: {
hosts: ["not outlook; not outlookcompose"]
},
value: function (expression, callback) {
/// Returns a promise of an object described in the expression. Callback is invoked only if method fails.
///The object to be retrieved. Example "bindings#BindingName", retrieves a binding promise for a binding named 'BindingName'
///The optional callback method
///
var result = new Office._AsyncResult("select");
callback(result);
return (new Office._Binding());
}
},
TableData: {
conditions: {
hosts: ["word", "excel", "accesswebapp"],
reqs: ["set TableBindings GE 1.1"]
},
value: new Office._TableData()
}
};
/*Infrastructure***************************************************************/
Office._processItem = function (target, item, key, suppressConditionCheck) {
var conditionsFulfilled = suppressConditionCheck || Office._filterManager._checkCondition(item.conditions);
if (!(conditionsFulfilled || item.partialConditions)) {
return false;
}
suppressConditionCheck = suppressConditionCheck || conditionsFulfilled && item.partialConditions;
if (item.setup) {
item.setup();
}
if (item.metaOnly) {
return Office._processContents(target, item.contents, suppressConditionCheck);
}
key = item.name || key;
var areItemsAdded = false;
if (item.hasOwnProperty("value")) {
target[key] = item.value;
areItemsAdded = true;
} else if (typeof item.contents == "function") {
target[key] = item.contents();
areItemsAdded = true;
} else {
target[key] = target[key] || {};
if (Office._processContents(target[key], item.contents, suppressConditionCheck) || conditionsFulfilled) {
areItemsAdded = true;
} else {
delete target[key];
}
}
if (item.annotate) {
intellisense.annotate(target, item.annotate);
areItemsAdded = true;
}
return areItemsAdded;
}
Office._processContents = function (target, contents, suppressConditionCheck) {
if (typeof contents !== "object") {
return false;
}
var areItemsAdded = false;
for (var item in contents) {
areItemsAdded = Office._processItem(target, contents[item], item, suppressConditionCheck) || areItemsAdded;
}
return areItemsAdded;
}
Office._filterManager = (function () {
var filters = [];
return {
_checkCondition: function (condition) {
if (!condition)
return true;
var answer = true;
for (var i = 0; i < filters.length; i++) {
var filter = filters[i];
var conditionForThisFilter = condition[filter.identifier];
if (conditionForThisFilter && filter.isEnabled()) {
var thisFiltersAnswer = false;
for (var j = 0; j < conditionForThisFilter.length; j++) {
var productTerm = conditionForThisFilter[j].split(';');
var thisTermsAnswer = true;
for (var k = 0; k < productTerm.length; k++) {
var singleCondition = productTerm[k].toUpperCase().trim();
var invert = false;
if (singleCondition.indexOf("NOT") != -1) {
invert = true;
singleCondition = singleCondition.slice(singleCondition.indexOf(" ")).trim();
}
var result = filter.isConditionTrue(singleCondition, invert);
thisTermsAnswer = thisTermsAnswer && result;
}
thisFiltersAnswer = thisFiltersAnswer || thisTermsAnswer;
}
answer = answer && thisFiltersAnswer;
}
if (!answer)
break;
}
return answer;
},
_pushFilter: function (identifier, filteringDelegate, isEnabledDelegate) {
filters.push({
identifier: identifier,
isConditionTrue: filteringDelegate,
isEnabled: isEnabledDelegate
});
}
}
})();
Office._filterManager._pushFilter(
"hosts",
(function () {
var nameToMaskMapping = {
EXCEL: Office._ExcelMask,
WORD: Office._WordMask,
PROJECT: Office._ProjectMask,
OUTLOOK: Office._OutlookMask,
PPT: Office._PowerPointMask,
OUTLOOKCOMPOSE: Office._OutlookComposeMask,
ACCESSWEBAPP: Office._AccessWebAppMask
}
return function (condition, invert) {
var result = false;
if (nameToMaskMapping[condition] & Office._appContext) {
result = true;
}
return invert ? !result : result;
}
})(),
function () {
return typeof Office._appContext === "number";
}
);
Office._filterManager._pushFilter(
"reqs",
(function () {
function checkForMethod(methodName) {
return Office._methodContext && Office._methodContext[methodName];
}
function checkForSet(setDescriptor) {
setDescriptor = setDescriptor.split(" ");
var setName = setDescriptor[0].trim(),
setEntry = Office._setContext && setName in Office._setContext && (Office._setContext[setName] || "1.1");
if (!setEntry) {
return false;
}
if (setDescriptor.length === 1) {
return true;
} else {
var comparisonOperator = setDescriptor[1].trim(),
setVersion = setDescriptor[2].split("."),
setEntryVersion = setEntry.split("."),
difference = 0,
maxComponentCount = Math.max(setEntryVersion.length, setVersion.length);
for (var i = 0; i < maxComponentCount; i++) {
var leftInt = parseInt(setEntryVersion[i], 10) || 0,
rightInt = parseInt(setVersion[i], 10) || 0;
if (leftInt === rightInt) {
continue;
}
difference = leftInt - rightInt;
break;
}
switch (comparisonOperator) {
case "EQ":
return difference === 0;
case "GT":
return difference > 0;
case "LT":
return difference < 0;
case "GE":
return difference >= 0;
case "LE":
return difference <= 0;
default:
return false;
}
}
return false;
}
return function (condition, invert) {
var result = true;
var typeAgnosticCond = condition.slice(condition.indexOf(" ")).trim();
if (condition.indexOf("SET") === 0) {
result = checkForSet(typeAgnosticCond);
} else if (condition.indexOf("METHOD") === 0) {
result = checkForMethod(typeAgnosticCond);
}
return invert ? !result : result;
}
})(),
function () {
if (Office._showAll === false) {
return true;
}
return false;
}
)
Office._addEnumOnObject = function (enumName, enumObj, targetObj, conditions) {
Office._processItem(
targetObj,
{
conditions: conditions,
value: enumObj
},
enumName
);
}
/******************************************************************************/
// Setup Project
Office._processItem(Office, {
metaOnly: true,
conditions: {
hosts: ["project"]
},
contents: {
ProjectProjectFields: {
value: {
///CurrencySymbol
CurrencySymbol: 1,
///CurrencySymbolPosition
CurrencySymbolPosition: 2,
///DurationUnits
DurationUnits: 3,
///GUID
GUID: 4,
///Finish
Finish: 5,
///Start
Start: 6,
///ReadOnly
ReadOnly: 7,
///VERSION
VERSION: 8,
///WorkUnits
WorkUnits: 9,
///ProjectServerUrl
ProjectServerUrl: 10,
///WSSUrl
WSSUrl: 11,
///WSSList
WSSList: 12
}
},
ProjectViewTypes: {
value: {
///Gantt
Gantt: 1,
///NetworkDiagram
NetworkDiagram: 2,
///TaskDiagram
TaskDiagram: 3,
///TaskForm
TaskForm: 4,
///TaskSheet
TaskSheet: 5,
///ResourceForm
ResourceForm: 6,
///ResourceSheet
ResourceSheet: 7,
///ResourceGraph
ResourceGraph: 8,
///TeamPlanner
TeamPlanner: 9,
///TaskDetails
TaskDetails: 10,
///TaskNameForm
TaskNameForm: 11,
///ResourceNames
ResourceNames: 12,
///Calendar
Calendar: 13,
///TaskUsage
TaskUsage: 14,
///ResourceUsage
ResourceUsage: 15,
///Timeline
Timeline: 16,
///Drawing
Drawing: 18,
///Resource Plan
ResourcePlan: 19
}
},
ProjectTaskFields: {
value: {
///ActualCost
ActualCost: 0,
///ActualDuration
ActualDuration: 1,
///ActualFinish
ActualFinish: 2,
///ActualOvertimeCost
ActualOvertimeCost: 3,
///ActualOvertimeWork
ActualOvertimeWork: 4,
///ActualStart
ActualStart: 5,
///ActualWork
ActualWork: 6,
///Text1
Text1: 7,
///Text10
Text10: 8,
///Finish10
Finish10: 9,
///Start10
Start10: 10,
///Text11
Text11: 11,
///Text12
Text12: 12,
///Text13
Text13: 13,
///Text14
Text14: 14,
///Text15
Text15: 15,
///Text16
Text16: 16,
///Text17
Text17: 17,
///Text18
Text18: 18,
///Text19
Text19: 19,
///Finish1
Finish1: 20,
///Start1
Start1: 21,
///Text2
Text2: 22,
///Text20
Text20: 23,
///Text21
Text21: 24,
///Text22
Text22: 25,
///Text23
Text23: 26,
///Text24
Text24: 27,
///Text25
Text25: 28,
///Text26
Text26: 29,
///Text27
Text27: 30,
///Text28
Text28: 31,
///Text29
Text29: 32,
///Finish2
Finish2: 33,
///Start2
Start2: 34,
///Text3
Text3: 35,
///Text30
Text30: 36,
///Finish3
Finish3: 37,
///Start3
Start3: 38,
///Text4
Text4: 39,
///Finish4
Finish4: 40,
///Start4
Start4: 41,
///Text5
Text5: 42,
///Finish5
Finish5: 43,
///Start5
Start5: 44,
///Text6
Text6: 45,
///Finish6
Finish6: 46,
///Start6
Start6: 47,
///Text7
Text7: 48,
///Finish7
Finish7: 49,
///Start7
Start7: 50,
///Text8
Text8: 51,
///Finish8
Finish8: 52,
///Start8
Start8: 53,
///Text9
Text9: 54,
///Finish9
Finish9: 55,
///Start9
Start9: 56,
///Baseline10BudgetCost
Baseline10BudgetCost: 57,
///Baseline10BudgetWork
Baseline10BudgetWork: 58,
///Baseline10Cost
Baseline10Cost: 59,
///Baseline10Duration
Baseline10Duration: 60,
///Baseline10Finish
Baseline10Finish: 61,
///Baseline10FixedCost
Baseline10FixedCost: 62,
///Baseline10FixedCostAccrual
Baseline10FixedCostAccrual: 63,
///Baseline10Start
Baseline10Start: 64,
///Baseline10Work
Baseline10Work: 65,
///Baseline1BudgetCost
Baseline1BudgetCost: 66,
///Baseline1BudgetWork
Baseline1BudgetWork: 67,
///Baseline1Cost
Baseline1Cost: 68,
///Baseline1Duration
Baseline1Duration: 69,
///Baseline1Finish
Baseline1Finish: 70,
///Baseline1FixedCost
Baseline1FixedCost: 71,
///Baseline1FixedCostAccrual
Baseline1FixedCostAccrual: 72,
///Baseline1Start
Baseline1Start: 73,
///Baseline1Work
Baseline1Work: 74,
///Baseline2BudgetCost
Baseline2BudgetCost: 75,
///Baseline2BudgetWork
Baseline2BudgetWork: 76,
///Baseline2Cost
Baseline2Cost: 77,
///Baseline2Duration
Baseline2Duration: 78,
///Baseline2Finish
Baseline2Finish: 79,
///Baseline2FixedCost
Baseline2FixedCost: 80,
///Baseline2FixedCostAccrual
Baseline2FixedCostAccrual: 81,
///Baseline2Start
Baseline2Start: 82,
///Baseline2Work
Baseline2Work: 83,
///Baseline3BudgetCost
Baseline3BudgetCost: 84,
///Baseline3BudgetWork
Baseline3BudgetWork: 85,
///Baseline3Cost
Baseline3Cost: 86,
///Baseline3Duration
Baseline3Duration: 87,
///Baseline3Finish
Baseline3Finish: 88,
///Baseline3FixedCost
Baseline3FixedCost: 89,
///Baseline3FixedCostAccrual
Baseline3FixedCostAccrual: 90,
///Basline3Start
Basline3Start: 91,
///Baseline3Work
Baseline3Work: 92,
///Baseline4BudgetCost
Baseline4BudgetCost: 93,
///Baseline4BudgetWork
Baseline4BudgetWork: 94,
///Baseline4Cost
Baseline4Cost: 95,
///Baseline4Duration
Baseline4Duration: 96,
///Baseline4Finish
Baseline4Finish: 97,
///Baseline4FixedCost
Baseline4FixedCost: 98,
///Baseline4FixedCostAccrual
Baseline4FixedCostAccrual: 99,
///Baseline4Start
Baseline4Start: 100,
///Baseline4Work
Baseline4Work: 101,
///Baseline5BudgetCost
Baseline5BudgetCost: 102,
///Baseline5BudgetWork
Baseline5BudgetWork: 103,
///Baseline5Cost
Baseline5Cost: 104,
///Baseline5Duration
Baseline5Duration: 105,
///Baseline5Finish
Baseline5Finish: 106,
///Baseline5FixedCost
Baseline5FixedCost: 107,
///Baseline5FixedCostAccrual
Baseline5FixedCostAccrual: 108,
///Baseline5Start
Baseline5Start: 109,
///Baseline5Work
Baseline5Work: 110,
///Baseline6BudgetCost
Baseline6BudgetCost: 111,
///Baseline6BudgetWork
Baseline6BudgetWork: 112,
///Baseline6Cost
Baseline6Cost: 113,
///Baseline6Duration
Baseline6Duration: 114,
///Baseline6Finish
Baseline6Finish: 115,
///Baseline6FixedCost
Baseline6FixedCost: 116,
///Baseline6FixedCostAccrual
Baseline6FixedCostAccrual: 117,
///Baseline6Start
Baseline6Start: 118,
///Baseline6Work
Baseline6Work: 119,
///Baseline7BudgetCost
Baseline7BudgetCost: 120,
///Baseline7BudgetWork
Baseline7BudgetWork: 121,
///Baseline7Cost
Baseline7Cost: 122,
///Baseline7Duration
Baseline7Duration: 123,
///Baseline7Finish
Baseline7Finish: 124,
///Baseline7FixedCost
Baseline7FixedCost: 125,
///Baseline7FixedCostAccrual
Baseline7FixedCostAccrual: 126,
///Baseline7Start
Baseline7Start: 127,
///Baseline7Work
Baseline7Work: 128,
///Baseline8BudgetCost
Baseline8BudgetCost: 129,
///Baseline8BudgetWork
Baseline8BudgetWork: 130,
///Baseline8Cost
Baseline8Cost: 131,
///Baseline8Duration
Baseline8Duration: 132,
///Baseline8Finish
Baseline8Finish: 133,
///Baseline8FixedCost
Baseline8FixedCost: 134,
///Baseline8FixedCostAccrual
Baseline8FixedCostAccrual: 135,
///Baseline8Start
Baseline8Start: 136,
///Baseline8Work
Baseline8Work: 137,
///Baseline9BudgetCost
Baseline9BudgetCost: 138,
///Baseline9BudgetWork
Baseline9BudgetWork: 139,
///Baseline9Cost
Baseline9Cost: 140,
///Baseline9Duration
Baseline9Duration: 141,
///Baseline9Finish
Baseline9Finish: 142,
///Baseline9FixedCost
Baseline9FixedCost: 143,
///Baseline9FixedCostAccrual
Baseline9FixedCostAccrual: 144,
///Baseline9Start
Baseline9Start: 145,
///Baseline9Work
Baseline9Work: 146,
///BaselineBudgetCost
BaselineBudgetCost: 147,
///BaselineBudgetWork
BaselineBudgetWork: 148,
///BaselineCost
BaselineCost: 149,
///BaselineDuration
BaselineDuration: 150,
///BaselineFinish
BaselineFinish: 151,
///BaselineFixedCost
BaselineFixedCost: 152,
///BaselineFixedCostAccrual
BaselineFixedCostAccrual: 153,
///BaselineStart
BaselineStart: 154,
///BaselineWork
BaselineWork: 155,
///BudgetCost
BudgetCost: 156,
///BudgetFixedCost
BudgetFixedCost: 157,
///BudgetFixedWork
BudgetFixedWork: 158,
///BudgetWork
BudgetWork: 159,
///TaskCalendarGUID
TaskCalendarGUID: 160,
///ConstraintDate
ConstraintDate: 161,
///ConstraintType
ConstraintType: 162,
///Cost1
Cost1: 163,
///Cost10
Cost10: 164,
///Cost2
Cost2: 165,
///Cost3
Cost3: 166,
///Cost4
Cost4: 167,
///Cost5
Cost5: 168,
///Cost6
Cost6: 169,
///Cost7
Cost7: 170,
///Cost8
Cost8: 171,
///Cost9
Cost9: 172,
///Date1
Date1: 173,
///Date10
Date10: 174,
///Date2
Date2: 175,
///Date3
Date3: 176,
///Date4
Date4: 177,
///Date5
Date5: 178,
///Date6
Date6: 179,
///Date7
Date7: 180,
///Date8
Date8: 181,
///Date9
Date9: 182,
///Deadline
Deadline: 183,
///Duration1
Duration1: 184,
///Duration10
Duration10: 185,
///Duration2
Duration2: 186,
///Duration3
Duration3: 187,
///Duration4
Duration4: 188,
///Duration5
Duration5: 189,
///Duration6
Duration6: 190,
///Duration7
Duration7: 191,
///Duration8
Duration8: 192,
///Duration9
Duration9: 193,
///Duration
Duration: 194,
///EarnedValueMethod
EarnedValueMethod: 195,
///FinishSlack
FinishSlack: 196,
///FixedCost
FixedCost: 197,
///FixedCostAccrual
FixedCostAccrual: 198,
///Flag10
Flag10: 199,
///Flag1
Flag1: 200,
///Flag11
Flag11: 201,
///Flag12
Flag12: 202,
///Flag13
Flag13: 203,
///Flag14
Flag14: 204,
///Flag15
Flag15: 205,
///Flag16
Flag16: 206,
///Flag17
Flag17: 207,
///Flag18
Flag18: 208,
///Flag19
Flag19: 209,
///Flag2
Flag2: 210,
///Flag20
Flag20: 211,
///Flag3
Flag3: 212,
///Flag4
Flag4: 213,
///Flag5
Flag5: 214,
///Flag6
Flag6: 215,
///Flag7
Flag7: 216,
///Flag8
Flag8: 217,
///Flag9
Flag9: 218,
///FreeSlack
FreeSlack: 219,
///HasRollupSubTasks
HasRollupSubTasks: 220,
///ID
ID: 221,
///Name
Name: 222,
///Notes
Notes: 223,
///Number1
Number1: 224,
///Number10
Number10: 225,
///Number11
Number11: 226,
///Number12
Number12: 227,
///Number13
Number13: 228,
///Number14
Number14: 229,
///Number15
Number15: 230,
///Number16
Number16: 231,
///Number17
Number17: 232,
///Number18
Number18: 233,
///Number19
Number19: 234,
///Number2
Number2: 235,
///Number20
Number20: 236,
///Number3
Number3: 237,
///Number4
Number4: 238,
///Number5
Number5: 239,
///Number6
Number6: 240,
///Number7
Number7: 241,
///Number8
Number8: 242,
///Number9
Number9: 243,
///ScheduledDuration
ScheduledDuration: 244,
///ScheduledFinish
ScheduledFinish: 245,
///ScheduledStart
ScheduledStart: 246,
///OutlineLevel
OutlineLevel: 247,
///OvertimeCost
OvertimeCost: 248,
///OvertimeWork
OvertimeWork: 249,
///PercentComplete
PercentComplete: 250,
///PercentWorkComplete
PercentWorkComplete: 251,
///Predecessors
Predecessors: 252,
///PreleveledFinish
PreleveledFinish: 253,
///PreleveledStart
PreleveledStart: 254,
///Priority
Priority: 255,
///Active
Active: 256,
///Critical
Critical: 257,
///Milestone
Milestone: 258,
///Overallocated
Overallocated: 259,
///IsRollup
IsRollup: 260,
///Summary
Summary: 261,
///RegularWork
RegularWork: 262,
///RemainingCost
RemainingCost: 263,
///RemainingDuration
RemainingDuration: 264,
///RemainingOvertimeCost
RemainingOvertimeCost: 265,
///RemainingWork
RemainingWork: 266,
///ResourceNames
ResourceNames: 267,
///ResourceNames
ResourceNames: 268,
///Cost
Cost: 269,
///Finish
Finish: 270,
///Start
Start: 271,
///Work
Work: 272,
///StartSlack
StartSlack: 273,
///Status
Status: 274,
///Successors
Successors: 275,
///StatusManager
StatusManager: 276,
///TotalSlack
TotalSlack: 277,
///TaskGUID
TaskGUID: 278,
///Type
Type: 279,
///WBS
WBS: 280,
///WBSPREDECESSORS
WBSPREDECESSORS: 281,
///WBSSUCCESSORS
WBSSUCCESSORS: 282,
///WSSID
WSSID: 283
}
},
ProjectResourceFields: {
value: {
///Accrual
Accrual: 0,
///ActualCost
ActualCost: 1,
///ActualOvertimeCost
ActualOvertimeCost: 2,
///ActualOvertimeWork
ActualOvertimeWork: 3,
///ActualOvertimeWorkProtected
ActualOvertimeWorkProtected: 4,
///ActualWork
ActualWork: 5,
///ActualWorkProtected
ActualWorkProtected: 6,
///BaseCalendar
BaseCalendar: 7,
///Baseline10BudgetCost
Baseline10BudgetCost: 8,
///Baseline10BudgetWork
Baseline10BudgetWork: 9,
///Baseline10Cost
Baseline10Cost: 10,
///Baseline10Work
Baseline10Work: 11,
///Baseline1BudgetCost
Baseline1BudgetCost: 12,
///Baseline1BudgetWork
Baseline1BudgetWork: 13,
///Baseline1Cost
Baseline1Cost: 14,
///Baseline1Work
Baseline1Work: 15,
///Baseline2BudgetCost
Baseline2BudgetCost: 16,
///Baseline2BudgetWork
Baseline2BudgetWork: 17,
///Baseline2Cost
Baseline2Cost: 18,
///Baseline2Work
Baseline2Work: 19,
///Baseline3BudgetCost
Baseline3BudgetCost: 20,
///Baseline3BudgetWork
Baseline3BudgetWork: 21,
///Baseline3Cost
Baseline3Cost: 22,
///Baseline3Work
Baseline3Work: 23,
///Baseline4BudgetCost
Baseline4BudgetCost: 24,
///Baseline4BudgetWork
Baseline4BudgetWork: 25,
///Baseline4Cost
Baseline4Cost: 26,
///Baseline4Work
Baseline4Work: 27,
///Baseline5BudgetCost
Baseline5BudgetCost: 28,
///Baseline5BudgetWork
Baseline5BudgetWork: 29,
///Baseline5Cost
Baseline5Cost: 30,
///Baseline5Work
Baseline5Work: 31,
///Baseline6BudgetCost
Baseline6BudgetCost: 32,
///Baseline6BudgetWork
Baseline6BudgetWork: 33,
///Baseline6Cost
Baseline6Cost: 34,
///Baseline6Work
Baseline6Work: 35,
///Baseline7BudgetCost
Baseline7BudgetCost: 36,
///Baseline7BudgetWork
Baseline7BudgetWork: 37,
///Baseline7Cost
Baseline7Cost: 38,
///Baseline7Work
Baseline7Work: 39,
///Baseline8BudgetCost
Baseline8BudgetCost: 40,
///Baseline8BudgetWork
Baseline8BudgetWork: 41,
///Baseline8Cost
Baseline8Cost: 42,
///Baseline8Work
Baseline8Work: 43,
///Baseline9BudgetCost
Baseline9BudgetCost: 44,
///Baseline9BudgetWork
Baseline9BudgetWork: 45,
///Baseline9Cost
Baseline9Cost: 46,
///Baseline9Work
Baseline9Work: 47,
///BaselineBudgetCost
BaselineBudgetCost: 48,
///BaselineBudgetWork
BaselineBudgetWork: 49,
///BaselineCost
BaselineCost: 50,
///BaselineWork
BaselineWork: 51,
///BudgetCost
BudgetCost: 52,
///BudgetWork
BudgetWork: 53,
///ResourceCalendarGUID
ResourceCalendarGUID: 54,
///Code
Code: 55,
///Cost1
Cost1: 56,
///Cost10
Cost10: 57,
///Cost2
Cost2: 58,
///Cost3
Cost3: 59,
///Cost4
Cost4: 60,
///Cost5
Cost5: 61,
///Cost6
Cost6: 62,
///Cost7
Cost7: 63,
///Cost8
Cost8: 64,
///Cost9
Cost9: 65,
///ResourceCreationDate
ResourceCreationDate: 66,
///Date1
Date1: 67,
///Date10
Date10: 68,
///Date2
Date2: 69,
///Date3
Date3: 70,
///Date4
Date4: 71,
///Date5
Date5: 72,
///Date6
Date6: 73,
///Date7
Date7: 74,
///Date8
Date8: 75,
///Date9
Date9: 76,
///Duration1
Duration1: 77,
///Duration10
Duration10: 78,
///Duration2
Duration2: 79,
///Duration3
Duration3: 80,
///Duration4
Duration4: 81,
///Duration5
Duration5: 82,
///Duration6
Duration6: 83,
///Duration7
Duration7: 84,
///Duration8
Duration8: 85,
///Duration9
Duration9: 86,
///Email
Email: 87,
///End
End: 88,
///Finish1
Finish1: 89,
///Finish10
Finish10: 90,
///Finish2
Finish2: 91,
///Finish3
Finish3: 92,
///Finish4
Finish4: 93,
///Finish5
Finish5: 94,
///Finish6
Finish6: 95,
///Finish7
Finish7: 96,
///Finish8
Finish8: 97,
///Finish9
Finish9: 98,
///Flag10
Flag10: 99,
///Flag1
Flag1: 100,
///Flag11
Flag11: 101,
///Flag12
Flag12: 102,
///Flag13
Flag13: 103,
///Flag14
Flag14: 104,
///Flag15
Flag15: 105,
///Flag16
Flag16: 106,
///Flag17
Flag17: 107,
///Flag18
Flag18: 108,
///Flag19
Flag19: 109,
///Flag2
Flag2: 110,
///Flag20
Flag20: 111,
///Flag3
Flag3: 112,
///Flag4
Flag4: 113,
///Flag5
Flag5: 114,
///Flag6
Flag6: 115,
///Flag7
Flag7: 116,
///Flag8
Flag8: 117,
///Flag9
Flag9: 118,
///Group
Group: 119,
///Units
Units: 120,
///Name
Name: 121,
///Notes
Notes: 122,
///Number1
Number1: 123,
///Number10
Number10: 124,
///Number11
Number11: 125,
///Number12
Number12: 126,
///Number13
Number13: 127,
///Number14
Number14: 128,
///Number15
Number15: 129,
///Number16
Number16: 130,
///Number17
Number17: 131,
///Number18
Number18: 132,
///Number19
Number19: 133,
///Number2
Number2: 134,
///Number20
Number20: 135,
///Number3
Number3: 136,
///Number4
Number4: 137,
///Number5
Number5: 138,
///Number6
Number6: 139,
///Number7
Number7: 140,
///Number8
Number8: 141,
///Number9
Number9: 142,
///OvertimeCost
OvertimeCost: 143,
///OvertimeRate
OvertimeRate: 144,
///OvertimeWork
OvertimeWork: 145,
///PercentWorkComplete
PercentWorkComplete: 146,
///CostPerUse
CostPerUse: 147,
///Generic
Generic: 148,
///OverAllocated
OverAllocated: 149,
///RegularWork
RegularWork: 150,
///RemainingCost
RemainingCost: 151,
///RemainingOvertimeCost
RemainingOvertimeCost: 152,
///RemainingOvertimeWork
RemainingOvertimeWork: 153,
///RemainingWork
RemainingWork: 154,
///ResourceGUID
ResourceGUID: 155,
///Cost
Cost: 156,
///Work
Work: 157,
///Start
Start: 158,
///Start1
Start1: 159,
///Start10
Start10: 160,
///Start2
Start2: 161,
///Start3
Start3: 162,
///Start4
Start4: 163,
///Start5
Start5: 164,
///Start6
Start6: 165,
///Start7
Start7: 166,
///Start8
Start8: 167,
///Start9
Start9: 168,
///StandardRate
StandardRate: 169,
///Text1
Text1: 170,
///Text10
Text10: 171,
///Text11
Text11: 172,
///Text12
Text12: 173,
///Text13
Text13: 174,
///Text14
Text14: 175,
///Text15
Text15: 176,
///Text16
Text16: 177,
///Text17
Text17: 178,
///Text18
Text18: 179,
///Text19
Text19: 180,
///Text2
Text2: 181,
///Text20
Text20: 182,
///Text21
Text21: 183,
///Text22
Text22: 184,
///Text23
Text23: 185,
///Text24
Text24: 186,
///Text25
Text25: 187,
///Text26
Text26: 188,
///Text27
Text27: 189,
///Text28
Text28: 190,
///Text29
Text29: 191,
///Text3
Text3: 192,
///Text30
Text30: 193,
///Text4
Text4: 194,
///Text5
Text5: 195,
///Text6
Text6: 196,
///Text7
Text7: 197,
///Text8
Text8: 198,
///Text9
Text9: 199
}
},
context: {
contents: {
document: {
contents: {
getSelectedTaskAsync: {
conditions: { reqs: ["method Document.getSelectedTaskAsync"] },
value: function (callback) {
/// (Project only) Get the current selected Task's Id.
///The optional callback method
}
},
getTaskByIndexAsync: {
conditions: { reqs: ["method Document.getTaskByIndexAsync"] },
value: function (taskIndex, callback) {
/// (Project only) Get the Task's Id for provided task index.
///Task index in task container
///The optional callback method
}
},
getTaskAsync: {
conditions: { reqs: ["method Document.getTaskAsync"] },
value: function (taskId, callback) {
/// (Project only) Get the Task Name, WSS Task Id, and ResourceNames for given taskId .
///Either a string or value of the Task Id.
///The optional callback method
}
},
getTaskFieldAsync: {
conditions: { reqs: ["method Document.getTaskFieldAsync"] },
value: function (taskId, taskField, callback) {
/// (Project only) Get task field for provided task Id. (Ex. StartDate).
///Either a string or value of the Task Id.
///Task Fields.
///The optional callback method
}
},
getSelectedResourceAsync: {
conditions: { reqs: ["method Document.getSelectedResourceAsync"] },
value: function (callback) {
/// (Project only) Get the current selected Resource's Id.
///The optional callback method
}
},
getResourceByIndexAsync: {
conditions: { reqs: ["method Document.getResourceByIndexAsync"] },
value: function (resourceIndex, callback) {
/// (Project only) Get the Resource's Id for provided resource index.
///Resource index in resource container
///The optional callback method
}
},
getResourceFieldAsync: {
conditions: { reqs: ["method Document.getResourceFieldAsync"] },
value: function (resourceId, resourceField, callback) {
/// (Project only) Get resource field for provided resource Id. (Ex.ResourceName)
///Either a string or value of the Resource Id.
///Resource Fields.
///The optional callback method
}
},
getProjectFieldAsync: {
conditions: { reqs: ["method Document.getProjectFieldAsync"] },
value: function (projectField, callback) {
/// (Project only) Get Project field (Ex. ProjectWebAccessURL).
///Project level fields.
///The optional callback method
}
},
getSelectedViewAsync: {
conditions: { reqs: ["method Document.getSelectedViewAsync"] },
value: function (callback) {
/// (Project only) Get the current selected View Type (Ex. Gantt) and View Name.
///The optional callback method
}
},
getWSSURLAsync: {
conditions: { reqs: ["method Document.getWSSURLAsync"] },
value: function (callback) {
/// (Project only) Get the WSS Url and list name for the Tasks List, the MPP is synced too.
///The optional callback method
}
},
setTaskFieldAsync: {
conditions: { reqs: ["method Document.setTaskFieldAsync"] },
value: function (taskId, fieldId, fieldValue, callback) {
/// (Project only) Set Taskfield (Ex. TaskName).
///Either a string or value of the Task Id.
///Task Field.
///Either a string, number boolean or object for the data that you want to set.
///The optional callback method
}
},
setResourceFieldAsync: {
conditions: { reqs: ["method Document.setResourceFieldAsync"] },
value: function (resourceId, fieldId, fieldValue, callback) {
/// (Project only) Set Resource field (Ex. ResourceName).
///Either a string or value of the Resource Id.
///Resource Field.
///Either a string, number boolean or object for the data that you want to set.
///The optional callback method
}
}
}
}
}
}
}
});
// Setup outlook
Office._processItem(Office, {
metaOnly: true,
conditions: {
hosts: ["outlook", "outlookcompose"],
reqs: ["set Mailbox GE 1.1"]
},
contents: {
MailboxEnums: {
value: new Office._MailboxEnums()
},
context: {
contents: {
mailbox: {
value: new Office._context_mailbox()
},
roamingSettings: {
value: new Office._settings()
}
}
},
cast: {
value: {
item: new Office._cast_item()
}
}
}
})
// Setup CustomXMLParts
Office._addEnumOnObject("CustomXmlNodeType",
{
///Element
Element: "element",
///Attribute
Attribute: "attribute",
///String/field>
Text: "text",
///CData
Cdata: "cdata",
///ProcessingInstruction
ProcessingInstruction: "processingInstruction",
///NodeComment
NodeComment: "nodeComment",
///NodeDocument
NodeDocument: "nodeDocument"
},
Office,
{
hosts: ["word"]
}
);
// Other enumerations on Office
Office._addEnumOnObject("AsyncResultStatus",
{
///Operation failed, check error object
Failed: "failed",
///Operation succeeded
Succeeded: "succeeded"
},
Office,
{
hosts: ["not outlook; not outlookcompose"]
}
);
Office._processItem(Office,
{
contents: {
Text: {
conditions: {
hosts: ["excel", "word"],
reqs: ["set TextBindings GE 1.1"]
},
annotate: {
///Text based Binding
Text: undefined
},
value: "text"
},
Matrix: {
conditions: {
hosts: ["excel", "word"],
reqs: ["set MatrixBindings GE 1.1"]
},
annotate: {
///Matrix based Binding
Matrix: undefined
},
value: "matrix"
},
Table: {
conditions: {
hosts: ["excel", "word", "accesswebapp"],
reqs: ["set TableBindings GE 1.1"]
},
annotate: {
///Table based Binding
Table: undefined
},
value: "table"
}
}
},
"BindingType"
);
Office._processItem(Office,
{
contents: {
Table: {
conditions: {
hosts: ["word", "excel", "accesswebapp"],
reqs: ["set TableCoercion GE 1.1"]
},
annotate: {
///Coerce as Table
Table: undefined
},
value: "table"
},
Text: {
conditions: {
hosts: ["excel", "ppt", "project", "word"],
reqs: ["set TextCoercion GE 1.1"]
},
annotate: {
///Coerce as Text
Text: undefined
},
value: "text"
},
Matrix: {
conditions: {
hosts: ["excel", "word"],
reqs: ["set MatrixCoercion GE 1.1"]
},
annotate: {
///Coerce as Matrix
Matrix: undefined
},
value: "matrix"
},
Html: {
conditions: {
hosts: ["word"],
reqs: ["set HtmlCoercion GE 1.1"]
},
annotate: {
///Coerce as HTML
Html: undefined
},
value: "html"
},
Ooxml: {
conditions: {
hosts: ["word"],
reqs: ["set OoxmlCoercion GE 1.1"]
},
annotate: {
///Coerce as Office Open XML
Ooxml: undefined
},
value: "ooxml"
},
SlideRange: {
conditions: {
hosts: ["ppt"]
},
annotate: {
///Coerce as JSON object containing an array of the ids, titles, and indexes of the selected slides.
SlideRange: undefined
},
value: "slideRange"
}
}
},
"CoercionType"
);
Office._addEnumOnObject("DocumentMode",
{
///Document in Read Only Mode
ReadOnly: "readOnly",
///Document in Read/Write Mode
ReadWrite: "readWrite"
},
Office,
{
hosts: ["word", "excel", "accesswebapp"]
}
);
Office._addEnumOnObject("EventType",
{
///Triggers when a document level selection happens
DocumentSelectionChanged: "documentSelectionChanged",
/// Triggers when a binding level selection happens
BindingSelectionChanged: "bindingSelectionChanged",
///Triggers when a binding level data change happens
BindingDataChanged: "bindingDataChanged",
///Triggers when settings change in a co-Auth session.
SettingsChanged: "settingsChanged",
///Triggers when a customXmlPart node was deleted
DataNodeDeleted: "nodeDeleted",
///Triggers when a customXmlPart node was inserted
DataNodeInserted: "nodeInserted",
///Triggers when a customXmlPart node was replaced
DataNodeReplaced: "nodeReplaced",
///Triggers when a Task selection happens in Project.
TaskSelectionChanged: "taskSelectionChanged",
/// Triggers when a Resource selection happens in Project.
ResourceSelectionChanged: "resourceSelectionChanged",
///Triggers when a View selection happens in Project.
ViewSelectionChanged: "viewSelectionChanged"
},
Office,
{
hosts: ["not outlook; not outlookcompose"]
}
);
// EventType augmentations
Office._processContents(Office.EventType, {
ActiveViewChanged: {
conditions: {
hosts: ["ppt"]
},
annotate: {
///Occurs when the user changes the current view of the document.
ActiveViewChanged: undefined
},
value: "activeViewChanged"
}
});
Office._processItem(Office,
{
conditions: { hosts: ["not outlook; not outlookcompose; not accesswebapp"] },
contents: {
Compressed: {
conditions: {
hosts: ["ppt", "word"],
reqs: ["set CompressedFile GE 1.1"]
},
annotate: {
///Returns the file as a byte array
Compressed: undefined
},
value: "compressed"
},
Pdf: {
conditions: {
hosts: ["ppt", "word"],
reqs: ["set PdfFile GE 1.1"]
},
annotate: {
///Returns the file in PDF format as a byte array
Pdf: undefined
},
value: "pdf"
},
Text: {
conditions: {
hosts: ["word"],
reqs: ["set TextFile GE 1.1"]
},
annotate: {
///Returns the file as plain text
Text: undefined
},
value: "text"
}
}
},
"FileType"
);
Office._addEnumOnObject("FilterType",
{
///Returns all items
All: "all",
///Returns only visible items
OnlyVisible: "onlyVisible"
},
Office,
{
hosts: ["not outlook; not outlookcompose; not accesswebapp"]
}
);
Office._addEnumOnObject("InitializationReason",
{
///Indicates the app was just inserted in the document /field>
Inserted: "inserted",
///Indicated if the extension already existed in the document
DocumentOpened: "documentOpened"
},
Office,
{
hosts: ["not outlook; not outlookcompose"]
}
);
Office._addEnumOnObject("ValueFormat",
{
///Returns items with format
Formatted: "formatted",
///Returns items without format
Unformatted: "unformatted"
},
Office,
{
hosts: ["not outlook; not outlookcompose"]
}
);
Office._processContents(Office, {
GoToType: {
contents: {
Binding: {
conditions: {
hosts: ["excel", "word"]
},
annotate: {
///Goes to a binding object using the specified binding id.
Binding: undefined
},
value: "binding"
},
NamedItem: {
conditions: {
hosts: ["excel"]
},
annotate: {
///
/// Goes to a named item using that item's name.
///
In Excel, you can use any structured reference for a named range or table: "Worksheet2!Table1"
///
NamedItem: undefined
},
value: "namedItem"
},
Slide: {
conditions: {
hosts: ["ppt"]
},
annotate: {
///Goes to a slide using the specified id.
Slide: undefined
},
value: "slide"
},
Index: {
conditions: {
hosts: ["ppt"]
},
annotate: {
///Goes to the specified index by slide number or enum Office.Index
Index: undefined
},
value: "index"
}
}
}
});
Office._addEnumOnObject("Index",
{
First: "first",
Last: "last",
Next: "next",
Previous: "previous"
},
Office,
{
hosts: ["ppt"]
}
);
Office._addEnumOnObject("SelectionMode",
{
Default: "default",
Selected: "selected",
None: "none"
},
Office,
{
hosts: ["word"]
}
);
Office.context.diagnostics = {
__proto__: null,
host: "",
platform: "",
version: ""
};
if (!!intellisense) {
intellisense.addEventListener('statementcompletion', function (event) {
if (event.targetName === "this" || event.target === undefined || event.target === window) return;
event.items = event.items.filter(function (item) {
return !(item.name && item.name.charAt(0) === "_");
});
});
}
Office._processContents(Office, Office._items);
document.addEventListener("DOMContentLoaded", function () {
Office.initialize();
});
var __extends = this.__extends || function (d, b) {
for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p];
function __() { this.constructor = d; }
__.prototype = b.prototype;
d.prototype = new __();
};
var OfficeExtension;
(function (OfficeExtension) {
var ClientObject = (function () {
function ClientObject() {
/// Returns a boolean value for whether the corresponding object is a null object. You must call "context.sync()" before reading the isNullObject property.
}
return ClientObject;
})();
OfficeExtension.ClientObject = ClientObject;
})(OfficeExtension || (OfficeExtension = {__proto__: null}));
var OfficeExtension;
(function (OfficeExtension) {
var ClientRequestContext = (function () {
function ClientRequestContext(url) {
///
/// An abstract RequestContext object that facilitates requests to the host Office application. The "Excel.run" and "Word.run" methods provide a request context.
///
/// Collection of objects that are tracked for automatic adjustments based on surrounding changes in the document.
/// Request headers.
this.requestHeaders = {
__proto__: null,
};
}
ClientRequestContext.prototype.load = function (object, option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
};
ClientRequestContext.prototype.loadRecursive = function (object, options, maxDepth) {
///
/// Queues up a command to recursively load the specified properties of the object and its navigation properties. You must call "context.sync()" before reading the properties.
///
/// The object to be loaded.
///
/// The key-value pairing of load options for the types, such as { "Workbook": "worksheets,tables", "Worksheet": "tables", "Tables": "name" }
///
/// The maximum recursive depth.
};
ClientRequestContext.prototype.trace = function (message) {
///
/// Adds a trace message to the queue. If the promise returned by "context.sync()" is rejected due to an error, this adds a ".traceMessages" array to the OfficeExtension.Error object, containing all trace messages that were executed. These messages can help you monitor the program execution sequence and detect the cause of the error.
///
///
};
ClientRequestContext.prototype.sync = function (passThroughValue) {
///
/// Synchronizes the state between JavaScript proxy objects and the Office document, by executing instructions queued on the request context and retrieving properties of loaded Office objects for use in your code.�This method returns a promise, which is resolved when the synchronization is complete.
///
///
return new OfficeExtension.Promise();
};
ClientRequestContext.prototype.__proto__ = null;
return ClientRequestContext;
})();
OfficeExtension.ClientRequestContext = ClientRequestContext;
})(OfficeExtension || (OfficeExtension = {__proto__: null}));
var OfficeExtension;
(function (OfficeExtension) {
var ClientResult = (function () {
function ClientResult() {
///
/// Contains the result for methods that return primitive types. The object's value property is retrieved from the document after "context.sync()" is invoked.
///
///
/// The value of the result that is retrieved from the document after "context.sync()" is invoked.
///
}
ClientResult.prototype.__proto__ = null;
return ClientResult;
})();
OfficeExtension.ClientResult = ClientResult;
})(OfficeExtension || (OfficeExtension = {__proto__: null}));
var OfficeExtension;
(function (OfficeExtension) {
var DebugInfo = (function () {
function DebugInfo() {
///
/// Debug info (useful for detailed logging of the error, i.e., via JSON.stringify(...)).
///
///
/// Error code string, such as "InvalidArgument".
///
///
/// The error message passed through from the host Office application.
///
///
/// Inner error, if applicable.
///
///
/// The object type and property or method name (or similar information), if available.
///
}
DebugInfo.prototype.__proto__ = null;
return DebugInfo;
})();
OfficeExtension.DebugInfo = DebugInfo;
var Error = (function () {
function Error() {
///
/// The error object returned by "context.sync()", if a promise is rejected due to an error while processing the request.
///
///
/// Error name: "OfficeExtension.Error"
///
///
/// The error message passed through from the host Office application.
///
///
/// Stack trace, if applicable.
///
///
/// Error code string, such as "InvalidArgument".
///
///
/// Trace messages (if any) that were added via a "context.trace()" invocation before calling "context.sync()". If there was an error, this contains all trace messages that were executed before the error occurred. These messages can help you monitor the program execution sequence and detect the case of the error.
///
///
/// Debug info (useful for detailed logging of the error, i.e., via JSON.stringify(...)).
///
///
/// Inner error, if applicable.
///
}
Error.prototype.__proto__ = null;
return Error;
})();
OfficeExtension.Error = Error;
})(OfficeExtension || (OfficeExtension = {__proto__: null}));
var OfficeExtension;
(function (OfficeExtension) {
var ErrorCodes = (function () {
function ErrorCodes() {
}
ErrorCodes.__proto__ = null;
ErrorCodes.accessDenied = "";
ErrorCodes.generalException = "";
ErrorCodes.activityLimitReached = "";
ErrorCodes.invalidObjectPath = "";
ErrorCodes.propertyNotLoaded = "";
ErrorCodes.valueNotLoaded = "";
ErrorCodes.invalidRequestContext = "";
ErrorCodes.invalidArgument = "";
ErrorCodes.runMustReturnPromise = "";
ErrorCodes.cannotRegisterEvent = "";
ErrorCodes.apiNotFound = "";
ErrorCodes.connectionFailure = "";
return ErrorCodes;
})();
OfficeExtension.ErrorCodes = ErrorCodes;
})(OfficeExtension || (OfficeExtension = {__proto__: null}));
var OfficeExtension;
(function (OfficeExtension) {
var Promise = (function () {
///
/// Creates a promise that resolves when all of the child promises resolve.
///
Promise.all = function (promises) { return [new OfficeExtension.Promise()]; };
///
/// Creates a promise that is resolved.
///
Promise.resolve = function (value) { return new OfficeExtension.Promise(); };
///
/// Creates a promise that is rejected.
///
Promise.reject = function (error) { return new OfficeExtension.Promise(); };
///
/// A Promise object that represents a deferred interaction with the host Office application. The publically-consumable OfficeExtension.Promise is available starting in ExcelApi 1.2 and WordApi 1.2. Promises can be chained via ".then", and errors can be caught via ".catch". Remember to always use a ".catch" on the outer promise, and to return intermediary promises so as not to break the promise chain. When a "native" Promise implementation is available, OfficeExtension.Promise will switch to use the native Promise instead.
///
Promise.prototype.then = function (onFulfilled, onRejected) {
///
/// This method will be called once the previous promise has been resolved.
/// Both the onFulfilled on onRejected callbacks are optional.
/// If either or both are omitted, the next onFulfilled/onRejected in the chain will be called called.
/// Returns a new promise for the value or error that was returned from onFulfilled/onRejected.
///
///
///
///
onRejected(new Error());
}
Promise.prototype.catch = function (onRejected) {
///
/// Catches failures or exceptions from actions within the promise, or from an unhandled exception earlier in the call stack.
///
/// function to be called if or when the promise rejects.
///
onRejected(new Error());
}
Promise.prototype.__proto__ = null;
})
OfficeExtension.Promise = Promise;
})(OfficeExtension || (OfficeExtension = {__proto__: null}));
var OfficeExtension;
(function (OfficeExtension) {
var TrackedObjects = (function () {
function TrackedObjects() {
///
/// Collection of tracked objects, contained within a request context. See "context.trackedObjects" for more information.
///
}
TrackedObjects.prototype.add = function (object) {
///
/// Track a new object for automatic adjustment based on surrounding changes in the document. Only some object types require this. If you are using an object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
};
TrackedObjects.prototype.remove = function (object) {
///
/// Release the memory associated with an object that was previously added to this collection. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
};
TrackedObjects.prototype.__proto__ = null;
return TrackedObjects;
})();
OfficeExtension.TrackedObjects = TrackedObjects;
})(OfficeExtension || (OfficeExtension = {__proto__: null}));
(function (OfficeExtension) {
var EventHandlers = (function () {
function EventHandlers() { }
EventHandlers.prototype.add = function (handler) {
return new EventHandlerResult(null, null, handler);
};
EventHandlers.prototype.remove = function (handler) { };
EventHandlers.prototype.__proto__ = null;
return EventHandlers;
}());
OfficeExtension.EventHandlers = EventHandlers;
var EventHandlerResult = (function () {
function EventHandlerResult() { }
EventHandlerResult.prototype.remove = function () { };
EventHandlerResult.prototype.__proto__ = null;
return EventHandlerResult;
}());
OfficeExtension.EventHandlerResult = EventHandlerResult;
})(OfficeExtension || (OfficeExtension = {__proto__: null}));
OfficeExtension.__proto__ = null;
var OfficeCore;
(function (OfficeCore) {
var RequestContext = (function (_super) {
__extends(RequestContext, _super);
function RequestContext() {
///
/// The RequestContext object facilitates requests to the OfficeCore application. Since the Office add-in and the OfficeCore application run in two different processes, the request context is required to get access to the OfficeCore object model from the add-in.
///
_super.call(this, null);
}
return RequestContext;
})(OfficeExtension.ClientRequestContext);
OfficeCore.RequestContext = RequestContext;
OfficeCore.run = function (batch) {
///
///
/// Executes a batch script that performs actions on the OfficeCore object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
///
///
/// A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()").
///
/// The context parameter facilitates requests to the OfficeCore application. Since the Office add-in and the OfficeCore application run in two different processes, the RequestContext is required to get access to the OfficeCore object model from the add-in.
///
///
///
///
/// Executes a batch script that performs actions on the OfficeCore object model, using the RequestContext of a previously-created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
///
///
/// A previously-created API object. The batch will use the same RequestContext as the passed-in object, which means that any changes applied to the object will be picked up by "context.sync()".
///
///
/// A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()").
///
/// The context parameter facilitates requests to the OfficeCore application. Since the Office add-in and the OfficeCore application run in two different processes, the RequestContext is required to get access to the OfficeCore object model from the add-in.
///
///
///
///
/// Executes a batch script that performs actions on the OfficeCore object model, using the RequestContext of a previously-created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
///
///
/// An array of previously-created API objects. The array will be validated to make sure that all of the objects share the same context. The batch will use this shared RequestContext, which means that any changes applied to these objects will be picked up by "context.sync()".
///
///
/// A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()").
///
/// The context parameter facilitates requests to the OfficeCore application. Since the Office add-in and the OfficeCore application run in two different processes, the RequestContext is required to get access to the OfficeCore object model from the add-in.
///
///
arguments[arguments.length - 1](new OfficeCore.RequestContext());
return new OfficeExtension.Promise();
}
})(OfficeCore || (OfficeCore = {__proto__: null}));
OfficeCore.__proto__ = null;
var Excel;
(function (Excel) {
/// Aggregation function for the DataPivotField. [Api set: ExcelApi 1.8]
var AggregationFunction = {
__proto__: null,
"unknown": "unknown",
"automatic": "automatic",
"sum": "sum",
"count": "count",
"average": "average",
"max": "max",
"min": "min",
"product": "product",
"countNumbers": "countNumbers",
"standardDeviation": "standardDeviation",
"standardDeviationP": "standardDeviationP",
"variance": "variance",
"varianceP": "varianceP",
}
Excel.AggregationFunction = AggregationFunction;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Application = (function(_super) {
__extends(Application, _super);
function Application() {
/// Represents the Excel application that manages the workbook. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Returns the Excel calculation engine version used for the last full recalculation. [Api set: ExcelApi 1.9]
/// Returns the calculation mode used in the workbook, as defined by the constants in `Excel.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. [Api set: ExcelApi 1.1 for get, 1.8 for set]
/// Returns the calculation state of the application. See `Excel.CalculationState` for details. [Api set: ExcelApi 1.9]
/// Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings. [Api set: ExcelApi 1.11]
/// Gets the string used as the decimal separator for numeric values. This is based on the local Excel settings. [Api set: ExcelApi 1.11]
/// 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. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.11]
/// Specifies if the system separators of Excel are enabled. System separators include the decimal separator and thousands separator. [Api set: ExcelApi 1.11]
}
Application.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Application.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ApplicationUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing Application object, with properties that have already been loaded and synced.
///
}
Application.prototype.calculate = function(calculationType) {
///
/// Recalculate all currently opened workbooks in Excel. [Api set: ExcelApi 1.1]
///
/// Specifies the calculation type to use. See `Excel.CalculationType` for details.
///
}
Application.prototype.suspendApiCalculationUntilNextSync = function() {
///
/// Suspends calculation until the next `context.sync()` is called. Once set, it is the developer's responsibility to re-calc the workbook, to ensure that any dependencies are propagated. [Api set: ExcelApi 1.6]
///
///
}
Application.prototype.suspendScreenUpdatingUntilNextSync = function() {
///
/// Suspends screen updating until the next `context.sync()` is called. **Note**: Don't call `suspendScreenUpdatingUntilNextSync` repeatedly (such as in a loop). Repeated calls will cause the Excel window to flicker. [Api set: ExcelApi 1.9]
///
///
}
return Application;
})(OfficeExtension.ClientObject);
Excel.Application = Application;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.9]
var ArrowheadLength = {
__proto__: null,
"short": "short",
"medium": "medium",
"long": "long",
}
Excel.ArrowheadLength = ArrowheadLength;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.9]
var ArrowheadStyle = {
__proto__: null,
"none": "none",
"triangle": "triangle",
"stealth": "stealth",
"diamond": "diamond",
"oval": "oval",
"open": "open",
}
Excel.ArrowheadStyle = ArrowheadStyle;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.9]
var ArrowheadWidth = {
__proto__: null,
"narrow": "narrow",
"medium": "medium",
"wide": "wide",
}
Excel.ArrowheadWidth = ArrowheadWidth;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// The behavior types when AutoFill is used on a range in the workbook. [Api set: ExcelApi 1.9]
var AutoFillType = {
__proto__: null,
"fillDefault": "fillDefault",
"fillCopy": "fillCopy",
"fillSeries": "fillSeries",
"fillFormats": "fillFormats",
"fillValues": "fillValues",
"fillDays": "fillDays",
"fillWeekdays": "fillWeekdays",
"fillMonths": "fillMonths",
"fillYears": "fillYears",
"linearTrend": "linearTrend",
"growthTrend": "growthTrend",
"flashFill": "flashFill",
}
Excel.AutoFillType = AutoFillType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var AutoFilter = (function(_super) {
__extends(AutoFilter, _super);
function AutoFilter() {
/// Represents the `AutoFilter` object. AutoFilter turns the values in Excel column into specific filters based on the cell contents. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// An array that holds all the filter criteria in the autofiltered range. [Api set: ExcelApi 1.9]
/// Specifies if the AutoFilter is enabled. [Api set: ExcelApi 1.9]
/// Specifies if the AutoFilter has filter criteria. [Api set: ExcelApi 1.9]
}
AutoFilter.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
AutoFilter.prototype.apply = function(range, columnIndex, criteria) {
///
/// Applies the AutoFilter to a range. This filters the column if column index and filter criteria are specified. [Api set: ExcelApi 1.9]
///
/// The range on which the AutoFilter will apply.
/// The zero-based column index to which the AutoFilter is applied.
/// The filter criteria.
///
}
AutoFilter.prototype.clearColumnCriteria = function(columnIndex) {
///
/// Clears the column filter criteria of the AutoFilter. [Api set: ExcelApi 1.14]
///
/// 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` exception will be thrown.
///
}
AutoFilter.prototype.clearCriteria = function() {
///
/// Clears the filter criteria and sort state of the AutoFilter. [Api set: ExcelApi 1.9]
///
///
}
AutoFilter.prototype.getRange = function() {
///
/// Returns the `Range` object that represents the range to which the AutoFilter applies. [Api set: ExcelApi 1.9]
///
///
}
AutoFilter.prototype.getRangeOrNullObject = function() {
///
/// 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 an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.9]
///
///
}
AutoFilter.prototype.reapply = function() {
///
/// Applies the specified Autofilter object currently on the range. [Api set: ExcelApi 1.9]
///
///
}
AutoFilter.prototype.remove = function() {
///
/// Removes the AutoFilter for the range. [Api set: ExcelApi 1.9]
///
///
}
return AutoFilter;
})(OfficeExtension.ClientObject);
Excel.AutoFilter = AutoFilter;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var BasicDataValidation = (function() {
function BasicDataValidation() {
/// Represents the basic type data validation criteria. [Api set: ExcelApi 1.8]
/// 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. [Api set: ExcelApi 1.8]
/// 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. [Api set: ExcelApi 1.8]
/// The operator to use for validating the data. [Api set: ExcelApi 1.8]
}
return BasicDataValidation;
})();
Interfaces.BasicDataValidation.__proto__ = null;
Interfaces.BasicDataValidation = BasicDataValidation;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Binding = (function(_super) {
__extends(Binding, _super);
function Binding() {
/// Represents an Office.js binding that is defined in the workbook. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the binding identifier. [Api set: ExcelApi 1.1]
/// Returns the type of the binding. See `Excel.BindingType` for details. [Api set: ExcelApi 1.1]
/// Occurs when data or formatting within the binding is changed. [Api set: ExcelApi 1.2]
/// Occurs when the selected content in the binding is changed. **Note**: If multiple, discontiguous cells are selected, `Binding.onSelectionChanged` only reports row and column information for one selection. Use `Worksheet.onSelectionChanged` for multiple selected ranges. [Api set: ExcelApi 1.2]
}
Binding.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Binding.prototype.delete = function() {
///
/// Deletes the binding. [Api set: ExcelApi 1.3]
///
///
}
Binding.prototype.getRange = function() {
///
/// Returns the range represented by the binding. Will throw an error if the binding is not of the correct type. [Api set: ExcelApi 1.1]
///
///
}
Binding.prototype.getTable = function() {
///
/// Returns the table represented by the binding. Will throw an error if the binding is not of the correct type. [Api set: ExcelApi 1.1]
///
///
}
Binding.prototype.getText = function() {
///
/// Returns the text represented by the binding. Will throw an error if the binding is not of the correct type. [Api set: ExcelApi 1.1]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = '';
return result;
}
Binding.prototype.onDataChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the binding that raised the data changed event.
///
var eventInfo = new Excel.Interfaces.BindingDataChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
Binding.prototype.onSelectionChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the selection that raised the selection changed event. **Note**: If multiple, discontiguous cells are selected, `Binding.onSelectionChanged` only reports row and column information for one selection. Use `Worksheet.onSelectionChanged` for multiple selected ranges.
///
var eventInfo = new Excel.Interfaces.BindingSelectionChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
return Binding;
})(OfficeExtension.ClientObject);
Excel.Binding = Binding;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var BindingCollection = (function(_super) {
__extends(BindingCollection, _super);
function BindingCollection() {
/// Represents the collection of all the binding objects that are part of the workbook. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Returns the number of bindings in the collection. [Api set: ExcelApi 1.1]
/// Gets the loaded child items in this collection.
}
BindingCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
BindingCollection.prototype.add = function(range, bindingType, id) {
///
/// Add a new binding to a particular Range. [Api set: ExcelApi 1.3]
///
/// 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 of binding. See `Excel.BindingType`.
/// Name of the binding.
///
}
BindingCollection.prototype.addFromNamedItem = function(name, bindingType, id) {
///
/// 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. [Api set: ExcelApi 1.3]
///
/// Name from which to create binding.
/// Type of binding. See `Excel.BindingType`.
/// Name of the binding.
///
}
BindingCollection.prototype.addFromSelection = function(bindingType, id) {
///
/// Add a new binding based on the current selection. If the selection has multiple areas, the `InvalidReference` error will be returned. [Api set: ExcelApi 1.3]
///
/// Type of binding. See `Excel.BindingType`.
/// Name of the binding.
///
}
BindingCollection.prototype.getCount = function() {
///
/// Gets the number of bindings in the collection. [Api set: ExcelApi 1.4]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
BindingCollection.prototype.getItem = function(id) {
///
/// Gets a binding object by ID. [Api set: ExcelApi 1.1]
///
/// ID of the binding object to be retrieved.
///
}
BindingCollection.prototype.getItemAt = function(index) {
///
/// Gets a binding object based on its position in the items array. [Api set: ExcelApi 1.1]
///
/// Index value of the object to be retrieved. Zero-indexed.
///
}
BindingCollection.prototype.getItemOrNullObject = function(id) {
///
/// Gets a binding object by ID. If the binding object does not exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.4]
///
/// ID of the binding object to be retrieved.
///
}
return BindingCollection;
})(OfficeExtension.ClientObject);
Excel.BindingCollection = BindingCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var BindingDataChangedEventArgs = (function() {
function BindingDataChangedEventArgs() {
/// Provides information about the binding that raised the data changed event. [Api set: ExcelApi 1.2]
/// Gets a temporary `Binding` object that contains the ID of the `Binding` object that raised the event. Use that ID with `BindingCollection.getItem(id)` to get the binding. [Api set: ExcelApi 1.2]
}
return BindingDataChangedEventArgs;
})();
Interfaces.BindingDataChangedEventArgs.__proto__ = null;
Interfaces.BindingDataChangedEventArgs = BindingDataChangedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var BindingSelectionChangedEventArgs = (function() {
function BindingSelectionChangedEventArgs() {
/// Provides information about the selection that raised the selection changed event. **Note**: If multiple, discontiguous cells are selected, `Binding.onSelectionChanged` only reports row and column information for one selection. Use `Worksheet.onSelectionChanged` for multiple selected ranges. [Api set: ExcelApi 1.2]
/// Gets a temporary `Binding` object that contains the ID of the `Binding` object that raised the event. Use that ID with `BindingCollection.getItem(id)` to get the binding. [Api set: ExcelApi 1.2]
/// Gets the number of columns selected. [Api set: ExcelApi 1.2]
/// Gets the number of rows selected. [Api set: ExcelApi 1.2]
/// Gets the index of the first column of the selection (zero-based). [Api set: ExcelApi 1.2]
/// Gets the index of the first row of the selection (zero-based). [Api set: ExcelApi 1.2]
}
return BindingSelectionChangedEventArgs;
})();
Interfaces.BindingSelectionChangedEventArgs.__proto__ = null;
Interfaces.BindingSelectionChangedEventArgs = BindingSelectionChangedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.1]
var BindingType = {
__proto__: null,
"range": "range",
"table": "table",
"text": "text",
}
Excel.BindingType = BindingType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.1]
var BorderIndex = {
__proto__: null,
"edgeTop": "edgeTop",
"edgeBottom": "edgeBottom",
"edgeLeft": "edgeLeft",
"edgeRight": "edgeRight",
"insideVertical": "insideVertical",
"insideHorizontal": "insideHorizontal",
"diagonalDown": "diagonalDown",
"diagonalUp": "diagonalUp",
}
Excel.BorderIndex = BorderIndex;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.1]
var BorderLineStyle = {
__proto__: null,
"none": "none",
"continuous": "continuous",
"dash": "dash",
"dashDot": "dashDot",
"dashDotDot": "dashDotDot",
"dot": "dot",
"double": "double",
"slantDashDot": "slantDashDot",
}
Excel.BorderLineStyle = BorderLineStyle;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.1]
var BorderWeight = {
__proto__: null,
"hairline": "hairline",
"thin": "thin",
"medium": "medium",
"thick": "thick",
}
Excel.BorderWeight = BorderWeight;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.7]
var BuiltInStyle = {
__proto__: null,
"normal": "normal",
"comma": "comma",
"currency": "currency",
"percent": "percent",
"wholeComma": "wholeComma",
"wholeDollar": "wholeDollar",
"hlink": "hlink",
"hlinkTrav": "hlinkTrav",
"note": "note",
"warningText": "warningText",
"emphasis1": "emphasis1",
"emphasis2": "emphasis2",
"emphasis3": "emphasis3",
"sheetTitle": "sheetTitle",
"heading1": "heading1",
"heading2": "heading2",
"heading3": "heading3",
"heading4": "heading4",
"input": "input",
"output": "output",
"calculation": "calculation",
"checkCell": "checkCell",
"linkedCell": "linkedCell",
"total": "total",
"good": "good",
"bad": "bad",
"neutral": "neutral",
"accent1": "accent1",
"accent1_20": "accent1_20",
"accent1_40": "accent1_40",
"accent1_60": "accent1_60",
"accent2": "accent2",
"accent2_20": "accent2_20",
"accent2_40": "accent2_40",
"accent2_60": "accent2_60",
"accent3": "accent3",
"accent3_20": "accent3_20",
"accent3_40": "accent3_40",
"accent3_60": "accent3_60",
"accent4": "accent4",
"accent4_20": "accent4_20",
"accent4_40": "accent4_40",
"accent4_60": "accent4_60",
"accent5": "accent5",
"accent5_20": "accent5_20",
"accent5_40": "accent5_40",
"accent5_60": "accent5_60",
"accent6": "accent6",
"accent6_20": "accent6_20",
"accent6_40": "accent6_40",
"accent6_60": "accent6_60",
"explanatoryText": "explanatoryText",
}
Excel.BuiltInStyle = BuiltInStyle;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.1]
var CalculationMode = {
__proto__: null,
"automatic": "automatic",
"automaticExceptTables": "automaticExceptTables",
"manual": "manual",
}
Excel.CalculationMode = CalculationMode;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the state of calculation across the entire Excel application. [Api set: ExcelApi 1.9]
var CalculationState = {
__proto__: null,
"done": "done",
"calculating": "calculating",
"pending": "pending",
}
Excel.CalculationState = CalculationState;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.1]
var CalculationType = {
__proto__: null,
"recalculate": "recalculate",
"full": "full",
"fullRebuild": "fullRebuild",
}
Excel.CalculationType = CalculationType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var CellBorder = (function() {
function CellBorder() {
/// Represents the properties of a single border returned by `getCellProperties`, `getRowProperties`, and `getColumnProperties`, or the border property input parameter of `setCellProperties`, `setRowProperties`, and `setColumnProperties`. [Api set: ExcelApi 1.9]
/// Represents the `color` property of a single border. [Api set: ExcelApi 1.9]
/// Represents the `style` property of a single border. [Api set: ExcelApi 1.9]
/// Represents the `tintAndShade` property of a single border. [Api set: ExcelApi 1.9]
/// Represents the `weight` property of a single border. [Api set: ExcelApi 1.9]
}
return CellBorder;
})();
Interfaces.CellBorder.__proto__ = null;
Interfaces.CellBorder = CellBorder;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var CellBorderCollection = (function() {
function CellBorderCollection() {
/// Represents the `format.borders` properties of `getCellProperties`, `getRowProperties`, and `getColumnProperties`, or the `format.borders` input parameter of `setCellProperties`, `setRowProperties`, and `setColumnProperties`. [Api set: ExcelApi 1.9]
/// Represents the `format.borders.bottom` property. [Api set: ExcelApi 1.9]
/// Represents the `format.borders.diagonalDown` property. [Api set: ExcelApi 1.9]
/// Represents the `format.borders.diagonalUp` property. [Api set: ExcelApi 1.9]
/// Represents the `format.borders.horizontal` property. [Api set: ExcelApi 1.9]
/// Represents the `format.borders.left` property. [Api set: ExcelApi 1.9]
/// Represents the `format.borders.right` property. [Api set: ExcelApi 1.9]
/// Represents the `format.borders.top` property. [Api set: ExcelApi 1.9]
/// Represents the `format.borders.vertical` property. [Api set: ExcelApi 1.9]
}
return CellBorderCollection;
})();
Interfaces.CellBorderCollection.__proto__ = null;
Interfaces.CellBorderCollection = CellBorderCollection;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var CellPropertiesBorderLoadOptions = (function() {
function CellPropertiesBorderLoadOptions() {
/// Specifies which properties to load on the `format.borders` object. [Api set: ExcelApi 1.9]
/// Specifies whether to load the `color` property. [Api set: ExcelApi 1.9]
/// Specifies whether to load the `style` property. [Api set: ExcelApi 1.9]
/// Specifies whether to load the `tintAndShade` property. [Api set: ExcelApi 1.9]
/// Specifies whether to load the `weight` property. [Api set: ExcelApi 1.9]
}
return CellPropertiesBorderLoadOptions;
})();
Interfaces.CellPropertiesBorderLoadOptions.__proto__ = null;
Interfaces.CellPropertiesBorderLoadOptions = CellPropertiesBorderLoadOptions;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var CellPropertiesFill = (function() {
function CellPropertiesFill() {
/// Represents the `format.fill` properties of `getCellProperties`, `getRowProperties`, and `getColumnProperties` or the `format.fill` input parameter of `setCellProperties`, `setRowProperties`, and `setColumnProperties`. [Api set: ExcelApi 1.9]
/// Represents the `format.fill.color` property. [Api set: ExcelApi 1.9]
/// Represents the `format.fill.pattern` property. [Api set: ExcelApi 1.9]
/// Represents the `format.fill.patternColor` property. [Api set: ExcelApi 1.9]
/// Represents the `format.fill.patternTintAndShade` property. [Api set: ExcelApi 1.9]
/// Represents the `format.fill.tintAndShade` property. [Api set: ExcelApi 1.9]
}
return CellPropertiesFill;
})();
Interfaces.CellPropertiesFill.__proto__ = null;
Interfaces.CellPropertiesFill = CellPropertiesFill;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var CellPropertiesFillLoadOptions = (function() {
function CellPropertiesFillLoadOptions() {
/// Specifies which properties to load on the `format.fill` object. [Api set: ExcelApi 1.9]
/// Specifies whether to load the `color` property. [Api set: ExcelApi 1.9]
/// Specifies whether to load the `pattern` property. [Api set: ExcelApi 1.9]
/// Specifies whether to load the `patternColor` property. [Api set: ExcelApi 1.9]
/// Specifies whether to load the `patternTintAndShade` property. [Api set: ExcelApi 1.9]
/// Specifies whether to load the `tintAndShade` property. [Api set: ExcelApi 1.9]
}
return CellPropertiesFillLoadOptions;
})();
Interfaces.CellPropertiesFillLoadOptions.__proto__ = null;
Interfaces.CellPropertiesFillLoadOptions = CellPropertiesFillLoadOptions;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var CellPropertiesFont = (function() {
function CellPropertiesFont() {
/// Represents the `format.font` properties of `getCellProperties`, `getRowProperties`, and `getColumnProperties`, or the `format.font` input parameter of `setCellProperties`, `setRowProperties`, and `setColumnProperties`. [Api set: ExcelApi 1.9]
/// Represents the `format.font.bold` property. [Api set: ExcelApi 1.9]
/// Represents the `format.font.color` property. [Api set: ExcelApi 1.9]
/// Represents the `format.font.italic` property. [Api set: ExcelApi 1.9]
/// Represents the `format.font.name` property. [Api set: ExcelApi 1.9]
/// Represents the `format.font.size` property. [Api set: ExcelApi 1.9]
/// Represents the `format.font.strikethrough` property. [Api set: ExcelApi 1.9]
/// Represents the `format.font.subscript` property. [Api set: ExcelApi 1.9]
/// Represents the `format.font.superscript` property. [Api set: ExcelApi 1.9]
/// Represents the `format.font.tintAndShade` property. [Api set: ExcelApi 1.9]
/// Represents the `format.font.underline` property. [Api set: ExcelApi 1.9]
}
return CellPropertiesFont;
})();
Interfaces.CellPropertiesFont.__proto__ = null;
Interfaces.CellPropertiesFont = CellPropertiesFont;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var CellPropertiesFontLoadOptions = (function() {
function CellPropertiesFontLoadOptions() {
/// Specifies which properties to load on the `format.font` object. [Api set: ExcelApi 1.9]
/// Specifies whether to load the `bold` property. [Api set: ExcelApi 1.9]
/// Specifies whether to load the `color` property. [Api set: ExcelApi 1.9]
/// Specifies whether to load the `italic` property. [Api set: ExcelApi 1.9]
/// Specifies whether to load the `name` property. [Api set: ExcelApi 1.9]
/// Specifies whether to load the `size` property. [Api set: ExcelApi 1.9]
/// Specifies whether to load the `strikethrough` property. [Api set: ExcelApi 1.9]
/// Specifies whether to load the `subscript` property. [Api set: ExcelApi 1.9]
/// Specifies whether to load the `superscript` property. [Api set: ExcelApi 1.9]
/// Specifies whether to load the `tintAndShade` property. [Api set: ExcelApi 1.9]
/// Specifies whether to load the `underline` property. [Api set: ExcelApi 1.9]
}
return CellPropertiesFontLoadOptions;
})();
Interfaces.CellPropertiesFontLoadOptions.__proto__ = null;
Interfaces.CellPropertiesFontLoadOptions = CellPropertiesFontLoadOptions;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var CellPropertiesProtection = (function() {
function CellPropertiesProtection() {
/// Represents the `format.protection` properties of `getCellProperties`, `getRowProperties`, and `getColumnProperties`, or the `format.protection` input parameter of `setCellProperties`, `setRowProperties`, and `setColumnProperties`. [Api set: ExcelApi 1.9]
/// Represents the `format.protection.formulaHidden` property. [Api set: ExcelApi 1.9]
/// Represents the `format.protection.locked` property. [Api set: ExcelApi 1.9]
}
return CellPropertiesProtection;
})();
Interfaces.CellPropertiesProtection.__proto__ = null;
Interfaces.CellPropertiesProtection = CellPropertiesProtection;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var CellValueConditionalFormat = (function(_super) {
__extends(CellValueConditionalFormat, _super);
function CellValueConditionalFormat() {
/// Represents a cell value conditional format. [Api set: ExcelApi 1.6]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. [Api set: ExcelApi 1.6]
/// Specifies the rule object on this conditional format. [Api set: ExcelApi 1.6]
}
CellValueConditionalFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
CellValueConditionalFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.CellValueConditionalFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing CellValueConditionalFormat object, with properties that have already been loaded and synced.
///
}
return CellValueConditionalFormat;
})(OfficeExtension.ClientObject);
Excel.CellValueConditionalFormat = CellValueConditionalFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChangedEventDetail = (function() {
function ChangedEventDetail() {
/// Provides information about the details of a `WorksheetChangedEvent` or `TableChangedEvent`. [Api set: ExcelApi 1.9]
/// Represents the value after the change. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. [Api set: ExcelApi 1.9]
/// Represents the value before the change. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. [Api set: ExcelApi 1.9]
/// Represents the type of value after the change. [Api set: ExcelApi 1.9]
/// Represents the type of value before the change. [Api set: ExcelApi 1.9]
}
return ChangedEventDetail;
})();
Interfaces.ChangedEventDetail.__proto__ = null;
Interfaces.ChangedEventDetail = ChangedEventDetail;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChangeDirectionState = (function() {
function ChangeDirectionState() {
/// Represents the direction that existing or remaining cells in a worksheet will shift when cells are inserted into or deleted from a worksheet. [Api set: ExcelApi 1.14]
/// Represents the direction (such as up or to the left) that the remaining cells will shift when a cell or cells are deleted. Note:`insertShiftDirection` and `deleteShiftDirection` are exclusive and both enums can't have a value at the same time. If one has a value, then the other will return `undefined`. [Api set: ExcelApi 1.14]
/// Represents the direction (such as down or to the right) that the existing cells will shift when a new cell or cells are inserted. Note:`insertShiftDirection` and `deleteShiftDirection` are exclusive and both enums can't have a value at the same time. If one has a value, then the other will return `undefined`. [Api set: ExcelApi 1.14]
}
return ChangeDirectionState;
})();
Interfaces.ChangeDirectionState.__proto__ = null;
Interfaces.ChangeDirectionState = ChangeDirectionState;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Chart = (function(_super) {
__extends(Chart, _super);
function Chart() {
/// Represents a chart object in a workbook. To learn more about the chart object model, see {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-charts | Work with charts using the Excel JavaScript API}. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents chart axes. [Api set: ExcelApi 1.1]
/// Specifies a chart category label level enumeration constant, referring to the level of the source category labels. [Api set: ExcelApi 1.8]
/// Specifies the type of the chart. See `Excel.ChartType` for details. [Api set: ExcelApi 1.7]
/// Represents the data labels on the chart. [Api set: ExcelApi 1.1]
/// Specifies the way that blank cells are plotted on a chart. [Api set: ExcelApi 1.8]
/// Encapsulates the format properties for the chart area. [Api set: ExcelApi 1.1]
/// Specifies the height, in points, of the chart object. [Api set: ExcelApi 1.1]
/// The unique ID of chart. [Api set: ExcelApi 1.7]
/// The distance, in points, from the left side of the chart to the worksheet origin. [Api set: ExcelApi 1.1]
/// Represents the legend for the chart. [Api set: ExcelApi 1.1]
/// Specifies the name of a chart object. [Api set: ExcelApi 1.1]
/// Encapsulates the options for a pivot chart. [Api set: ExcelApi 1.9]
/// Represents the plot area for the chart. [Api set: ExcelApi 1.8]
/// Specifies the way columns or rows are used as data series on the chart. [Api set: ExcelApi 1.8]
/// True if only visible cells are plotted. False if both visible and hidden cells are plotted. [Api set: ExcelApi 1.8]
/// Represents either a single series or collection of series in the chart. [Api set: ExcelApi 1.1]
/// Specifies a chart series name level enumeration constant, referring to the level of the source series names. [Api set: ExcelApi 1.8]
/// Specifies whether to display all field buttons on a PivotChart. [Api set: ExcelApi 1.7]
/// 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. [Api set: ExcelApi 1.8]
/// Specifies the chart style for the chart. [Api set: ExcelApi 1.8]
/// Represents the title of the specified chart, including the text, visibility, position, and formatting of the title. [Api set: ExcelApi 1.1]
/// 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). [Api set: ExcelApi 1.1]
/// Specifies the width, in points, of the chart object. [Api set: ExcelApi 1.1]
/// The worksheet containing the current chart. [Api set: ExcelApi 1.2]
/// Occurs when the chart is activated. [Api set: ExcelApi 1.8]
/// Occurs when the chart is deactivated. [Api set: ExcelApi 1.8]
}
Chart.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Chart.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing Chart object, with properties that have already been loaded and synced.
///
}
Chart.prototype.activate = function() {
///
/// Activates the chart in the Excel UI. [Api set: ExcelApi 1.9]
///
///
}
Chart.prototype.delete = function() {
///
/// Deletes the chart object. [Api set: ExcelApi 1.1]
///
///
}
Chart.prototype.getDataTable = function() {
///
/// Gets the data table on the chart. If the chart doesn't allow a data table, it will throw an exception. [Api set: ExcelApi 1.14]
///
///
}
Chart.prototype.getDataTableOrNullObject = function() {
///
/// Gets the data table on the chart. If the chart doesn't allow a data table, then this function returns an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.14]
///
///
}
Chart.prototype.getImage = function(width, height, fittingMode) {
///
/// 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. [Api set: ExcelApi 1.2]
///
/// Optional. The desired height of the resulting image.
/// Optional. The desired width of the resulting image.
/// Optional. The method used to scale the chart to the specified dimensions (if both height and width are set).
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = '';
return result;
}
Chart.prototype.setData = function(sourceData, seriesBy) {
///
/// Resets the source data for the chart. [Api set: ExcelApi 1.1]
///
/// The range object corresponding to the source data.
/// 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 `Excel.ChartSeriesBy` for details.
///
}
Chart.prototype.setPosition = function(startCell, endCell) {
///
/// Positions the chart relative to cells on the worksheet. [Api set: ExcelApi 1.1]
///
/// 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.
/// Optional. The end cell. If specified, the chart's width and height will be set to fully cover up this cell/range.
///
}
Chart.prototype.onActivated = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the chart that raised the activated event.
///
var eventInfo = new Excel.Interfaces.ChartActivatedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
Chart.prototype.onDeactivated = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the chart that raised the deactivated event.
///
var eventInfo = new Excel.Interfaces.ChartDeactivatedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
return Chart;
})(OfficeExtension.ClientObject);
Excel.Chart = Chart;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartActivatedEventArgs = (function() {
function ChartActivatedEventArgs() {
/// Provides information about the chart that raised the activated event. [Api set: ExcelApi 1.8]
/// Gets the ID of the chart that is activated. [Api set: ExcelApi 1.8]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.8]
/// Gets the ID of the worksheet in which the chart is activated. [Api set: ExcelApi 1.8]
}
return ChartActivatedEventArgs;
})();
Interfaces.ChartActivatedEventArgs.__proto__ = null;
Interfaces.ChartActivatedEventArgs = ChartActivatedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartAddedEventArgs = (function() {
function ChartAddedEventArgs() {
/// Provides information about the chart that raised the added event. [Api set: ExcelApi 1.8]
/// Gets the ID of the chart that is added to the worksheet. [Api set: ExcelApi 1.8]
/// Gets the source of the event. See `Excel.EventSource` for details. [Api set: ExcelApi 1.8]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.8]
/// Gets the ID of the worksheet in which the chart is added. [Api set: ExcelApi 1.8]
}
return ChartAddedEventArgs;
})();
Interfaces.ChartAddedEventArgs.__proto__ = null;
Interfaces.ChartAddedEventArgs = ChartAddedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartAreaFormat = (function(_super) {
__extends(ChartAreaFormat, _super);
function ChartAreaFormat() {
/// Encapsulates the format properties for the overall chart area. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the border format of chart area, which includes color, linestyle, and weight. [Api set: ExcelApi 1.7]
/// Specifies the color scheme of the chart. [Api set: ExcelApi 1.9]
/// Represents the fill format of an object, which includes background formatting information. [Api set: ExcelApi 1.1]
/// Represents the font attributes (font name, font size, color, etc.) for the current object. [Api set: ExcelApi 1.1]
/// Specifies if the chart area of the chart has rounded corners. [Api set: ExcelApi 1.9]
}
ChartAreaFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartAreaFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartAreaFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartAreaFormat object, with properties that have already been loaded and synced.
///
}
return ChartAreaFormat;
})(OfficeExtension.ClientObject);
Excel.ChartAreaFormat = ChartAreaFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartAxes = (function(_super) {
__extends(ChartAxes, _super);
function ChartAxes() {
/// Represents the chart axes. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the category axis in a chart. [Api set: ExcelApi 1.1]
/// Represents the series axis of a 3-D chart. [Api set: ExcelApi 1.1]
/// Represents the value axis in an axis. [Api set: ExcelApi 1.1]
}
ChartAxes.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartAxes.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartAxesUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartAxes object, with properties that have already been loaded and synced.
///
}
ChartAxes.prototype.getItem = function(type, group) {
///
/// Returns the specific axis identified by type and group. [Api set: ExcelApi 1.7]
///
/// Specifies the axis type. See `Excel.ChartAxisType` for details.
/// Optional. Specifies the axis group. See `Excel.ChartAxisGroup` for details.
///
}
return ChartAxes;
})(OfficeExtension.ClientObject);
Excel.ChartAxes = ChartAxes;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartAxis = (function(_super) {
__extends(ChartAxis, _super);
function ChartAxis() {
/// Represents a single axis in a chart. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies the alignment for the specified axis tick label. See `Excel.ChartTextHorizontalAlignment` for detail. [Api set: ExcelApi 1.8]
/// Specifies the group for the specified axis. See `Excel.ChartAxisGroup` for details. [Api set: ExcelApi 1.7]
/// Specifies the base unit for the specified category axis. [Api set: ExcelApi 1.7]
/// Specifies the category axis type. [Api set: ExcelApi 1.7]
/// Specifies the custom axis display unit value. To set this property, please use the `SetCustomDisplayUnit(double)` method. [Api set: ExcelApi 1.7]
/// Represents the axis display unit. See `Excel.ChartAxisDisplayUnit` for details. [Api set: ExcelApi 1.7]
/// Represents the formatting of a chart object, which includes line and font formatting. [Api set: ExcelApi 1.1]
/// Specifies the height, in points, of the chart axis. Returns `null` if the axis is not visible. [Api set: ExcelApi 1.7]
/// Specifies if the value axis crosses the category axis between categories. [Api set: ExcelApi 1.8]
/// 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. [Api set: ExcelApi 1.7]
/// 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. [Api set: ExcelApi 1.9]
/// Specifies the base of the logarithm when using logarithmic scales. [Api set: ExcelApi 1.7]
/// Returns an object that represents the major gridlines for the specified axis. [Api set: ExcelApi 1.1]
/// Specifies the type of major tick mark for the specified axis. See `Excel.ChartAxisTickMark` for details. [Api set: ExcelApi 1.7]
/// Specifies the major unit scale value for the category axis when the `categoryType` property is set to `dateAxis`. [Api set: ExcelApi 1.7]
/// Represents the interval between two major tick marks. Can be set to a numeric value or an empty string. The returned value is always a number. [Api set: ExcelApi 1.1]
/// Represents the maximum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. [Api set: ExcelApi 1.1]
/// Represents the minimum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. [Api set: ExcelApi 1.1]
/// Returns an object that represents the minor gridlines for the specified axis. [Api set: ExcelApi 1.1]
/// Specifies the type of minor tick mark for the specified axis. See `Excel.ChartAxisTickMark` for details. [Api set: ExcelApi 1.7]
/// Specifies the minor unit scale value for the category axis when the `categoryType` property is set to `dateAxis`. [Api set: ExcelApi 1.7]
/// Represents the interval between two minor tick marks. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. [Api set: ExcelApi 1.1]
/// Specifies if an axis is multilevel. [Api set: ExcelApi 1.8]
/// Specifies the format code for the axis tick label. [Api set: ExcelApi 1.8]
/// 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. [Api set: ExcelApi 1.8]
/// Specifies the specified axis position where the other axis crosses. See `Excel.ChartAxisPosition` for details. [Api set: ExcelApi 1.8]
/// Specifies the axis position where the other axis crosses. You should use the `SetPositionAt(double)` method to set this property. [Api set: ExcelApi 1.8]
/// Specifies if Excel plots data points from last to first. [Api set: ExcelApi 1.7]
/// Specifies the value axis scale type. See `Excel.ChartAxisScaleType` for details. [Api set: ExcelApi 1.7]
/// Specifies if the axis display unit label is visible. [Api set: ExcelApi 1.7]
/// 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. [Api set: ExcelApi 1.8]
/// Specifies the position of tick-mark labels on the specified axis. See `Excel.ChartAxisTickLabelPosition` for details. [Api set: ExcelApi 1.7]
/// Specifies the number of categories or series between tick-mark labels. Can be a value from 1 through 31999 or an empty string for automatic setting. The returned value is always a number. [Api set: ExcelApi 1.7]
/// Specifies the number of categories or series between tick marks. [Api set: ExcelApi 1.7]
/// Represents the axis title. [Api set: ExcelApi 1.1]
/// 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. [Api set: ExcelApi 1.7]
/// Specifies the axis type. See `Excel.ChartAxisType` for details. [Api set: ExcelApi 1.7]
/// Specifies if the axis is visible. [Api set: ExcelApi 1.7]
/// Specifies the width, in points, of the chart axis. Returns `null` if the axis is not visible. [Api set: ExcelApi 1.7]
}
ChartAxis.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartAxis.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartAxisUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartAxis object, with properties that have already been loaded and synced.
///
}
ChartAxis.prototype.setCategoryNames = function(sourceData) {
///
/// Sets all the category names for the specified axis. [Api set: ExcelApi 1.7]
///
/// The `Range` object corresponding to the source data.
///
}
ChartAxis.prototype.setCustomDisplayUnit = function(value) {
///
/// Sets the axis display unit to a custom value. [Api set: ExcelApi 1.7]
///
/// Custom value of the display unit.
///
}
ChartAxis.prototype.setPositionAt = function(value) {
///
/// Sets the specified axis position where the other axis crosses. [Api set: ExcelApi 1.8]
///
/// Custom value of the crossing point.
///
}
return ChartAxis;
})(OfficeExtension.ClientObject);
Excel.ChartAxis = ChartAxis;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Specifies the type of the category axis. [Api set: ExcelApi 1.7]
var ChartAxisCategoryType = {
__proto__: null,
"automatic": "automatic",
"textAxis": "textAxis",
"dateAxis": "dateAxis",
}
Excel.ChartAxisCategoryType = ChartAxisCategoryType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.7]
var ChartAxisDisplayUnit = {
__proto__: null,
"none": "none",
"hundreds": "hundreds",
"thousands": "thousands",
"tenThousands": "tenThousands",
"hundredThousands": "hundredThousands",
"millions": "millions",
"tenMillions": "tenMillions",
"hundredMillions": "hundredMillions",
"billions": "billions",
"trillions": "trillions",
"custom": "custom",
}
Excel.ChartAxisDisplayUnit = ChartAxisDisplayUnit;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartAxisFormat = (function(_super) {
__extends(ChartAxisFormat, _super);
function ChartAxisFormat() {
/// Encapsulates the format properties for the chart axis. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies chart fill formatting. [Api set: ExcelApi 1.8]
/// Specifies the font attributes (font name, font size, color, etc.) for a chart axis element. [Api set: ExcelApi 1.1]
/// Specifies chart line formatting. [Api set: ExcelApi 1.1]
}
ChartAxisFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartAxisFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartAxisFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartAxisFormat object, with properties that have already been loaded and synced.
///
}
return ChartAxisFormat;
})(OfficeExtension.ClientObject);
Excel.ChartAxisFormat = ChartAxisFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.7]
var ChartAxisGroup = {
__proto__: null,
"primary": "primary",
"secondary": "secondary",
}
Excel.ChartAxisGroup = ChartAxisGroup;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.7]
var ChartAxisPosition = {
__proto__: null,
"automatic": "automatic",
"maximum": "maximum",
"minimum": "minimum",
"custom": "custom",
}
Excel.ChartAxisPosition = ChartAxisPosition;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.7]
var ChartAxisScaleType = {
__proto__: null,
"linear": "linear",
"logarithmic": "logarithmic",
}
Excel.ChartAxisScaleType = ChartAxisScaleType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.7]
var ChartAxisTickLabelPosition = {
__proto__: null,
"nextToAxis": "nextToAxis",
"high": "high",
"low": "low",
"none": "none",
}
Excel.ChartAxisTickLabelPosition = ChartAxisTickLabelPosition;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.7]
var ChartAxisTickMark = {
__proto__: null,
"none": "none",
"cross": "cross",
"inside": "inside",
"outside": "outside",
}
Excel.ChartAxisTickMark = ChartAxisTickMark;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Specifies the unit of time for chart axes and data series. [Api set: ExcelApi 1.7]
var ChartAxisTimeUnit = {
__proto__: null,
"days": "days",
"months": "months",
"years": "years",
}
Excel.ChartAxisTimeUnit = ChartAxisTimeUnit;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartAxisTitle = (function(_super) {
__extends(ChartAxisTitle, _super);
function ChartAxisTitle() {
/// Represents the title of a chart axis. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies the formatting of the chart axis title. [Api set: ExcelApi 1.1]
/// Specifies the axis title. [Api set: ExcelApi 1.1]
/// 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. [Api set: ExcelApi 1.12]
/// Specifies if the axis title is visibile. [Api set: ExcelApi 1.1]
}
ChartAxisTitle.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartAxisTitle.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartAxisTitleUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartAxisTitle object, with properties that have already been loaded and synced.
///
}
ChartAxisTitle.prototype.setFormula = function(formula) {
///
/// A string value that represents the formula of chart axis title using A1-style notation. [Api set: ExcelApi 1.8]
///
/// A string that represents the formula to set.
///
}
return ChartAxisTitle;
})(OfficeExtension.ClientObject);
Excel.ChartAxisTitle = ChartAxisTitle;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartAxisTitleFormat = (function(_super) {
__extends(ChartAxisTitleFormat, _super);
function ChartAxisTitleFormat() {
/// Represents the chart axis title formatting. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies the chart axis title's border format, which includes color, linestyle, and weight. [Api set: ExcelApi 1.8]
/// Specifies the chart axis title's fill formatting. [Api set: ExcelApi 1.8]
/// Specifies the chart axis title's font attributes, such as font name, font size, or color, of the chart axis title object. [Api set: ExcelApi 1.1]
}
ChartAxisTitleFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartAxisTitleFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartAxisTitleFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartAxisTitleFormat object, with properties that have already been loaded and synced.
///
}
return ChartAxisTitleFormat;
})(OfficeExtension.ClientObject);
Excel.ChartAxisTitleFormat = ChartAxisTitleFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.7]
var ChartAxisType = {
__proto__: null,
"invalid": "invalid",
"category": "category",
"value": "value",
"series": "series",
}
Excel.ChartAxisType = ChartAxisType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartBinOptions = (function(_super) {
__extends(ChartBinOptions, _super);
function ChartBinOptions() {
/// Encapsulates the bin options for histogram charts and pareto charts. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies if bin overflow is enabled in a histogram chart or pareto chart. [Api set: ExcelApi 1.9]
/// Specifies if bin underflow is enabled in a histogram chart or pareto chart. [Api set: ExcelApi 1.9]
/// Specifies the bin count of a histogram chart or pareto chart. [Api set: ExcelApi 1.9]
/// Specifies the bin overflow value of a histogram chart or pareto chart. [Api set: ExcelApi 1.9]
/// Specifies the bin's type for a histogram chart or pareto chart. [Api set: ExcelApi 1.9]
/// Specifies the bin underflow value of a histogram chart or pareto chart. [Api set: ExcelApi 1.9]
/// Specifies the bin width value of a histogram chart or pareto chart. [Api set: ExcelApi 1.9]
}
ChartBinOptions.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartBinOptions.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartBinOptionsUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartBinOptions object, with properties that have already been loaded and synced.
///
}
return ChartBinOptions;
})(OfficeExtension.ClientObject);
Excel.ChartBinOptions = ChartBinOptions;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Specifies the bin type of a histogram chart or pareto chart series. [Api set: ExcelApi 1.9]
var ChartBinType = {
__proto__: null,
"category": "category",
"auto": "auto",
"binWidth": "binWidth",
"binCount": "binCount",
}
Excel.ChartBinType = ChartBinType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartBorder = (function(_super) {
__extends(ChartBorder, _super);
function ChartBorder() {
/// Represents the border formatting of a chart element. [Api set: ExcelApi 1.7]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// HTML color code representing the color of borders in the chart. [Api set: ExcelApi 1.7]
/// Represents the line style of the border. See `Excel.ChartLineStyle` for details. [Api set: ExcelApi 1.7]
/// Represents weight of the border, in points. [Api set: ExcelApi 1.7]
}
ChartBorder.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartBorder.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartBorderUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartBorder object, with properties that have already been loaded and synced.
///
}
ChartBorder.prototype.clear = function() {
///
/// Clear the border format of a chart element. [Api set: ExcelApi 1.8]
///
///
}
return ChartBorder;
})(OfficeExtension.ClientObject);
Excel.ChartBorder = ChartBorder;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the quartile calculation type of chart series layout. Only applies to a box and whisker chart. [Api set: ExcelApi 1.9]
var ChartBoxQuartileCalculation = {
__proto__: null,
"inclusive": "inclusive",
"exclusive": "exclusive",
}
Excel.ChartBoxQuartileCalculation = ChartBoxQuartileCalculation;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartBoxwhiskerOptions = (function(_super) {
__extends(ChartBoxwhiskerOptions, _super);
function ChartBoxwhiskerOptions() {
/// Represents the properties of a box and whisker chart. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies if the quartile calculation type of a box and whisker chart. [Api set: ExcelApi 1.9]
/// Specifies if inner points are shown in a box and whisker chart. [Api set: ExcelApi 1.9]
/// Specifies if the mean line is shown in a box and whisker chart. [Api set: ExcelApi 1.9]
/// Specifies if the mean marker is shown in a box and whisker chart. [Api set: ExcelApi 1.9]
/// Specifies if outlier points are shown in a box and whisker chart. [Api set: ExcelApi 1.9]
}
ChartBoxwhiskerOptions.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartBoxwhiskerOptions.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartBoxwhiskerOptionsUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartBoxwhiskerOptions object, with properties that have already been loaded and synced.
///
}
return ChartBoxwhiskerOptions;
})(OfficeExtension.ClientObject);
Excel.ChartBoxwhiskerOptions = ChartBoxwhiskerOptions;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartCollection = (function(_super) {
__extends(ChartCollection, _super);
function ChartCollection() {
/// A collection of all the chart objects on a worksheet. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Returns the number of charts in the worksheet. [Api set: ExcelApi 1.1]
/// Occurs when a chart is activated. [Api set: ExcelApi 1.8]
/// Occurs when a new chart is added to the worksheet. [Api set: ExcelApi 1.8]
/// Occurs when a chart is deactivated. [Api set: ExcelApi 1.8]
/// Occurs when a chart is deleted. [Api set: ExcelApi 1.8]
/// Gets the loaded child items in this collection.
}
ChartCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartCollection.prototype.add = function(type, sourceData, seriesBy) {
///
/// Creates a new chart. [Api set: ExcelApi 1.1]
///
/// Represents the type of a chart. See `Excel.ChartType` for details.
/// The `Range` object corresponding to the source data.
/// Optional. Specifies the way columns or rows are used as data series on the chart. See `Excel.ChartSeriesBy` for details.
///
}
ChartCollection.prototype.getCount = function() {
///
/// Returns the number of charts in the worksheet. [Api set: ExcelApi 1.4]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
ChartCollection.prototype.getItem = function(name) {
///
/// Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned. [Api set: ExcelApi 1.1]
///
/// Name of the chart to be retrieved.
///
}
ChartCollection.prototype.getItemAt = function(index) {
///
/// Gets a chart based on its position in the collection. [Api set: ExcelApi 1.1]
///
/// Index value of the object to be retrieved. Zero-indexed.
///
}
ChartCollection.prototype.getItemOrNullObject = function(name) {
///
/// 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 function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.4]
///
/// Name of the chart to be retrieved.
///
}
ChartCollection.prototype.onActivated = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the chart that raised the activated event.
///
var eventInfo = new Excel.Interfaces.ChartActivatedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
ChartCollection.prototype.onAdded = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the chart that raised the added event.
///
var eventInfo = new Excel.Interfaces.ChartAddedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
ChartCollection.prototype.onDeactivated = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the chart that raised the deactivated event.
///
var eventInfo = new Excel.Interfaces.ChartDeactivatedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
ChartCollection.prototype.onDeleted = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the chart that raised the deleted event.
///
var eventInfo = new Excel.Interfaces.ChartDeletedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
return ChartCollection;
})(OfficeExtension.ClientObject);
Excel.ChartCollection = ChartCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.8]
var ChartColorScheme = {
__proto__: null,
"colorfulPalette1": "colorfulPalette1",
"colorfulPalette2": "colorfulPalette2",
"colorfulPalette3": "colorfulPalette3",
"colorfulPalette4": "colorfulPalette4",
"monochromaticPalette1": "monochromaticPalette1",
"monochromaticPalette2": "monochromaticPalette2",
"monochromaticPalette3": "monochromaticPalette3",
"monochromaticPalette4": "monochromaticPalette4",
"monochromaticPalette5": "monochromaticPalette5",
"monochromaticPalette6": "monochromaticPalette6",
"monochromaticPalette7": "monochromaticPalette7",
"monochromaticPalette8": "monochromaticPalette8",
"monochromaticPalette9": "monochromaticPalette9",
"monochromaticPalette10": "monochromaticPalette10",
"monochromaticPalette11": "monochromaticPalette11",
"monochromaticPalette12": "monochromaticPalette12",
"monochromaticPalette13": "monochromaticPalette13",
}
Excel.ChartColorScheme = ChartColorScheme;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartDataLabel = (function(_super) {
__extends(ChartDataLabel, _super);
function ChartDataLabel() {
/// Represents the data label of a chart point. [Api set: ExcelApi 1.7]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies if the data label automatically generates appropriate text based on context. [Api set: ExcelApi 1.8]
/// Represents the format of chart data label. [Api set: ExcelApi 1.8]
/// String value that represents the formula of chart data label using A1-style notation. [Api set: ExcelApi 1.8]
/// Returns the height, in points, of the chart data label. Value is `null` if the chart data label is not visible. [Api set: ExcelApi 1.8]
/// Represents the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details. This property is valid only when `TextOrientation` of data label is -90, 90, or 180. [Api set: ExcelApi 1.8]
/// 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. [Api set: ExcelApi 1.8]
/// 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). [Api set: ExcelApi 1.9]
/// String value that represents the format code for data label. [Api set: ExcelApi 1.8]
/// Value that represents the position of the data label. See `Excel.ChartDataLabelPosition` for details. [Api set: ExcelApi 1.7]
/// String representing the separator used for the data label on a chart. [Api set: ExcelApi 1.7]
/// Specifies if the data label bubble size is visible. [Api set: ExcelApi 1.7]
/// Specifies if the data label category name is visible. [Api set: ExcelApi 1.7]
/// Specifies if the data label legend key is visible. [Api set: ExcelApi 1.7]
/// Specifies if the data label percentage is visible. [Api set: ExcelApi 1.7]
/// Specifies if the data label series name is visible. [Api set: ExcelApi 1.7]
/// Specifies if the data label value is visible. [Api set: ExcelApi 1.7]
/// String representing the text of the data label on a chart. [Api set: ExcelApi 1.8]
/// 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. [Api set: ExcelApi 1.8]
/// 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. [Api set: ExcelApi 1.8]
/// Represents the vertical alignment of chart data label. See `Excel.ChartTextVerticalAlignment` for details. This property is valid only when `TextOrientation` of data label is 0. [Api set: ExcelApi 1.8]
/// Returns the width, in points, of the chart data label. Value is `null` if the chart data label is not visible. [Api set: ExcelApi 1.8]
}
ChartDataLabel.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartDataLabel.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartDataLabelUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartDataLabel object, with properties that have already been loaded and synced.
///
}
return ChartDataLabel;
})(OfficeExtension.ClientObject);
Excel.ChartDataLabel = ChartDataLabel;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartDataLabelFormat = (function(_super) {
__extends(ChartDataLabelFormat, _super);
function ChartDataLabelFormat() {
/// Encapsulates the format properties for the chart data labels. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the border format, which includes color, linestyle, and weight. [Api set: ExcelApi 1.8]
/// Represents the fill format of the current chart data label. [Api set: ExcelApi 1.1]
/// Represents the font attributes (such as font name, font size, and color) for a chart data label. [Api set: ExcelApi 1.1]
}
ChartDataLabelFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartDataLabelFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartDataLabelFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartDataLabelFormat object, with properties that have already been loaded and synced.
///
}
return ChartDataLabelFormat;
})(OfficeExtension.ClientObject);
Excel.ChartDataLabelFormat = ChartDataLabelFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.1]
var ChartDataLabelPosition = {
__proto__: null,
"invalid": "invalid",
"none": "none",
"center": "center",
"insideEnd": "insideEnd",
"insideBase": "insideBase",
"outsideEnd": "outsideEnd",
"left": "left",
"right": "right",
"top": "top",
"bottom": "bottom",
"bestFit": "bestFit",
"callout": "callout",
}
Excel.ChartDataLabelPosition = ChartDataLabelPosition;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartDataLabels = (function(_super) {
__extends(ChartDataLabels, _super);
function ChartDataLabels() {
/// Represents a collection of all the data labels on a chart point. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies if data labels automatically generate appropriate text based on context. [Api set: ExcelApi 1.8]
/// Specifies the format of chart data labels, which includes fill and font formatting. [Api set: ExcelApi 1.1]
/// Specifies the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details. This property is valid only when the `TextOrientation` of data label is 0. [Api set: ExcelApi 1.8]
/// 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. [Api set: ExcelApi 1.9]
/// Specifies the format code for data labels. [Api set: ExcelApi 1.8]
/// Value that represents the position of the data label. See `Excel.ChartDataLabelPosition` for details. [Api set: ExcelApi 1.1]
/// String representing the separator used for the data labels on a chart. [Api set: ExcelApi 1.1]
/// Specifies if the data label bubble size is visible. [Api set: ExcelApi 1.1]
/// Specifies if the data label category name is visible. [Api set: ExcelApi 1.1]
/// Specifies if the data label legend key is visible. [Api set: ExcelApi 1.1]
/// Specifies if the data label percentage is visible. [Api set: ExcelApi 1.1]
/// Specifies if the data label series name is visible. [Api set: ExcelApi 1.1]
/// Specifies if the data label value is visible. [Api set: ExcelApi 1.1]
/// 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. [Api set: ExcelApi 1.8]
/// Represents the vertical alignment of chart data label. See `Excel.ChartTextVerticalAlignment` for details. This property is valid only when `TextOrientation` of the data label is -90, 90, or 180. [Api set: ExcelApi 1.8]
}
ChartDataLabels.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartDataLabels.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartDataLabelsUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartDataLabels object, with properties that have already been loaded and synced.
///
}
return ChartDataLabels;
})(OfficeExtension.ClientObject);
Excel.ChartDataLabels = ChartDataLabels;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartDataTable = (function(_super) {
__extends(ChartDataTable, _super);
function ChartDataTable() {
/// Represents the data table object of a chart. [Api set: ExcelApi 1.14]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the format of a chart data table, which includes fill, font, and border format. [Api set: ExcelApi 1.14]
/// Specifies whether to display the horizontal border of the data table. [Api set: ExcelApi 1.14]
/// Specifies whether to show the legend key of the data table. [Api set: ExcelApi 1.14]
/// Specifies whether to display the outline border of the data table. [Api set: ExcelApi 1.14]
/// Specifies whether to display the vertical border of the data table. [Api set: ExcelApi 1.14]
/// Specifies whether to show the data table of the chart. [Api set: ExcelApi 1.14]
}
ChartDataTable.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartDataTable.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartDataTableUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartDataTable object, with properties that have already been loaded and synced.
///
}
return ChartDataTable;
})(OfficeExtension.ClientObject);
Excel.ChartDataTable = ChartDataTable;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartDataTableFormat = (function(_super) {
__extends(ChartDataTableFormat, _super);
function ChartDataTableFormat() {
/// Represents the format of a chart data table. [Api set: ExcelApi 1.14]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the border format of chart data table, which includes color, line style, and weight. [Api set: ExcelApi 1.14]
/// Represents the fill format of an object, which includes background formatting information. [Api set: ExcelApi 1.14]
/// Represents the font attributes (such as font name, font size, and color) for the current object. [Api set: ExcelApi 1.14]
}
ChartDataTableFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartDataTableFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartDataTableFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartDataTableFormat object, with properties that have already been loaded and synced.
///
}
return ChartDataTableFormat;
})(OfficeExtension.ClientObject);
Excel.ChartDataTableFormat = ChartDataTableFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartDeactivatedEventArgs = (function() {
function ChartDeactivatedEventArgs() {
/// Provides information about the chart that raised the deactivated event. [Api set: ExcelApi 1.8]
/// Gets the ID of the chart that is deactivated. [Api set: ExcelApi 1.8]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.8]
/// Gets the ID of the worksheet in which the chart is deactivated. [Api set: ExcelApi 1.8]
}
return ChartDeactivatedEventArgs;
})();
Interfaces.ChartDeactivatedEventArgs.__proto__ = null;
Interfaces.ChartDeactivatedEventArgs = ChartDeactivatedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartDeletedEventArgs = (function() {
function ChartDeletedEventArgs() {
/// Provides information about the chart that raised the deleted event. [Api set: ExcelApi 1.8]
/// Gets the ID of the chart that is deleted from the worksheet. [Api set: ExcelApi 1.8]
/// Gets the source of the event. See `Excel.EventSource` for details. [Api set: ExcelApi 1.8]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.8]
/// Gets the ID of the worksheet in which the chart is deleted. [Api set: ExcelApi 1.8]
}
return ChartDeletedEventArgs;
})();
Interfaces.ChartDeletedEventArgs.__proto__ = null;
Interfaces.ChartDeletedEventArgs = ChartDeletedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.8]
var ChartDisplayBlanksAs = {
__proto__: null,
"notPlotted": "notPlotted",
"zero": "zero",
"interplotted": "interplotted",
}
Excel.ChartDisplayBlanksAs = ChartDisplayBlanksAs;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartErrorBars = (function(_super) {
__extends(ChartErrorBars, _super);
function ChartErrorBars() {
/// This object represents the attributes for a chart's error bars. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies if error bars have an end style cap. [Api set: ExcelApi 1.9]
/// Specifies the formatting type of the error bars. [Api set: ExcelApi 1.9]
/// Specifies which parts of the error bars to include. [Api set: ExcelApi 1.9]
/// The type of range marked by the error bars. [Api set: ExcelApi 1.9]
/// Specifies whether the error bars are displayed. [Api set: ExcelApi 1.9]
}
ChartErrorBars.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartErrorBars.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartErrorBarsUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartErrorBars object, with properties that have already been loaded and synced.
///
}
return ChartErrorBars;
})(OfficeExtension.ClientObject);
Excel.ChartErrorBars = ChartErrorBars;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartErrorBarsFormat = (function(_super) {
__extends(ChartErrorBarsFormat, _super);
function ChartErrorBarsFormat() {
/// Encapsulates the format properties for chart error bars. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the chart line formatting. [Api set: ExcelApi 1.9]
}
ChartErrorBarsFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartErrorBarsFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartErrorBarsFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartErrorBarsFormat object, with properties that have already been loaded and synced.
///
}
return ChartErrorBarsFormat;
})(OfficeExtension.ClientObject);
Excel.ChartErrorBarsFormat = ChartErrorBarsFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents which parts of the error bar to include. [Api set: ExcelApi 1.9]
var ChartErrorBarsInclude = {
__proto__: null,
"both": "both",
"minusValues": "minusValues",
"plusValues": "plusValues",
}
Excel.ChartErrorBarsInclude = ChartErrorBarsInclude;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the range type for error bars. [Api set: ExcelApi 1.9]
var ChartErrorBarsType = {
__proto__: null,
"fixedValue": "fixedValue",
"percent": "percent",
"stDev": "stDev",
"stError": "stError",
"custom": "custom",
}
Excel.ChartErrorBarsType = ChartErrorBarsType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartFill = (function(_super) {
__extends(ChartFill, _super);
function ChartFill() {
/// Represents the fill formatting for a chart element. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
}
ChartFill.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartFill.prototype.clear = function() {
///
/// Clears the fill color of a chart element. [Api set: ExcelApi 1.1]
///
///
}
ChartFill.prototype.setSolidColor = function(color) {
///
/// Sets the fill formatting of a chart element to a uniform color. [Api set: ExcelApi 1.1]
///
/// 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").
///
}
return ChartFill;
})(OfficeExtension.ClientObject);
Excel.ChartFill = ChartFill;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartFont = (function(_super) {
__extends(ChartFont, _super);
function ChartFont() {
/// This object represents the font attributes (such as font name, font size, and color) for a chart object. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the bold status of font. [Api set: ExcelApi 1.1]
/// HTML color code representation of the text color (e.g., #FF0000 represents Red). [Api set: ExcelApi 1.1]
/// Represents the italic status of the font. [Api set: ExcelApi 1.1]
/// Font name (e.g., "Calibri") [Api set: ExcelApi 1.1]
/// Size of the font (e.g., 11) [Api set: ExcelApi 1.1]
/// Type of underline applied to the font. See `Excel.ChartUnderlineStyle` for details. [Api set: ExcelApi 1.1]
}
ChartFont.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartFont.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartFontUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartFont object, with properties that have already been loaded and synced.
///
}
return ChartFont;
})(OfficeExtension.ClientObject);
Excel.ChartFont = ChartFont;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartFormatString = (function(_super) {
__extends(ChartFormatString, _super);
function ChartFormatString() {
/// Represents the substring in chart related objects that contain text, like a `ChartTitle` object or `ChartAxisTitle` object. [Api set: ExcelApi 1.7]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the font attributes, such as font name, font size, and color of a chart characters object. [Api set: ExcelApi 1.7]
}
ChartFormatString.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartFormatString.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartFormatStringUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartFormatString object, with properties that have already been loaded and synced.
///
}
return ChartFormatString;
})(OfficeExtension.ClientObject);
Excel.ChartFormatString = ChartFormatString;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the gradient style of a chart series. This is only applicable for region map charts. [Api set: ExcelApi 1.9]
var ChartGradientStyle = {
__proto__: null,
"twoPhaseColor": "twoPhaseColor",
"threePhaseColor": "threePhaseColor",
}
Excel.ChartGradientStyle = ChartGradientStyle;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the gradient style type of a chart series. This is only applicable for region map charts. [Api set: ExcelApi 1.9]
var ChartGradientStyleType = {
__proto__: null,
"extremeValue": "extremeValue",
"number": "number",
"percent": "percent",
}
Excel.ChartGradientStyleType = ChartGradientStyleType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartGridlines = (function(_super) {
__extends(ChartGridlines, _super);
function ChartGridlines() {
/// Represents major or minor gridlines on a chart axis. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the formatting of chart gridlines. [Api set: ExcelApi 1.1]
/// Specifies if the axis gridlines are visible. [Api set: ExcelApi 1.1]
}
ChartGridlines.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartGridlines.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartGridlinesUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartGridlines object, with properties that have already been loaded and synced.
///
}
return ChartGridlines;
})(OfficeExtension.ClientObject);
Excel.ChartGridlines = ChartGridlines;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartGridlinesFormat = (function(_super) {
__extends(ChartGridlinesFormat, _super);
function ChartGridlinesFormat() {
/// Encapsulates the format properties for chart gridlines. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents chart line formatting. [Api set: ExcelApi 1.1]
}
ChartGridlinesFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartGridlinesFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartGridlinesFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartGridlinesFormat object, with properties that have already been loaded and synced.
///
}
return ChartGridlinesFormat;
})(OfficeExtension.ClientObject);
Excel.ChartGridlinesFormat = ChartGridlinesFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartLegend = (function(_super) {
__extends(ChartLegend, _super);
function ChartLegend() {
/// Represents the legend in a chart. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the formatting of a chart legend, which includes fill and font formatting. [Api set: ExcelApi 1.1]
/// Specifies the height, in points, of the legend on the chart. Value is `null` if the legend is not visible. [Api set: ExcelApi 1.7]
/// Specifies the left value, in points, of the legend on the chart. Value is `null` if the legend is not visible. [Api set: ExcelApi 1.7]
/// Represents a collection of legendEntries in the legend. [Api set: ExcelApi 1.7]
/// Specifies if the chart legend should overlap with the main body of the chart. [Api set: ExcelApi 1.1]
/// Specifies the position of the legend on the chart. See `Excel.ChartLegendPosition` for details. [Api set: ExcelApi 1.1]
/// Specifies if the legend has a shadow on the chart. [Api set: ExcelApi 1.7]
/// Specifies the top of a chart legend. [Api set: ExcelApi 1.7]
/// Specifies if the chart legend is visible. [Api set: ExcelApi 1.1]
/// Specifies the width, in points, of the legend on the chart. Value is `null` if the legend is not visible. [Api set: ExcelApi 1.7]
}
ChartLegend.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartLegend.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartLegendUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartLegend object, with properties that have already been loaded and synced.
///
}
return ChartLegend;
})(OfficeExtension.ClientObject);
Excel.ChartLegend = ChartLegend;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartLegendEntry = (function(_super) {
__extends(ChartLegendEntry, _super);
function ChartLegendEntry() {
/// Represents the legend entry in `legendEntryCollection`. [Api set: ExcelApi 1.7]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies the height of the legend entry on the chart legend. [Api set: ExcelApi 1.8]
/// Specifies the index of the legend entry in the chart legend. [Api set: ExcelApi 1.8]
/// Specifies the left value of a chart legend entry. [Api set: ExcelApi 1.8]
/// Specifies the top of a chart legend entry. [Api set: ExcelApi 1.8]
/// Represents the visibility of a chart legend entry. [Api set: ExcelApi 1.7]
/// Represents the width of the legend entry on the chart Legend. [Api set: ExcelApi 1.8]
}
ChartLegendEntry.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartLegendEntry.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartLegendEntryUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartLegendEntry object, with properties that have already been loaded and synced.
///
}
return ChartLegendEntry;
})(OfficeExtension.ClientObject);
Excel.ChartLegendEntry = ChartLegendEntry;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartLegendEntryCollection = (function(_super) {
__extends(ChartLegendEntryCollection, _super);
function ChartLegendEntryCollection() {
/// Represents a collection of legend entries. [Api set: ExcelApi 1.7]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
ChartLegendEntryCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartLegendEntryCollection.prototype.getCount = function() {
///
/// Returns the number of legend entries in the collection. [Api set: ExcelApi 1.7]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
ChartLegendEntryCollection.prototype.getItemAt = function(index) {
///
/// Returns a legend entry at the given index. [Api set: ExcelApi 1.7]
///
/// Index of the legend entry to be retrieved.
///
}
return ChartLegendEntryCollection;
})(OfficeExtension.ClientObject);
Excel.ChartLegendEntryCollection = ChartLegendEntryCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartLegendFormat = (function(_super) {
__extends(ChartLegendFormat, _super);
function ChartLegendFormat() {
/// Encapsulates the format properties of a chart legend. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the border format, which includes color, linestyle, and weight. [Api set: ExcelApi 1.8]
/// Represents the fill format of an object, which includes background formatting information. [Api set: ExcelApi 1.1]
/// Represents the font attributes such as font name, font size, and color of a chart legend. [Api set: ExcelApi 1.1]
}
ChartLegendFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartLegendFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartLegendFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartLegendFormat object, with properties that have already been loaded and synced.
///
}
return ChartLegendFormat;
})(OfficeExtension.ClientObject);
Excel.ChartLegendFormat = ChartLegendFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.1]
var ChartLegendPosition = {
__proto__: null,
"invalid": "invalid",
"top": "top",
"bottom": "bottom",
"left": "left",
"right": "right",
"corner": "corner",
"custom": "custom",
}
Excel.ChartLegendPosition = ChartLegendPosition;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartLineFormat = (function(_super) {
__extends(ChartLineFormat, _super);
function ChartLineFormat() {
/// Encapsulates the formatting options for line elements. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// HTML color code representing the color of lines in the chart. [Api set: ExcelApi 1.1]
/// Represents the line style. See `Excel.ChartLineStyle` for details. [Api set: ExcelApi 1.7]
/// Represents weight of the line, in points. [Api set: ExcelApi 1.7]
}
ChartLineFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartLineFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartLineFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartLineFormat object, with properties that have already been loaded and synced.
///
}
ChartLineFormat.prototype.clear = function() {
///
/// Clears the line format of a chart element. [Api set: ExcelApi 1.1]
///
///
}
return ChartLineFormat;
})(OfficeExtension.ClientObject);
Excel.ChartLineFormat = ChartLineFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.7]
var ChartLineStyle = {
__proto__: null,
"none": "none",
"continuous": "continuous",
"dash": "dash",
"dashDot": "dashDot",
"dashDotDot": "dashDotDot",
"dot": "dot",
"grey25": "grey25",
"grey50": "grey50",
"grey75": "grey75",
"automatic": "automatic",
"roundDot": "roundDot",
}
Excel.ChartLineStyle = ChartLineStyle;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the mapping level of a chart series. This only applies to region map charts. [Api set: ExcelApi 1.9]
var ChartMapAreaLevel = {
__proto__: null,
"automatic": "automatic",
"dataOnly": "dataOnly",
"city": "city",
"county": "county",
"state": "state",
"country": "country",
"continent": "continent",
"world": "world",
}
Excel.ChartMapAreaLevel = ChartMapAreaLevel;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the region level of a chart series layout. This only applies to region map charts. [Api set: ExcelApi 1.9]
var ChartMapLabelStrategy = {
__proto__: null,
"none": "none",
"bestFit": "bestFit",
"showAll": "showAll",
}
Excel.ChartMapLabelStrategy = ChartMapLabelStrategy;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartMapOptions = (function(_super) {
__extends(ChartMapOptions, _super);
function ChartMapOptions() {
/// Encapsulates the properties for a region map chart. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies the series map labels strategy of a region map chart. [Api set: ExcelApi 1.9]
/// Specifies the series mapping level of a region map chart. [Api set: ExcelApi 1.9]
/// Specifies the series projection type of a region map chart. [Api set: ExcelApi 1.9]
}
ChartMapOptions.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartMapOptions.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartMapOptionsUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartMapOptions object, with properties that have already been loaded and synced.
///
}
return ChartMapOptions;
})(OfficeExtension.ClientObject);
Excel.ChartMapOptions = ChartMapOptions;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the region projection type of a chart series layout. This only applies to region map charts. [Api set: ExcelApi 1.9]
var ChartMapProjectionType = {
__proto__: null,
"automatic": "automatic",
"mercator": "mercator",
"miller": "miller",
"robinson": "robinson",
"albers": "albers",
}
Excel.ChartMapProjectionType = ChartMapProjectionType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.7]
var ChartMarkerStyle = {
__proto__: null,
"invalid": "invalid",
"automatic": "automatic",
"none": "none",
"square": "square",
"diamond": "diamond",
"triangle": "triangle",
"x": "x",
"star": "star",
"dot": "dot",
"dash": "dash",
"circle": "circle",
"plus": "plus",
"picture": "picture",
}
Excel.ChartMarkerStyle = ChartMarkerStyle;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the parent label strategy of the chart series layout. This only applies to treemap charts [Api set: ExcelApi 1.9]
var ChartParentLabelStrategy = {
__proto__: null,
"none": "none",
"banner": "banner",
"overlapping": "overlapping",
}
Excel.ChartParentLabelStrategy = ChartParentLabelStrategy;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartPivotOptions = (function(_super) {
__extends(ChartPivotOptions, _super);
function ChartPivotOptions() {
/// Encapsulates the options for the pivot chart. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// 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. [Api set: ExcelApi 1.9]
/// Specifies whether to display the legend field buttons on a PivotChart. [Api set: ExcelApi 1.9]
/// Specifies whether to display the report filter field buttons on a PivotChart. [Api set: ExcelApi 1.9]
/// Specifies whether to display the show value field buttons on a PivotChart. [Api set: ExcelApi 1.9]
}
ChartPivotOptions.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartPivotOptions.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartPivotOptionsUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartPivotOptions object, with properties that have already been loaded and synced.
///
}
return ChartPivotOptions;
})(OfficeExtension.ClientObject);
Excel.ChartPivotOptions = ChartPivotOptions;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartPlotArea = (function(_super) {
__extends(ChartPlotArea, _super);
function ChartPlotArea() {
/// This object represents the attributes for a chart plot area. [Api set: ExcelApi 1.8]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies the formatting of a chart plot area. [Api set: ExcelApi 1.8]
/// Specifies the height value of a plot area. [Api set: ExcelApi 1.8]
/// Specifies the inside height value of a plot area. [Api set: ExcelApi 1.8]
/// Specifies the inside left value of a plot area. [Api set: ExcelApi 1.8]
/// Specifies the inside top value of a plot area. [Api set: ExcelApi 1.8]
/// Specifies the inside width value of a plot area. [Api set: ExcelApi 1.8]
/// Specifies the left value of a plot area. [Api set: ExcelApi 1.8]
/// Specifies the position of a plot area. [Api set: ExcelApi 1.8]
/// Specifies the top value of a plot area. [Api set: ExcelApi 1.8]
/// Specifies the width value of a plot area. [Api set: ExcelApi 1.8]
}
ChartPlotArea.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartPlotArea.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartPlotAreaUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartPlotArea object, with properties that have already been loaded and synced.
///
}
return ChartPlotArea;
})(OfficeExtension.ClientObject);
Excel.ChartPlotArea = ChartPlotArea;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartPlotAreaFormat = (function(_super) {
__extends(ChartPlotAreaFormat, _super);
function ChartPlotAreaFormat() {
/// Represents the format properties for a chart plot area. [Api set: ExcelApi 1.8]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies the border attributes of a chart plot area. [Api set: ExcelApi 1.8]
/// Specifies the fill format of an object, which includes background formatting information. [Api set: ExcelApi 1.8]
}
ChartPlotAreaFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartPlotAreaFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartPlotAreaFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartPlotAreaFormat object, with properties that have already been loaded and synced.
///
}
return ChartPlotAreaFormat;
})(OfficeExtension.ClientObject);
Excel.ChartPlotAreaFormat = ChartPlotAreaFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.8]
var ChartPlotAreaPosition = {
__proto__: null,
"automatic": "automatic",
"custom": "custom",
}
Excel.ChartPlotAreaPosition = ChartPlotAreaPosition;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.8]
var ChartPlotBy = {
__proto__: null,
"rows": "rows",
"columns": "columns",
}
Excel.ChartPlotBy = ChartPlotBy;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartPoint = (function(_super) {
__extends(ChartPoint, _super);
function ChartPoint() {
/// Represents a point of a series in a chart. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Returns the data label of a chart point. [Api set: ExcelApi 1.7]
/// Encapsulates the format properties chart point. [Api set: ExcelApi 1.1]
/// Represents whether a data point has a data label. Not applicable for surface charts. [Api set: ExcelApi 1.7]
/// HTML color code representation of the marker background color of a data point (e.g., #FF0000 represents Red). [Api set: ExcelApi 1.7]
/// HTML color code representation of the marker foreground color of a data point (e.g., #FF0000 represents Red). [Api set: ExcelApi 1.7]
/// Represents marker size of a data point. [Api set: ExcelApi 1.7]
/// Represents marker style of a chart data point. See `Excel.ChartMarkerStyle` for details. [Api set: ExcelApi 1.7]
/// Returns the value of a chart point. [Api set: ExcelApi 1.1]
}
ChartPoint.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartPoint.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartPointUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartPoint object, with properties that have already been loaded and synced.
///
}
return ChartPoint;
})(OfficeExtension.ClientObject);
Excel.ChartPoint = ChartPoint;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartPointFormat = (function(_super) {
__extends(ChartPointFormat, _super);
function ChartPointFormat() {
/// Represents the formatting object for chart points. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the border format of a chart data point, which includes color, style, and weight information. [Api set: ExcelApi 1.7]
/// Represents the fill format of a chart, which includes background formatting information. [Api set: ExcelApi 1.1]
}
ChartPointFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartPointFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartPointFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartPointFormat object, with properties that have already been loaded and synced.
///
}
return ChartPointFormat;
})(OfficeExtension.ClientObject);
Excel.ChartPointFormat = ChartPointFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartPointsCollection = (function(_super) {
__extends(ChartPointsCollection, _super);
function ChartPointsCollection() {
/// A collection of all the chart points within a series inside a chart. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Returns the number of chart points in the series. [Api set: ExcelApi 1.1]
/// Gets the loaded child items in this collection.
}
ChartPointsCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartPointsCollection.prototype.getCount = function() {
///
/// Returns the number of chart points in the series. [Api set: ExcelApi 1.4]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
ChartPointsCollection.prototype.getItemAt = function(index) {
///
/// Retrieve a point based on its position within the series. [Api set: ExcelApi 1.1]
///
/// Index value of the object to be retrieved. Zero-indexed.
///
}
return ChartPointsCollection;
})(OfficeExtension.ClientObject);
Excel.ChartPointsCollection = ChartPointsCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartSeries = (function(_super) {
__extends(ChartSeries, _super);
function ChartSeries() {
/// Represents a series in a chart. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies the group for the specified series. [Api set: ExcelApi 1.8]
/// Encapsulates the bin options for histogram charts and pareto charts. [Api set: ExcelApi 1.9]
/// Encapsulates the options for the box and whisker charts. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9]
/// Represents the chart type of a series. See `Excel.ChartType` for details. [Api set: ExcelApi 1.7]
/// Represents a collection of all data labels in the series. [Api set: ExcelApi 1.8]
/// Represents the doughnut hole size of a chart series. Only valid on doughnut and doughnut exploded charts. Throws an `InvalidArgument` error on invalid charts. [Api set: ExcelApi 1.7]
/// 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). [Api set: ExcelApi 1.8]
/// Specifies if the series is filtered. Not applicable for surface charts. [Api set: ExcelApi 1.7]
/// 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. [Api set: ExcelApi 1.8]
/// Represents the formatting of a chart series, which includes fill and line formatting. [Api set: ExcelApi 1.1]
/// 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. [Api set: ExcelApi 1.7]
/// Specifies the color for maximum value of a region map chart series. [Api set: ExcelApi 1.9]
/// Specifies the type for maximum value of a region map chart series. [Api set: ExcelApi 1.9]
/// Specifies the maximum value of a region map chart series. [Api set: ExcelApi 1.9]
/// Specifies the color for the midpoint value of a region map chart series. [Api set: ExcelApi 1.9]
/// Specifies the type for the midpoint value of a region map chart series. [Api set: ExcelApi 1.9]
/// Specifies the midpoint value of a region map chart series. [Api set: ExcelApi 1.9]
/// Specifies the color for the minimum value of a region map chart series. [Api set: ExcelApi 1.9]
/// Specifies the type for the minimum value of a region map chart series. [Api set: ExcelApi 1.9]
/// Specifies the minimum value of a region map chart series. [Api set: ExcelApi 1.9]
/// Specifies the series gradient style of a region map chart. [Api set: ExcelApi 1.9]
/// Specifies if the series has data labels. [Api set: ExcelApi 1.7]
/// Specifies the fill color for negative data points in a series. [Api set: ExcelApi 1.9]
/// True if Excel inverts the pattern in the item when it corresponds to a negative number. [Api set: ExcelApi 1.8]
/// Encapsulates the options for a region map chart. [Api set: ExcelApi 1.9]
/// Specifies the marker background color of a chart series. [Api set: ExcelApi 1.7]
/// Specifies the marker foreground color of a chart series. [Api set: ExcelApi 1.7]
/// Specifies the marker size of a chart series. [Api set: ExcelApi 1.7]
/// Specifies the marker style of a chart series. See `Excel.ChartMarkerStyle` for details. [Api set: ExcelApi 1.7]
/// Specifies the name of a series in a chart. The name's length should not be greater than 255 characters. [Api set: ExcelApi 1.1]
/// 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. [Api set: ExcelApi 1.8]
/// Specifies the series parent label strategy area for a treemap chart. [Api set: ExcelApi 1.9]
/// Specifies the plot order of a chart series within the chart group. [Api set: ExcelApi 1.7]
/// Returns a collection of all points in the series. [Api set: ExcelApi 1.1]
/// 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. [Api set: ExcelApi 1.8]
/// Specifies whether connector lines are shown in waterfall charts. [Api set: ExcelApi 1.9]
/// Specifies whether leader lines are displayed for each data label in the series. [Api set: ExcelApi 1.9]
/// Specifies if the series has a shadow. [Api set: ExcelApi 1.7]
/// Specifies if the series is smooth. Only applicable to line and scatter charts. [Api set: ExcelApi 1.7]
/// Specifies the way the two sections of either a pie-of-pie chart or a bar-of-pie chart are split. [Api set: ExcelApi 1.8]
/// Specifies the threshold value that separates two sections of either a pie-of-pie chart or a bar-of-pie chart. [Api set: ExcelApi 1.9]
/// The collection of trendlines in the series. [Api set: ExcelApi 1.7]
/// True if Excel assigns a different color or pattern to each data marker. The chart must contain only one series. [Api set: ExcelApi 1.8]
/// Represents the error bar object of a chart series. [Api set: ExcelApi 1.9]
/// Represents the error bar object of a chart series. [Api set: ExcelApi 1.9]
}
ChartSeries.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartSeries.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartSeriesUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartSeries object, with properties that have already been loaded and synced.
///
}
ChartSeries.prototype.delete = function() {
///
/// Deletes the chart series. [Api set: ExcelApi 1.7]
///
///
}
ChartSeries.prototype.getDimensionValues = function(dimension) {
///
/// 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. [Api set: ExcelApi 1.12]
///
/// The dimension of the axis where the data is from.
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = [];
return result;
}
ChartSeries.prototype.setBubbleSizes = function(sourceData) {
///
/// Sets the bubble sizes for a chart series. Only works for bubble charts. [Api set: ExcelApi 1.7]
///
/// The `Range` object corresponding to the source data.
///
}
ChartSeries.prototype.setValues = function(sourceData) {
///
/// Sets the values for a chart series. For scatter charts, it refers to y-axis values. [Api set: ExcelApi 1.7]
///
/// The `Range` object corresponding to the source data.
///
}
ChartSeries.prototype.setXAxisValues = function(sourceData) {
///
/// Sets the values of the x-axis for a chart series. Only works for scatter charts. [Api set: ExcelApi 1.7]
///
/// The `Range` object corresponding to the source data.
///
}
return ChartSeries;
})(OfficeExtension.ClientObject);
Excel.ChartSeries = ChartSeries;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// 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". [Api set: ExcelApi 1.1]
var ChartSeriesBy = {
__proto__: null,
"auto": "auto",
"columns": "columns",
"rows": "rows",
}
Excel.ChartSeriesBy = ChartSeriesBy;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartSeriesCollection = (function(_super) {
__extends(ChartSeriesCollection, _super);
function ChartSeriesCollection() {
/// Represents a collection of chart series. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Returns the number of series in the collection. [Api set: ExcelApi 1.1]
/// Gets the loaded child items in this collection.
}
ChartSeriesCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartSeriesCollection.prototype.add = function(name, index) {
///
/// 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). [Api set: ExcelApi 1.7]
///
/// Optional. Name of the series.
/// Optional. Index value of the series to be added. Zero-indexed.
///
}
ChartSeriesCollection.prototype.getCount = function() {
///
/// Returns the number of series in the collection. [Api set: ExcelApi 1.4]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
ChartSeriesCollection.prototype.getItemAt = function(index) {
///
/// Retrieves a series based on its position in the collection. [Api set: ExcelApi 1.1]
///
/// Index value of the object to be retrieved. Zero-indexed.
///
}
return ChartSeriesCollection;
})(OfficeExtension.ClientObject);
Excel.ChartSeriesCollection = ChartSeriesCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the dimensions when getting values from chart series. [Api set: ExcelApi 1.12]
var ChartSeriesDimension = {
__proto__: null,
"categories": "categories",
"values": "values",
"xvalues": "xvalues",
"yvalues": "yvalues",
"bubbleSizes": "bubbleSizes",
}
Excel.ChartSeriesDimension = ChartSeriesDimension;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartSeriesFormat = (function(_super) {
__extends(ChartSeriesFormat, _super);
function ChartSeriesFormat() {
/// Encapsulates the format properties for the chart series [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the fill format of a chart series, which includes background formatting information. [Api set: ExcelApi 1.1]
/// Represents line formatting. [Api set: ExcelApi 1.1]
}
ChartSeriesFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartSeriesFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartSeriesFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartSeriesFormat object, with properties that have already been loaded and synced.
///
}
return ChartSeriesFormat;
})(OfficeExtension.ClientObject);
Excel.ChartSeriesFormat = ChartSeriesFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.8]
var ChartSplitType = {
__proto__: null,
"splitByPosition": "splitByPosition",
"splitByValue": "splitByValue",
"splitByPercentValue": "splitByPercentValue",
"splitByCustomSplit": "splitByCustomSplit",
}
Excel.ChartSplitType = ChartSplitType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the horizontal alignment for the specified object. [Api set: ExcelApi 1.7]
var ChartTextHorizontalAlignment = {
__proto__: null,
"center": "center",
"left": "left",
"right": "right",
"justify": "justify",
"distributed": "distributed",
}
Excel.ChartTextHorizontalAlignment = ChartTextHorizontalAlignment;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the vertical alignment for the specified object. [Api set: ExcelApi 1.7]
var ChartTextVerticalAlignment = {
__proto__: null,
"center": "center",
"bottom": "bottom",
"top": "top",
"justify": "justify",
"distributed": "distributed",
}
Excel.ChartTextVerticalAlignment = ChartTextVerticalAlignment;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.8]
var ChartTickLabelAlignment = {
__proto__: null,
"center": "center",
"left": "left",
"right": "right",
}
Excel.ChartTickLabelAlignment = ChartTickLabelAlignment;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartTitle = (function(_super) {
__extends(ChartTitle, _super);
function ChartTitle() {
/// Represents a chart title object of a chart. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the formatting of a chart title, which includes fill and font formatting. [Api set: ExcelApi 1.1]
/// Returns the height, in points, of the chart title. Value is `null` if the chart title is not visible. [Api set: ExcelApi 1.7]
/// Specifies the horizontal alignment for chart title. [Api set: ExcelApi 1.7]
/// 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. [Api set: ExcelApi 1.7]
/// Specifies if the chart title will overlay the chart. [Api set: ExcelApi 1.1]
/// Represents the position of chart title. See `Excel.ChartTitlePosition` for details. [Api set: ExcelApi 1.7]
/// Represents a boolean value that determines if the chart title has a shadow. [Api set: ExcelApi 1.7]
/// Specifies the chart's title text. [Api set: ExcelApi 1.1]
/// 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. [Api set: ExcelApi 1.7]
/// 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. [Api set: ExcelApi 1.7]
/// Specifies the vertical alignment of chart title. See `Excel.ChartTextVerticalAlignment` for details. [Api set: ExcelApi 1.7]
/// Specifies if the chart title is visibile. [Api set: ExcelApi 1.1]
/// Specifies the width, in points, of the chart title. Value is `null` if the chart title is not visible. [Api set: ExcelApi 1.7]
}
ChartTitle.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartTitle.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartTitleUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartTitle object, with properties that have already been loaded and synced.
///
}
ChartTitle.prototype.getSubstring = function(start, length) {
///
/// Get the substring of a chart title. Line break '\n' counts one character. [Api set: ExcelApi 1.7]
///
/// Start position of substring to be retrieved. Zero-indexed.
/// Length of the substring to be retrieved.
///
}
ChartTitle.prototype.setFormula = function(formula) {
///
/// Sets a string value that represents the formula of chart title using A1-style notation. [Api set: ExcelApi 1.7]
///
/// A string that represents the formula to set.
///
}
return ChartTitle;
})(OfficeExtension.ClientObject);
Excel.ChartTitle = ChartTitle;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartTitleFormat = (function(_super) {
__extends(ChartTitleFormat, _super);
function ChartTitleFormat() {
/// Provides access to the formatting options for a chart title. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the border format of chart title, which includes color, linestyle, and weight. [Api set: ExcelApi 1.7]
/// Represents the fill format of an object, which includes background formatting information. [Api set: ExcelApi 1.1]
/// Represents the font attributes (such as font name, font size, and color) for an object. [Api set: ExcelApi 1.1]
}
ChartTitleFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartTitleFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartTitleFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartTitleFormat object, with properties that have already been loaded and synced.
///
}
return ChartTitleFormat;
})(OfficeExtension.ClientObject);
Excel.ChartTitleFormat = ChartTitleFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the position of the chart title. [Api set: ExcelApi 1.7]
var ChartTitlePosition = {
__proto__: null,
"automatic": "automatic",
"top": "top",
"bottom": "bottom",
"left": "left",
"right": "right",
}
Excel.ChartTitlePosition = ChartTitlePosition;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartTrendline = (function(_super) {
__extends(ChartTrendline, _super);
function ChartTrendline() {
/// This object represents the attributes for a chart trendline object. [Api set: ExcelApi 1.7]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the number of periods that the trendline extends backward. [Api set: ExcelApi 1.8]
/// Represents the formatting of a chart trendline. [Api set: ExcelApi 1.7]
/// Represents the number of periods that the trendline extends forward. [Api set: ExcelApi 1.8]
/// Represents the intercept value of the trendline. Can be set to a numeric value or an empty string (for automatic values). The returned value is always a number. [Api set: ExcelApi 1.7]
/// Represents the label of a chart trendline. [Api set: ExcelApi 1.8]
/// Represents the period of a chart trendline. Only applicable to trendlines with the type `MovingAverage`. [Api set: ExcelApi 1.7]
/// 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 [Api set: ExcelApi 1.7]
/// Represents the order of a chart trendline. Only applicable to trendlines with the type `Polynomial`. [Api set: ExcelApi 1.7]
/// True if the equation for the trendline is displayed on the chart. [Api set: ExcelApi 1.8]
/// True if the r-squared value for the trendline is displayed on the chart. [Api set: ExcelApi 1.8]
/// Represents the type of a chart trendline. [Api set: ExcelApi 1.7]
}
ChartTrendline.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartTrendline.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartTrendlineUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartTrendline object, with properties that have already been loaded and synced.
///
}
ChartTrendline.prototype.delete = function() {
///
/// Delete the trendline object. [Api set: ExcelApi 1.7]
///
///
}
return ChartTrendline;
})(OfficeExtension.ClientObject);
Excel.ChartTrendline = ChartTrendline;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartTrendlineCollection = (function(_super) {
__extends(ChartTrendlineCollection, _super);
function ChartTrendlineCollection() {
/// Represents a collection of chart trendlines. [Api set: ExcelApi 1.7]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
ChartTrendlineCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartTrendlineCollection.prototype.add = function(type) {
///
/// Adds a new trendline to trendline collection. [Api set: ExcelApi 1.7]
///
/// Specifies the trendline type. The default value is "Linear". See `Excel.ChartTrendline` for details.
///
}
ChartTrendlineCollection.prototype.getCount = function() {
///
/// Returns the number of trendlines in the collection. [Api set: ExcelApi 1.7]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
ChartTrendlineCollection.prototype.getItem = function(index) {
///
/// Gets a trendline object by index, which is the insertion order in the items array. [Api set: ExcelApi 1.7]
///
/// Represents the insertion order in the items array.
///
}
return ChartTrendlineCollection;
})(OfficeExtension.ClientObject);
Excel.ChartTrendlineCollection = ChartTrendlineCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartTrendlineFormat = (function(_super) {
__extends(ChartTrendlineFormat, _super);
function ChartTrendlineFormat() {
/// Represents the format properties for the chart trendline. [Api set: ExcelApi 1.7]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents chart line formatting. [Api set: ExcelApi 1.7]
}
ChartTrendlineFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartTrendlineFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartTrendlineFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartTrendlineFormat object, with properties that have already been loaded and synced.
///
}
return ChartTrendlineFormat;
})(OfficeExtension.ClientObject);
Excel.ChartTrendlineFormat = ChartTrendlineFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartTrendlineLabel = (function(_super) {
__extends(ChartTrendlineLabel, _super);
function ChartTrendlineLabel() {
/// This object represents the attributes for a chart trendline label object. [Api set: ExcelApi 1.8]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies if the trendline label automatically generates appropriate text based on context. [Api set: ExcelApi 1.8]
/// The format of the chart trendline label. [Api set: ExcelApi 1.8]
/// String value that represents the formula of the chart trendline label using A1-style notation. [Api set: ExcelApi 1.8]
/// Returns the height, in points, of the chart trendline label. Value is `null` if the chart trendline label is not visible. [Api set: ExcelApi 1.8]
/// Represents the horizontal alignment of the chart trendline label. See `Excel.ChartTextHorizontalAlignment` for details. This property is valid only when `TextOrientation` of a trendline label is -90, 90, or 180. [Api set: ExcelApi 1.8]
/// 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. [Api set: ExcelApi 1.8]
/// 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). [Api set: ExcelApi 1.9]
/// String value that represents the format code for the trendline label. [Api set: ExcelApi 1.8]
/// String representing the text of the trendline label on a chart. [Api set: ExcelApi 1.8]
/// 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. [Api set: ExcelApi 1.8]
/// 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. [Api set: ExcelApi 1.8]
/// Represents the vertical alignment of the chart trendline label. See `Excel.ChartTextVerticalAlignment` for details. This property is valid only when `TextOrientation` of a trendline label is 0. [Api set: ExcelApi 1.8]
/// Returns the width, in points, of the chart trendline label. Value is `null` if the chart trendline label is not visible. [Api set: ExcelApi 1.8]
}
ChartTrendlineLabel.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartTrendlineLabel.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartTrendlineLabelUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartTrendlineLabel object, with properties that have already been loaded and synced.
///
}
return ChartTrendlineLabel;
})(OfficeExtension.ClientObject);
Excel.ChartTrendlineLabel = ChartTrendlineLabel;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ChartTrendlineLabelFormat = (function(_super) {
__extends(ChartTrendlineLabelFormat, _super);
function ChartTrendlineLabelFormat() {
/// Encapsulates the format properties for the chart trendline label. [Api set: ExcelApi 1.8]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies the border format, which includes color, linestyle, and weight. [Api set: ExcelApi 1.8]
/// Specifies the fill format of the current chart trendline label. [Api set: ExcelApi 1.8]
/// Specifies the font attributes (such as font name, font size, and color) for a chart trendline label. [Api set: ExcelApi 1.8]
}
ChartTrendlineLabelFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ChartTrendlineLabelFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ChartTrendlineLabelFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ChartTrendlineLabelFormat object, with properties that have already been loaded and synced.
///
}
return ChartTrendlineLabelFormat;
})(OfficeExtension.ClientObject);
Excel.ChartTrendlineLabelFormat = ChartTrendlineLabelFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.7]
var ChartTrendlineType = {
__proto__: null,
"linear": "linear",
"exponential": "exponential",
"logarithmic": "logarithmic",
"movingAverage": "movingAverage",
"polynomial": "polynomial",
"power": "power",
}
Excel.ChartTrendlineType = ChartTrendlineType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.1]
var ChartType = {
__proto__: null,
"invalid": "invalid",
"columnClustered": "columnClustered",
"columnStacked": "columnStacked",
"columnStacked100": "columnStacked100",
"_3DColumnClustered": "_3DColumnClustered",
"_3DColumnStacked": "_3DColumnStacked",
"_3DColumnStacked100": "_3DColumnStacked100",
"barClustered": "barClustered",
"barStacked": "barStacked",
"barStacked100": "barStacked100",
"_3DBarClustered": "_3DBarClustered",
"_3DBarStacked": "_3DBarStacked",
"_3DBarStacked100": "_3DBarStacked100",
"lineStacked": "lineStacked",
"lineStacked100": "lineStacked100",
"lineMarkers": "lineMarkers",
"lineMarkersStacked": "lineMarkersStacked",
"lineMarkersStacked100": "lineMarkersStacked100",
"pieOfPie": "pieOfPie",
"pieExploded": "pieExploded",
"_3DPieExploded": "_3DPieExploded",
"barOfPie": "barOfPie",
"xyscatterSmooth": "xyscatterSmooth",
"xyscatterSmoothNoMarkers": "xyscatterSmoothNoMarkers",
"xyscatterLines": "xyscatterLines",
"xyscatterLinesNoMarkers": "xyscatterLinesNoMarkers",
"areaStacked": "areaStacked",
"areaStacked100": "areaStacked100",
"_3DAreaStacked": "_3DAreaStacked",
"_3DAreaStacked100": "_3DAreaStacked100",
"doughnutExploded": "doughnutExploded",
"radarMarkers": "radarMarkers",
"radarFilled": "radarFilled",
"surface": "surface",
"surfaceWireframe": "surfaceWireframe",
"surfaceTopView": "surfaceTopView",
"surfaceTopViewWireframe": "surfaceTopViewWireframe",
"bubble": "bubble",
"bubble3DEffect": "bubble3DEffect",
"stockHLC": "stockHLC",
"stockOHLC": "stockOHLC",
"stockVHLC": "stockVHLC",
"stockVOHLC": "stockVOHLC",
"cylinderColClustered": "cylinderColClustered",
"cylinderColStacked": "cylinderColStacked",
"cylinderColStacked100": "cylinderColStacked100",
"cylinderBarClustered": "cylinderBarClustered",
"cylinderBarStacked": "cylinderBarStacked",
"cylinderBarStacked100": "cylinderBarStacked100",
"cylinderCol": "cylinderCol",
"coneColClustered": "coneColClustered",
"coneColStacked": "coneColStacked",
"coneColStacked100": "coneColStacked100",
"coneBarClustered": "coneBarClustered",
"coneBarStacked": "coneBarStacked",
"coneBarStacked100": "coneBarStacked100",
"coneCol": "coneCol",
"pyramidColClustered": "pyramidColClustered",
"pyramidColStacked": "pyramidColStacked",
"pyramidColStacked100": "pyramidColStacked100",
"pyramidBarClustered": "pyramidBarClustered",
"pyramidBarStacked": "pyramidBarStacked",
"pyramidBarStacked100": "pyramidBarStacked100",
"pyramidCol": "pyramidCol",
"_3DColumn": "_3DColumn",
"line": "line",
"_3DLine": "_3DLine",
"_3DPie": "_3DPie",
"pie": "pie",
"xyscatter": "xyscatter",
"_3DArea": "_3DArea",
"area": "area",
"doughnut": "doughnut",
"radar": "radar",
"histogram": "histogram",
"boxwhisker": "boxwhisker",
"pareto": "pareto",
"regionMap": "regionMap",
"treemap": "treemap",
"waterfall": "waterfall",
"sunburst": "sunburst",
"funnel": "funnel",
}
Excel.ChartType = ChartType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.1]
var ChartUnderlineStyle = {
__proto__: null,
"none": "none",
"single": "single",
}
Excel.ChartUnderlineStyle = ChartUnderlineStyle;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.1 for All, Formats, and Contents. 1.7 for Hyperlinks and RemoveHyperlinks.]
var ClearApplyTo = {
__proto__: null,
"all": "all",
"formats": "formats",
"contents": "contents",
"hyperlinks": "hyperlinks",
"removeHyperlinks": "removeHyperlinks",
}
Excel.ClearApplyTo = ClearApplyTo;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Specifies the close behavior for `Workbook.close`. [Api set: ExcelApi 1.9]
var CloseBehavior = {
__proto__: null,
"save": "save",
"skipSave": "skipSave",
}
Excel.CloseBehavior = CloseBehavior;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ColorScaleConditionalFormat = (function(_super) {
__extends(ColorScaleConditionalFormat, _super);
function ColorScaleConditionalFormat() {
/// Represents the color scale criteria for conditional formatting. [Api set: ExcelApi 1.6]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// The criteria of the color scale. Midpoint is optional when using a two point color scale. [Api set: ExcelApi 1.6]
/// If `true`, the color scale will have three points (minimum, midpoint, maximum), otherwise it will have two (minimum, maximum). [Api set: ExcelApi 1.6]
}
ColorScaleConditionalFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ColorScaleConditionalFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ColorScaleConditionalFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ColorScaleConditionalFormat object, with properties that have already been loaded and synced.
///
}
return ColorScaleConditionalFormat;
})(OfficeExtension.ClientObject);
Excel.ColorScaleConditionalFormat = ColorScaleConditionalFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Comment = (function(_super) {
__extends(Comment, _super);
function Comment() {
/// Represents a comment in the workbook. [Api set: ExcelApi 1.10]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the email of the comment's author. [Api set: ExcelApi 1.10]
/// Gets the name of the comment's author. [Api set: ExcelApi 1.10]
/// The comment's content. The string is plain text. [Api set: ExcelApi 1.10]
/// Gets the content type of the comment. [Api set: ExcelApi 1.12]
/// 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. [Api set: ExcelApi 1.10]
/// Specifies the comment identifier. [Api set: ExcelApi 1.10]
/// Gets the entities (e.g., people) that are mentioned in comments. [Api set: ExcelApi 1.11]
/// Represents a collection of reply objects associated with the comment. [Api set: ExcelApi 1.10]
/// The comment thread status. A value of `true` means that the comment thread is resolved. [Api set: ExcelApi 1.11]
/// 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. [Api set: ExcelApi 1.11]
}
Comment.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Comment.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.CommentUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing Comment object, with properties that have already been loaded and synced.
///
}
Comment.prototype.delete = function() {
///
/// Deletes the comment and all the connected replies. [Api set: ExcelApi 1.10]
///
///
}
Comment.prototype.getLocation = function() {
///
/// Gets the cell where this comment is located. [Api set: ExcelApi 1.10]
///
///
}
Comment.prototype.updateMentions = function(contentWithMentions) {
///
/// Updates the comment content with a specially formatted string and a list of mentions. [Api set: ExcelApi 1.11]
///
/// 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.
///
}
return Comment;
})(OfficeExtension.ClientObject);
Excel.Comment = Comment;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var CommentAddedEventArgs = (function() {
function CommentAddedEventArgs() {
/// Provides information about the comments that raised the comment added event. [Api set: ExcelApi 1.12]
/// Gets the `CommentDetail` array that contains the comment ID and IDs of its related replies. [Api set: ExcelApi 1.12]
/// Specifies the source of the event. See `Excel.EventSource` for details. [Api set: ExcelApi 1.12]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.12]
/// Gets the ID of the worksheet in which the event happened. [Api set: ExcelApi 1.12]
}
return CommentAddedEventArgs;
})();
Interfaces.CommentAddedEventArgs.__proto__ = null;
Interfaces.CommentAddedEventArgs = CommentAddedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var CommentChangedEventArgs = (function() {
function CommentChangedEventArgs() {
/// Occurs when existing comments are changed. [Api set: ExcelApi 1.12]
/// Gets the change type that represents how the changed event is triggered. [Api set: ExcelApi 1.12]
/// Get the `CommentDetail` array which contains the comment ID and IDs of its related replies. [Api set: ExcelApi 1.12]
/// Specifies the source of the event. See `Excel.EventSource` for details. [Api set: ExcelApi 1.12]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.12]
/// Gets the ID of the worksheet in which the event happened. [Api set: ExcelApi 1.12]
}
return CommentChangedEventArgs;
})();
Interfaces.CommentChangedEventArgs.__proto__ = null;
Interfaces.CommentChangedEventArgs = CommentChangedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents how the comments in the event were changed. [Api set: ExcelApi 1.12]
var CommentChangeType = {
__proto__: null,
"commentEdited": "commentEdited",
"commentResolved": "commentResolved",
"commentReopened": "commentReopened",
"replyAdded": "replyAdded",
"replyDeleted": "replyDeleted",
"replyEdited": "replyEdited",
}
Excel.CommentChangeType = CommentChangeType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var CommentCollection = (function(_super) {
__extends(CommentCollection, _super);
function CommentCollection() {
/// Represents a collection of comment objects that are part of the workbook. [Api set: ExcelApi 1.10]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Occurs when the comments are added. [Api set: ExcelApi 1.12]
/// Occurs when comments or replies in a comment collection are changed, including when replies are deleted. [Api set: ExcelApi 1.12]
/// Occurs when comments are deleted in the comment collection. [Api set: ExcelApi 1.12]
/// Gets the loaded child items in this collection.
}
CommentCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
CommentCollection.prototype.add = function(cellAddress, content, contentType) {
///
/// 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. [Api set: ExcelApi 1.10]
///
/// 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.
/// 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. [Api set: ExcelApi 1.10 for string, 1.11 for CommentRichContent object]
/// Optional. The type of content contained within the comment. The default value is enum `ContentType.Plain`. [Api set: ExcelApi 1.10 for Enum ContentType.Plain, 1.11 for Enum ContentType.Mention]
///
}
CommentCollection.prototype.getCount = function() {
///
/// Gets the number of comments in the collection. [Api set: ExcelApi 1.10]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
CommentCollection.prototype.getItem = function(commentId) {
///
/// Gets a comment from the collection based on its ID. [Api set: ExcelApi 1.10]
///
/// The identifier for the comment.
///
}
CommentCollection.prototype.getItemAt = function(index) {
///
/// Gets a comment from the collection based on its position. [Api set: ExcelApi 1.10]
///
/// Index value of the object to be retrieved. Zero-indexed.
///
}
CommentCollection.prototype.getItemByCell = function(cellAddress) {
///
/// Gets the comment from the specified cell. [Api set: ExcelApi 1.10]
///
/// 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.
///
}
CommentCollection.prototype.getItemByReplyId = function(replyId) {
///
/// Gets the comment to which the given reply is connected. [Api set: ExcelApi 1.10]
///
/// The identifier of comment reply.
///
}
CommentCollection.prototype.getItemOrNullObject = function(commentId) {
///
/// Gets a comment from the collection based on its ID. If the comment object does not exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.14]
///
/// The identifier for the comment.
///
}
CommentCollection.prototype.onAdded = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the comments that raised the comment added event.
///
var eventInfo = new Excel.Interfaces.CommentAddedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
CommentCollection.prototype.onChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Occurs when existing comments are changed.
///
var eventInfo = new Excel.Interfaces.CommentChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
CommentCollection.prototype.onDeleted = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the comments that raised the comment deleted event.
///
var eventInfo = new Excel.Interfaces.CommentDeletedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
return CommentCollection;
})(OfficeExtension.ClientObject);
Excel.CommentCollection = CommentCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var CommentDeletedEventArgs = (function() {
function CommentDeletedEventArgs() {
/// Provides information about the comments that raised the comment deleted event. [Api set: ExcelApi 1.12]
/// Gets the `CommentDetail` array that contains the comment ID and IDs of its related replies. [Api set: ExcelApi 1.12]
/// Specifies the source of the event. See `Excel.EventSource` for details. [Api set: ExcelApi 1.12]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.12]
/// Gets the ID of the worksheet in which the event happened. [Api set: ExcelApi 1.12]
}
return CommentDeletedEventArgs;
})();
Interfaces.CommentDeletedEventArgs.__proto__ = null;
Interfaces.CommentDeletedEventArgs = CommentDeletedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var CommentDetail = (function() {
function CommentDetail() {
/// A structure for the comment ID and IDs of its related replies. [Api set: ExcelApi 1.12]
/// Represents the IDs of the related replies that belong to the comment. [Api set: ExcelApi 1.12]
/// Represents the ID of the comment. [Api set: ExcelApi 1.12]
}
return CommentDetail;
})();
Interfaces.CommentDetail.__proto__ = null;
Interfaces.CommentDetail = CommentDetail;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var CommentMention = (function() {
function CommentMention() {
/// Represents the entity that is mentioned in comments. [Api set: ExcelApi 1.11]
/// The email address of the entity that is mentioned in a comment. [Api set: ExcelApi 1.11]
/// The ID of the entity. The ID matches one of the IDs in `CommentRichContent.richContent`. [Api set: ExcelApi 1.11]
/// The name of the entity that is mentioned in a comment. [Api set: ExcelApi 1.11]
}
return CommentMention;
})();
Interfaces.CommentMention.__proto__ = null;
Interfaces.CommentMention = CommentMention;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var CommentReply = (function(_super) {
__extends(CommentReply, _super);
function CommentReply() {
/// Represents a comment reply in the workbook. [Api set: ExcelApi 1.10]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the email of the comment reply's author. [Api set: ExcelApi 1.10]
/// Gets the name of the comment reply's author. [Api set: ExcelApi 1.10]
/// The comment reply's content. The string is plain text. [Api set: ExcelApi 1.10]
/// The content type of the reply. [Api set: ExcelApi 1.12]
/// Gets the creation time of the comment reply. [Api set: ExcelApi 1.10]
/// Specifies the comment reply identifier. [Api set: ExcelApi 1.10]
/// The entities (e.g., people) that are mentioned in comments. [Api set: ExcelApi 1.11]
/// The comment reply status. A value of `true` means the reply is in the resolved state. [Api set: ExcelApi 1.11]
/// 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. [Api set: ExcelApi 1.11]
}
CommentReply.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
CommentReply.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.CommentReplyUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing CommentReply object, with properties that have already been loaded and synced.
///
}
CommentReply.prototype.delete = function() {
///
/// Deletes the comment reply. [Api set: ExcelApi 1.10]
///
///
}
CommentReply.prototype.getLocation = function() {
///
/// Gets the cell where this comment reply is located. [Api set: ExcelApi 1.10]
///
///
}
CommentReply.prototype.getParentComment = function() {
///
/// Gets the parent comment of this reply. [Api set: ExcelApi 1.10]
///
///
}
CommentReply.prototype.updateMentions = function(contentWithMentions) {
///
/// Updates the comment content with a specially formatted string and a list of mentions. [Api set: ExcelApi 1.11]
///
/// 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.
///
}
return CommentReply;
})(OfficeExtension.ClientObject);
Excel.CommentReply = CommentReply;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var CommentReplyCollection = (function(_super) {
__extends(CommentReplyCollection, _super);
function CommentReplyCollection() {
/// Represents a collection of comment reply objects that are part of the comment. [Api set: ExcelApi 1.10]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
CommentReplyCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
CommentReplyCollection.prototype.add = function(content, contentType) {
///
/// Creates a comment reply for a comment. [Api set: ExcelApi 1.10]
///
/// The comment's content. This can be either a string or a `CommentRichContent` object (e.g., for comments with mentions). [Api set: ExcelApi 1.10 for string, 1.11 for CommentRichContent object]
/// Optional. The type of content contained within the comment. The default value is enum `ContentType.Plain`. [Api set: ExcelApi 1.10 for Enum ContentType.Plain, 1.11 for Enum ContentType.Mention]
///
}
CommentReplyCollection.prototype.getCount = function() {
///
/// Gets the number of comment replies in the collection. [Api set: ExcelApi 1.10]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
CommentReplyCollection.prototype.getItem = function(commentReplyId) {
///
/// Returns a comment reply identified by its ID. [Api set: ExcelApi 1.10]
///
/// The identifier for the comment reply.
///
}
CommentReplyCollection.prototype.getItemAt = function(index) {
///
/// Gets a comment reply based on its position in the collection. [Api set: ExcelApi 1.10]
///
/// The index value of the comment reply to be retrieved. The collection uses zero-based indexing.
///
}
CommentReplyCollection.prototype.getItemOrNullObject = function(commentReplyId) {
///
/// Returns a comment reply identified by its ID. If the comment reply object does not exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.14]
///
/// The identifier for the comment reply
///
}
return CommentReplyCollection;
})(OfficeExtension.ClientObject);
Excel.CommentReplyCollection = CommentReplyCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var CommentRichContent = (function() {
function CommentRichContent() {
/// Represents the content contained within a comment or comment reply. Rich content incudes the text string and any other objects contained within the comment body, such as mentions. [Api set: ExcelApi 1.11]
/// An array containing all the entities (e.g., people) mentioned within the comment. [Api set: ExcelApi 1.11]
/// 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). [Api set: ExcelApi 1.11]
}
return CommentRichContent;
})();
Interfaces.CommentRichContent.__proto__ = null;
Interfaces.CommentRichContent = CommentRichContent;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the operator of the text conditional format type. [Api set: ExcelApi 1.6]
var ConditionalCellValueOperator = {
__proto__: null,
"invalid": "invalid",
"between": "between",
"notBetween": "notBetween",
"equalTo": "equalTo",
"notEqualTo": "notEqualTo",
"greaterThan": "greaterThan",
"lessThan": "lessThan",
"greaterThanOrEqual": "greaterThanOrEqual",
"lessThanOrEqual": "lessThanOrEqual",
}
Excel.ConditionalCellValueOperator = ConditionalCellValueOperator;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ConditionalCellValueRule = (function() {
function ConditionalCellValueRule() {
/// Represents a cell value conditional format rule. [Api set: ExcelApi 1.6]
/// The formula, if required, on which to evaluate the conditional format rule. [Api set: ExcelApi 1.6]
/// The formula, if required, on which to evaluate the conditional format rule. [Api set: ExcelApi 1.6]
/// The operator of the cell value conditional format. [Api set: ExcelApi 1.6]
}
return ConditionalCellValueRule;
})();
Interfaces.ConditionalCellValueRule.__proto__ = null;
Interfaces.ConditionalCellValueRule = ConditionalCellValueRule;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ConditionalColorScaleCriteria = (function() {
function ConditionalColorScaleCriteria() {
/// Represents the criteria of the color scale. [Api set: ExcelApi 1.6]
/// The maximum point of the color scale criterion. [Api set: ExcelApi 1.6]
/// The midpoint of the color scale criterion, if the color scale is a 3-color scale. [Api set: ExcelApi 1.6]
/// The minimum point of the color scale criterion. [Api set: ExcelApi 1.6]
}
return ConditionalColorScaleCriteria;
})();
Interfaces.ConditionalColorScaleCriteria.__proto__ = null;
Interfaces.ConditionalColorScaleCriteria = ConditionalColorScaleCriteria;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ConditionalColorScaleCriterion = (function() {
function ConditionalColorScaleCriterion() {
/// Represents a color scale criterion which contains a type, value, and a color. [Api set: ExcelApi 1.6]
/// HTML color code representation of the color scale color (e.g., #FF0000 represents Red). [Api set: ExcelApi 1.6]
/// A number, a formula, or `null` (if `type` is `lowestValue`). [Api set: ExcelApi 1.6]
/// What the criterion conditional formula should be based on. [Api set: ExcelApi 1.6]
}
return ConditionalColorScaleCriterion;
})();
Interfaces.ConditionalColorScaleCriterion.__proto__ = null;
Interfaces.ConditionalColorScaleCriterion = ConditionalColorScaleCriterion;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the format options for a data bar axis. [Api set: ExcelApi 1.6]
var ConditionalDataBarAxisFormat = {
__proto__: null,
"automatic": "automatic",
"none": "none",
"cellMidPoint": "cellMidPoint",
}
Excel.ConditionalDataBarAxisFormat = ConditionalDataBarAxisFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the data bar direction within a cell. [Api set: ExcelApi 1.6]
var ConditionalDataBarDirection = {
__proto__: null,
"context": "context",
"leftToRight": "leftToRight",
"rightToLeft": "rightToLeft",
}
Excel.ConditionalDataBarDirection = ConditionalDataBarDirection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ConditionalDataBarNegativeFormat = (function(_super) {
__extends(ConditionalDataBarNegativeFormat, _super);
function ConditionalDataBarNegativeFormat() {
/// Represents a conditional format for the negative side of the data bar. [Api set: ExcelApi 1.6]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// 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. [Api set: ExcelApi 1.6]
/// HTML color code representing the fill color, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). [Api set: ExcelApi 1.6]
/// Specifies if the negative data bar has the same border color as the positive data bar. [Api set: ExcelApi 1.6]
/// Specifies if the negative data bar has the same fill color as the positive data bar. [Api set: ExcelApi 1.6]
}
ConditionalDataBarNegativeFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ConditionalDataBarNegativeFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ConditionalDataBarNegativeFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ConditionalDataBarNegativeFormat object, with properties that have already been loaded and synced.
///
}
return ConditionalDataBarNegativeFormat;
})(OfficeExtension.ClientObject);
Excel.ConditionalDataBarNegativeFormat = ConditionalDataBarNegativeFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ConditionalDataBarPositiveFormat = (function(_super) {
__extends(ConditionalDataBarPositiveFormat, _super);
function ConditionalDataBarPositiveFormat() {
/// Represents a conditional format for the positive side of the data bar. [Api set: ExcelApi 1.6]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// 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. [Api set: ExcelApi 1.6]
/// HTML color code representing the fill color, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). [Api set: ExcelApi 1.6]
/// Specifies if the data bar has a gradient. [Api set: ExcelApi 1.6]
}
ConditionalDataBarPositiveFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ConditionalDataBarPositiveFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ConditionalDataBarPositiveFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ConditionalDataBarPositiveFormat object, with properties that have already been loaded and synced.
///
}
return ConditionalDataBarPositiveFormat;
})(OfficeExtension.ClientObject);
Excel.ConditionalDataBarPositiveFormat = ConditionalDataBarPositiveFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ConditionalDataBarRule = (function() {
function ConditionalDataBarRule() {
/// Represents a rule-type for a data bar. [Api set: ExcelApi 1.6]
/// The formula, if required, on which to evaluate the data bar rule. [Api set: ExcelApi 1.6]
/// The type of rule for the data bar. [Api set: ExcelApi 1.6]
}
return ConditionalDataBarRule;
})();
Interfaces.ConditionalDataBarRule.__proto__ = null;
Interfaces.ConditionalDataBarRule = ConditionalDataBarRule;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ConditionalFormat = (function(_super) {
__extends(ConditionalFormat, _super);
function ConditionalFormat() {
/// An object encapsulating a conditional format's range, format, rule, and other properties. To learn more about the conditional formatting object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-conditional-formatting | Apply conditional formatting to Excel ranges}. [Api set: ExcelApi 1.6]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Returns the cell value conditional format properties if the current conditional format is a `CellValue` type. [Api set: ExcelApi 1.6]
/// Returns the cell value conditional format properties if the current conditional format is a `CellValue` type. [Api set: ExcelApi 1.6]
/// Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type. [Api set: ExcelApi 1.6]
/// Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type. [Api set: ExcelApi 1.6]
/// Returns the custom conditional format properties if the current conditional format is a custom type. [Api set: ExcelApi 1.6]
/// Returns the custom conditional format properties if the current conditional format is a custom type. [Api set: ExcelApi 1.6]
/// Returns the data bar properties if the current conditional format is a data bar. [Api set: ExcelApi 1.6]
/// Returns the data bar properties if the current conditional format is a data bar. [Api set: ExcelApi 1.6]
/// Returns the icon set conditional format properties if the current conditional format is an `IconSet` type. [Api set: ExcelApi 1.6]
/// Returns the icon set conditional format properties if the current conditional format is an `IconSet` type. [Api set: ExcelApi 1.6]
/// The priority of the conditional format in the current `ConditionalFormatCollection`. [Api set: ExcelApi 1.6]
/// Returns the preset criteria conditional format. See `Excel.PresetCriteriaConditionalFormat` for more details. [Api set: ExcelApi 1.6]
/// Returns the preset criteria conditional format. See `Excel.PresetCriteriaConditionalFormat` for more details. [Api set: ExcelApi 1.6]
/// 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. [Api set: ExcelApi 1.6]
/// 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. [Api set: ExcelApi 1.6]
/// 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". [Api set: ExcelApi 1.6]
/// 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". [Api set: ExcelApi 1.6]
/// 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. [Api set: ExcelApi 1.6]
/// 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. [Api set: ExcelApi 1.6]
/// A type of conditional format. Only one can be set at a time. [Api set: ExcelApi 1.6]
}
ConditionalFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ConditionalFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ConditionalFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ConditionalFormat object, with properties that have already been loaded and synced.
///
}
ConditionalFormat.prototype.delete = function() {
///
/// Deletes this conditional format. [Api set: ExcelApi 1.6]
///
///
}
ConditionalFormat.prototype.getRange = function() {
///
/// Returns the range the conditonal format is applied to. Throws an error if the conditional format is applied to multiple ranges. [Api set: ExcelApi 1.6]
///
///
}
ConditionalFormat.prototype.getRangeOrNullObject = function() {
///
/// Returns the range to which the conditonal format is applied. If the conditional format is applied to multiple ranges, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.6]
///
///
}
ConditionalFormat.prototype.getRanges = function() {
///
/// Returns the `RangeAreas`, comprising one or more rectangular ranges, to which the conditonal format is applied. [Api set: ExcelApi 1.9]
///
///
}
return ConditionalFormat;
})(OfficeExtension.ClientObject);
Excel.ConditionalFormat = ConditionalFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ConditionalFormatCollection = (function(_super) {
__extends(ConditionalFormatCollection, _super);
function ConditionalFormatCollection() {
/// Represents a collection of all the conditional formats that are overlap the range. [Api set: ExcelApi 1.6]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
ConditionalFormatCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ConditionalFormatCollection.prototype.add = function(type) {
///
/// Adds a new conditional format to the collection at the first/top priority. [Api set: ExcelApi 1.6]
///
/// The type of conditional format being added. See `Excel.ConditionalFormatType` for details.
///
}
ConditionalFormatCollection.prototype.clearAll = function() {
///
/// Clears all conditional formats active on the current specified range. [Api set: ExcelApi 1.6]
///
///
}
ConditionalFormatCollection.prototype.getCount = function() {
///
/// Returns the number of conditional formats in the workbook. [Api set: ExcelApi 1.6]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
ConditionalFormatCollection.prototype.getItem = function(id) {
///
/// Returns a conditional format for the given ID. [Api set: ExcelApi 1.6]
///
/// The ID of the conditional format.
/// Conditional format object.
}
ConditionalFormatCollection.prototype.getItemAt = function(index) {
///
/// Returns a conditional format at the given index. [Api set: ExcelApi 1.6]
///
/// Index of the conditional formats to be retrieved.
///
}
ConditionalFormatCollection.prototype.getItemOrNullObject = function(id) {
///
/// Returns a conditional format identified by its ID. If the conditional format object does not exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.14]
///
/// The ID of the conditional format
///
}
return ConditionalFormatCollection;
})(OfficeExtension.ClientObject);
Excel.ConditionalFormatCollection = ConditionalFormatCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the types of color criterion for conditional formatting. [Api set: ExcelApi 1.6]
var ConditionalFormatColorCriterionType = {
__proto__: null,
"invalid": "invalid",
"lowestValue": "lowestValue",
"highestValue": "highestValue",
"number": "number",
"percent": "percent",
"formula": "formula",
"percentile": "percentile",
}
Excel.ConditionalFormatColorCriterionType = ConditionalFormatColorCriterionType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the direction for a selection. [Api set: ExcelApi 1.6]
var ConditionalFormatDirection = {
__proto__: null,
"top": "top",
"bottom": "bottom",
}
Excel.ConditionalFormatDirection = ConditionalFormatDirection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the types of icon conditional format. [Api set: ExcelApi 1.6]
var ConditionalFormatIconRuleType = {
__proto__: null,
"invalid": "invalid",
"number": "number",
"percent": "percent",
"formula": "formula",
"percentile": "percentile",
}
Excel.ConditionalFormatIconRuleType = ConditionalFormatIconRuleType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the criteria of the preset criteria conditional format type. [Api set: ExcelApi 1.6]
var ConditionalFormatPresetCriterion = {
__proto__: null,
"invalid": "invalid",
"blanks": "blanks",
"nonBlanks": "nonBlanks",
"errors": "errors",
"nonErrors": "nonErrors",
"yesterday": "yesterday",
"today": "today",
"tomorrow": "tomorrow",
"lastSevenDays": "lastSevenDays",
"lastWeek": "lastWeek",
"thisWeek": "thisWeek",
"nextWeek": "nextWeek",
"lastMonth": "lastMonth",
"thisMonth": "thisMonth",
"nextMonth": "nextMonth",
"aboveAverage": "aboveAverage",
"belowAverage": "belowAverage",
"equalOrAboveAverage": "equalOrAboveAverage",
"equalOrBelowAverage": "equalOrBelowAverage",
"oneStdDevAboveAverage": "oneStdDevAboveAverage",
"oneStdDevBelowAverage": "oneStdDevBelowAverage",
"twoStdDevAboveAverage": "twoStdDevAboveAverage",
"twoStdDevBelowAverage": "twoStdDevBelowAverage",
"threeStdDevAboveAverage": "threeStdDevAboveAverage",
"threeStdDevBelowAverage": "threeStdDevBelowAverage",
"uniqueValues": "uniqueValues",
"duplicateValues": "duplicateValues",
}
Excel.ConditionalFormatPresetCriterion = ConditionalFormatPresetCriterion;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ConditionalFormatRule = (function(_super) {
__extends(ConditionalFormatRule, _super);
function ConditionalFormatRule() {
/// Represents a rule, for all traditional rule/format pairings. [Api set: ExcelApi 1.6]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// The formula, if required, on which to evaluate the conditional format rule. [Api set: ExcelApi 1.6]
/// The formula, if required, on which to evaluate the conditional format rule in the user's language. [Api set: ExcelApi 1.6]
/// The formula, if required, on which to evaluate the conditional format rule in R1C1-style notation. [Api set: ExcelApi 1.6]
}
ConditionalFormatRule.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ConditionalFormatRule.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ConditionalFormatRuleUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ConditionalFormatRule object, with properties that have already been loaded and synced.
///
}
return ConditionalFormatRule;
})(OfficeExtension.ClientObject);
Excel.ConditionalFormatRule = ConditionalFormatRule;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the types of conditional format values. [Api set: ExcelApi 1.6]
var ConditionalFormatRuleType = {
__proto__: null,
"invalid": "invalid",
"automatic": "automatic",
"lowestValue": "lowestValue",
"highestValue": "highestValue",
"number": "number",
"percent": "percent",
"formula": "formula",
"percentile": "percentile",
}
Excel.ConditionalFormatRuleType = ConditionalFormatRuleType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.6]
var ConditionalFormatType = {
__proto__: null,
"custom": "custom",
"dataBar": "dataBar",
"colorScale": "colorScale",
"iconSet": "iconSet",
"topBottom": "topBottom",
"presetCriteria": "presetCriteria",
"containsText": "containsText",
"cellValue": "cellValue",
}
Excel.ConditionalFormatType = ConditionalFormatType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ConditionalIconCriterion = (function() {
function ConditionalIconCriterion() {
/// Represents an icon criterion which contains a type, value, an operator, and an optional custom icon, if not using an icon set. [Api set: ExcelApi 1.6]
/// The custom icon for the current criterion, if different from the default icon set, else `null` will be returned. [Api set: ExcelApi 1.6]
/// A number or a formula depending on the type. [Api set: ExcelApi 1.6]
/// `greaterThan` or `greaterThanOrEqual` for each of the rule types for the icon conditional format. [Api set: ExcelApi 1.6]
/// What the icon conditional formula should be based on. [Api set: ExcelApi 1.6]
}
return ConditionalIconCriterion;
})();
Interfaces.ConditionalIconCriterion.__proto__ = null;
Interfaces.ConditionalIconCriterion = ConditionalIconCriterion;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the operator for each icon criteria. [Api set: ExcelApi 1.6]
var ConditionalIconCriterionOperator = {
__proto__: null,
"invalid": "invalid",
"greaterThan": "greaterThan",
"greaterThanOrEqual": "greaterThanOrEqual",
}
Excel.ConditionalIconCriterionOperator = ConditionalIconCriterionOperator;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ConditionalPresetCriteriaRule = (function() {
function ConditionalPresetCriteriaRule() {
/// Represents the preset criteria conditional format rule. [Api set: ExcelApi 1.6]
/// The criterion of the conditional format. [Api set: ExcelApi 1.6]
}
return ConditionalPresetCriteriaRule;
})();
Interfaces.ConditionalPresetCriteriaRule.__proto__ = null;
Interfaces.ConditionalPresetCriteriaRule = ConditionalPresetCriteriaRule;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ConditionalRangeBorder = (function(_super) {
__extends(ConditionalRangeBorder, _super);
function ConditionalRangeBorder() {
/// Represents the border of an object. [Api set: ExcelApi 1.6]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// 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"). [Api set: ExcelApi 1.6]
/// Constant value that indicates the specific side of the border. See `Excel.ConditionalRangeBorderIndex` for details. [Api set: ExcelApi 1.6]
/// One of the constants of line style specifying the line style for the border. See `Excel.BorderLineStyle` for details. [Api set: ExcelApi 1.6]
}
ConditionalRangeBorder.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ConditionalRangeBorder.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ConditionalRangeBorderUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ConditionalRangeBorder object, with properties that have already been loaded and synced.
///
}
return ConditionalRangeBorder;
})(OfficeExtension.ClientObject);
Excel.ConditionalRangeBorder = ConditionalRangeBorder;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ConditionalRangeBorderCollection = (function(_super) {
__extends(ConditionalRangeBorderCollection, _super);
function ConditionalRangeBorderCollection() {
/// Represents the border objects that make up range border. [Api set: ExcelApi 1.6]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the bottom border. [Api set: ExcelApi 1.6]
/// Number of border objects in the collection. [Api set: ExcelApi 1.6]
/// Gets the left border. [Api set: ExcelApi 1.6]
/// Gets the right border. [Api set: ExcelApi 1.6]
/// Gets the top border. [Api set: ExcelApi 1.6]
/// Gets the loaded child items in this collection.
}
ConditionalRangeBorderCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ConditionalRangeBorderCollection.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ConditionalRangeBorderCollectionUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ConditionalRangeBorderCollection object, with properties that have already been loaded and synced.
///
}
ConditionalRangeBorderCollection.prototype.getItem = function(index) {
///
/// Gets a border object using its name. [Api set: ExcelApi 1.6]
///
/// Index value of the border object to be retrieved. See `Excel.ConditionalRangeBorderIndex` for details.
///
}
ConditionalRangeBorderCollection.prototype.getItemAt = function(index) {
///
/// Gets a border object using its index. [Api set: ExcelApi 1.6]
///
/// Index value of the object to be retrieved. Zero-indexed.
///
}
return ConditionalRangeBorderCollection;
})(OfficeExtension.ClientObject);
Excel.ConditionalRangeBorderCollection = ConditionalRangeBorderCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.6]
var ConditionalRangeBorderIndex = {
__proto__: null,
"edgeTop": "edgeTop",
"edgeBottom": "edgeBottom",
"edgeLeft": "edgeLeft",
"edgeRight": "edgeRight",
}
Excel.ConditionalRangeBorderIndex = ConditionalRangeBorderIndex;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.6]
var ConditionalRangeBorderLineStyle = {
__proto__: null,
"none": "none",
"continuous": "continuous",
"dash": "dash",
"dashDot": "dashDot",
"dashDotDot": "dashDotDot",
"dot": "dot",
}
Excel.ConditionalRangeBorderLineStyle = ConditionalRangeBorderLineStyle;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ConditionalRangeFill = (function(_super) {
__extends(ConditionalRangeFill, _super);
function ConditionalRangeFill() {
/// Represents the background of a conditional range object. [Api set: ExcelApi 1.6]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// 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"). [Api set: ExcelApi 1.6]
}
ConditionalRangeFill.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ConditionalRangeFill.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ConditionalRangeFillUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ConditionalRangeFill object, with properties that have already been loaded and synced.
///
}
ConditionalRangeFill.prototype.clear = function() {
///
/// Resets the fill. [Api set: ExcelApi 1.6]
///
///
}
return ConditionalRangeFill;
})(OfficeExtension.ClientObject);
Excel.ConditionalRangeFill = ConditionalRangeFill;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ConditionalRangeFont = (function(_super) {
__extends(ConditionalRangeFont, _super);
function ConditionalRangeFont() {
/// This object represents the font attributes (font style, color, etc.) for an object. [Api set: ExcelApi 1.6]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies if the font is bold. [Api set: ExcelApi 1.6]
/// HTML color code representation of the text color (e.g., #FF0000 represents Red). [Api set: ExcelApi 1.6]
/// Specifies if the font is italic. [Api set: ExcelApi 1.6]
/// Specifies the strikethrough status of the font. [Api set: ExcelApi 1.6]
/// The type of underline applied to the font. See `Excel.ConditionalRangeFontUnderlineStyle` for details. [Api set: ExcelApi 1.6]
}
ConditionalRangeFont.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ConditionalRangeFont.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ConditionalRangeFontUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ConditionalRangeFont object, with properties that have already been loaded and synced.
///
}
ConditionalRangeFont.prototype.clear = function() {
///
/// Resets the font formats. [Api set: ExcelApi 1.6]
///
///
}
return ConditionalRangeFont;
})(OfficeExtension.ClientObject);
Excel.ConditionalRangeFont = ConditionalRangeFont;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.6]
var ConditionalRangeFontUnderlineStyle = {
__proto__: null,
"none": "none",
"single": "single",
"double": "double",
}
Excel.ConditionalRangeFontUnderlineStyle = ConditionalRangeFontUnderlineStyle;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ConditionalRangeFormat = (function(_super) {
__extends(ConditionalRangeFormat, _super);
function ConditionalRangeFormat() {
/// A format object encapsulating the conditional formats range's font, fill, borders, and other properties. [Api set: ExcelApi 1.6]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Collection of border objects that apply to the overall conditional format range. [Api set: ExcelApi 1.6]
/// Returns the fill object defined on the overall conditional format range. [Api set: ExcelApi 1.6]
/// Returns the font object defined on the overall conditional format range. [Api set: ExcelApi 1.6]
/// Represents Excel's number format code for the given range. Cleared if `null` is passed in. [Api set: ExcelApi 1.6]
}
ConditionalRangeFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ConditionalRangeFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ConditionalRangeFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ConditionalRangeFormat object, with properties that have already been loaded and synced.
///
}
return ConditionalRangeFormat;
})(OfficeExtension.ClientObject);
Excel.ConditionalRangeFormat = ConditionalRangeFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ConditionalTextComparisonRule = (function() {
function ConditionalTextComparisonRule() {
/// Represents a cell value conditional format rule. [Api set: ExcelApi 1.6]
/// The operator of the text conditional format. [Api set: ExcelApi 1.6]
/// The text value of the conditional format. [Api set: ExcelApi 1.6]
}
return ConditionalTextComparisonRule;
})();
Interfaces.ConditionalTextComparisonRule.__proto__ = null;
Interfaces.ConditionalTextComparisonRule = ConditionalTextComparisonRule;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the operator of the text conditional format type. [Api set: ExcelApi 1.6]
var ConditionalTextOperator = {
__proto__: null,
"invalid": "invalid",
"contains": "contains",
"notContains": "notContains",
"beginsWith": "beginsWith",
"endsWith": "endsWith",
}
Excel.ConditionalTextOperator = ConditionalTextOperator;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the criteria for the above/below average conditional format type. [Api set: ExcelApi 1.6]
var ConditionalTopBottomCriterionType = {
__proto__: null,
"invalid": "invalid",
"topItems": "topItems",
"topPercent": "topPercent",
"bottomItems": "bottomItems",
"bottomPercent": "bottomPercent",
}
Excel.ConditionalTopBottomCriterionType = ConditionalTopBottomCriterionType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ConditionalTopBottomRule = (function() {
function ConditionalTopBottomRule() {
/// Represents the rule of the top/bottom conditional format. [Api set: ExcelApi 1.6]
/// The rank between 1 and 1000 for numeric ranks or 1 and 100 for percent ranks. [Api set: ExcelApi 1.6]
/// Format values based on the top or bottom rank. [Api set: ExcelApi 1.6]
}
return ConditionalTopBottomRule;
})();
Interfaces.ConditionalTopBottomRule.__proto__ = null;
Interfaces.ConditionalTopBottomRule = ConditionalTopBottomRule;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.9]
var ConnectorType = {
__proto__: null,
"straight": "straight",
"elbow": "elbow",
"curve": "curve",
}
Excel.ConnectorType = ConnectorType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.10]
var ContentType = {
__proto__: null,
"plain": "plain",
"mention": "mention",
}
Excel.ContentType = ContentType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var CultureInfo = (function(_super) {
__extends(CultureInfo, _super);
function CultureInfo() {
/// Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings. [Api set: ExcelApi 1.11]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Defines the culturally appropriate format of displaying date and time. This is based on current system culture settings. [Api set: ExcelApi 1.12]
/// Gets the culture name in the format languagecode2-country/regioncode2 (e.g., "zh-cn" or "en-us"). This is based on current system settings. [Api set: ExcelApi 1.11]
/// Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings. [Api set: ExcelApi 1.11]
}
CultureInfo.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
return CultureInfo;
})(OfficeExtension.ClientObject);
Excel.CultureInfo = CultureInfo;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var CustomConditionalFormat = (function(_super) {
__extends(CustomConditionalFormat, _super);
function CustomConditionalFormat() {
/// Represents a custom conditional format type. [Api set: ExcelApi 1.6]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. [Api set: ExcelApi 1.6]
/// Specifies the `Rule` object on this conditional format. [Api set: ExcelApi 1.6]
}
CustomConditionalFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
CustomConditionalFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.CustomConditionalFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing CustomConditionalFormat object, with properties that have already been loaded and synced.
///
}
return CustomConditionalFormat;
})(OfficeExtension.ClientObject);
Excel.CustomConditionalFormat = CustomConditionalFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var CustomDataValidation = (function() {
function CustomDataValidation() {
/// Represents the custom data validation criteria. [Api set: ExcelApi 1.8]
/// A custom data validation formula. This creates special input rules, such as preventing duplicates, or limiting the total in a range of cells. [Api set: ExcelApi 1.8]
}
return CustomDataValidation;
})();
Interfaces.CustomDataValidation.__proto__ = null;
Interfaces.CustomDataValidation = CustomDataValidation;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var CustomProperty = (function(_super) {
__extends(CustomProperty, _super);
function CustomProperty() {
/// Represents a custom property. [Api set: ExcelApi 1.7]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// 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). [Api set: ExcelApi 1.7]
/// The type of the value used for the custom property. [Api set: ExcelApi 1.7]
/// 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). [Api set: ExcelApi 1.7]
}
CustomProperty.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
CustomProperty.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.CustomPropertyUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing CustomProperty object, with properties that have already been loaded and synced.
///
}
CustomProperty.prototype.delete = function() {
///
/// Deletes the custom property. [Api set: ExcelApi 1.7]
///
///
}
return CustomProperty;
})(OfficeExtension.ClientObject);
Excel.CustomProperty = CustomProperty;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var CustomPropertyCollection = (function(_super) {
__extends(CustomPropertyCollection, _super);
function CustomPropertyCollection() {
/// Contains the collection of custom properties. [Api set: ExcelApi 1.7]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
CustomPropertyCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
CustomPropertyCollection.prototype.add = function(key, value) {
///
/// Creates a new or sets an existing custom property. [Api set: ExcelApi 1.7]
///
/// 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).
/// 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).
///
}
CustomPropertyCollection.prototype.deleteAll = function() {
///
/// Deletes all custom properties in this collection. [Api set: ExcelApi 1.7]
///
///
}
CustomPropertyCollection.prototype.getCount = function() {
///
/// Gets the count of custom properties. [Api set: ExcelApi 1.7]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
CustomPropertyCollection.prototype.getItem = function(key) {
///
/// Gets a custom property object by its key, which is case-insensitive. Throws an error if the custom property does not exist. [Api set: ExcelApi 1.7]
///
/// The key that identifies the custom property object.
///
}
CustomPropertyCollection.prototype.getItemOrNullObject = function(key) {
///
/// Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.7]
///
/// Required. The key that identifies the custom property object.
///
}
return CustomPropertyCollection;
})(OfficeExtension.ClientObject);
Excel.CustomPropertyCollection = CustomPropertyCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var CustomXmlPart = (function(_super) {
__extends(CustomXmlPart, _super);
function CustomXmlPart() {
/// Represents a custom XML part object in a workbook. [Api set: ExcelApi 1.5]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// The custom XML part's ID. [Api set: ExcelApi 1.5]
/// The custom XML part's namespace URI. [Api set: ExcelApi 1.5]
}
CustomXmlPart.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
CustomXmlPart.prototype.delete = function() {
///
/// Deletes the custom XML part. [Api set: ExcelApi 1.5]
///
///
}
CustomXmlPart.prototype.getXml = function() {
///
/// Gets the custom XML part's full XML content. [Api set: ExcelApi 1.5]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = '';
return result;
}
CustomXmlPart.prototype.setXml = function(xml) {
///
/// Sets the custom XML part's full XML content. [Api set: ExcelApi 1.5]
///
/// XML content for the part.
///
}
return CustomXmlPart;
})(OfficeExtension.ClientObject);
Excel.CustomXmlPart = CustomXmlPart;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var CustomXmlPartCollection = (function(_super) {
__extends(CustomXmlPartCollection, _super);
function CustomXmlPartCollection() {
/// A collection of custom XML parts. [Api set: ExcelApi 1.5]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
CustomXmlPartCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
CustomXmlPartCollection.prototype.add = function(xml) {
///
/// Adds a new custom XML part to the workbook. [Api set: ExcelApi 1.5]
///
/// XML content. Must be a valid XML fragment.
///
}
CustomXmlPartCollection.prototype.getByNamespace = function(namespaceUri) {
///
/// Gets a new scoped collection of custom XML parts whose namespaces match the given namespace. [Api set: ExcelApi 1.5]
///
/// This must be a fully qualified schema URI; for example, "http://schemas.contoso.com/review/1.0".
///
}
CustomXmlPartCollection.prototype.getCount = function() {
///
/// Gets the number of custom XML parts in the collection. [Api set: ExcelApi 1.5]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
CustomXmlPartCollection.prototype.getItem = function(id) {
///
/// Gets a custom XML part based on its ID. [Api set: ExcelApi 1.5]
///
/// ID of the object to be retrieved.
///
}
CustomXmlPartCollection.prototype.getItemOrNullObject = function(id) {
///
/// Gets a custom XML part based on its ID. If the `CustomXmlPart` does not exist, then this function returns an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.5]
///
/// ID of the object to be retrieved.
///
}
return CustomXmlPartCollection;
})(OfficeExtension.ClientObject);
Excel.CustomXmlPartCollection = CustomXmlPartCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var CustomXmlPartScopedCollection = (function(_super) {
__extends(CustomXmlPartScopedCollection, _super);
function CustomXmlPartScopedCollection() {
/// A scoped collection of custom XML parts. A scoped collection is the result of some operation (e.g., filtering by namespace). A scoped collection cannot be scoped any further. [Api set: ExcelApi 1.5]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
CustomXmlPartScopedCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
CustomXmlPartScopedCollection.prototype.getCount = function() {
///
/// Gets the number of CustomXML parts in this collection. [Api set: ExcelApi 1.5]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
CustomXmlPartScopedCollection.prototype.getItem = function(id) {
///
/// Gets a custom XML part based on its ID. [Api set: ExcelApi 1.5]
///
/// ID of the object to be retrieved.
///
}
CustomXmlPartScopedCollection.prototype.getItemOrNullObject = function(id) {
///
/// Gets a custom XML part based on its ID. If the `CustomXmlPart` does not exist, then this function returns an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.5]
///
/// ID of the object to be retrieved.
///
}
CustomXmlPartScopedCollection.prototype.getOnlyItem = function() {
///
/// If the collection contains exactly one item, this method returns it. Otherwise, this method produces an error. [Api set: ExcelApi 1.5]
///
///
}
CustomXmlPartScopedCollection.prototype.getOnlyItemOrNullObject = function() {
///
/// If the collection contains exactly one item, this method returns it. Otherwise, this method returns `null`. [Api set: ExcelApi 1.5]
///
///
}
return CustomXmlPartScopedCollection;
})(OfficeExtension.ClientObject);
Excel.CustomXmlPartScopedCollection = CustomXmlPartScopedCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var DataBarConditionalFormat = (function(_super) {
__extends(DataBarConditionalFormat, _super);
function DataBarConditionalFormat() {
/// Represents an Excel conditional data bar type. [Api set: ExcelApi 1.6]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// 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. [Api set: ExcelApi 1.6]
/// Representation of how the axis is determined for an Excel data bar. [Api set: ExcelApi 1.6]
/// Specifies the direction that the data bar graphic should be based on. [Api set: ExcelApi 1.6]
/// The rule for what consistutes 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 = ...`). [Api set: ExcelApi 1.6]
/// Representation of all values to the left of the axis in an Excel data bar. [Api set: ExcelApi 1.6]
/// Representation of all values to the right of the axis in an Excel data bar. [Api set: ExcelApi 1.6]
/// If `true`, hides the values from the cells where the data bar is applied. [Api set: ExcelApi 1.6]
/// 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 = ...`). [Api set: ExcelApi 1.6]
}
DataBarConditionalFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
DataBarConditionalFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.DataBarConditionalFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing DataBarConditionalFormat object, with properties that have already been loaded and synced.
///
}
return DataBarConditionalFormat;
})(OfficeExtension.ClientObject);
Excel.DataBarConditionalFormat = DataBarConditionalFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.7]
var DataChangeType = {
__proto__: null,
"unknown": "unknown",
"rangeEdited": "rangeEdited",
"rowInserted": "rowInserted",
"rowDeleted": "rowDeleted",
"columnInserted": "columnInserted",
"columnDeleted": "columnDeleted",
"cellInserted": "cellInserted",
"cellDeleted": "cellDeleted",
}
Excel.DataChangeType = DataChangeType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var DataConnectionCollection = (function(_super) {
__extends(DataConnectionCollection, _super);
function DataConnectionCollection() {
/// Represents a collection of all the data connections that are part of the workbook or worksheet. [Api set: ExcelApi 1.7]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
}
DataConnectionCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
DataConnectionCollection.prototype.refreshAll = function() {
///
/// Refreshes all the data connections in the collection. [Api set: ExcelApi 1.7]
///
///
}
return DataConnectionCollection;
})(OfficeExtension.ClientObject);
Excel.DataConnectionCollection = DataConnectionCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var DataPivotHierarchy = (function(_super) {
__extends(DataPivotHierarchy, _super);
function DataPivotHierarchy() {
/// Represents the Excel DataPivotHierarchy. [Api set: ExcelApi 1.8]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Returns the PivotFields associated with the DataPivotHierarchy. [Api set: ExcelApi 1.8]
/// ID of the DataPivotHierarchy. [Api set: ExcelApi 1.8]
/// Name of the DataPivotHierarchy. [Api set: ExcelApi 1.8]
/// Number format of the DataPivotHierarchy. [Api set: ExcelApi 1.8]
/// Position of the DataPivotHierarchy. [Api set: ExcelApi 1.8]
/// Specifies if the data should be shown as a specific summary calculation. [Api set: ExcelApi 1.8]
/// Specifies if all items of the DataPivotHierarchy are shown. [Api set: ExcelApi 1.8]
}
DataPivotHierarchy.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
DataPivotHierarchy.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.DataPivotHierarchyUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing DataPivotHierarchy object, with properties that have already been loaded and synced.
///
}
DataPivotHierarchy.prototype.setToDefault = function() {
///
/// Reset the DataPivotHierarchy back to its default values. [Api set: ExcelApi 1.8]
///
///
}
return DataPivotHierarchy;
})(OfficeExtension.ClientObject);
Excel.DataPivotHierarchy = DataPivotHierarchy;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var DataPivotHierarchyCollection = (function(_super) {
__extends(DataPivotHierarchyCollection, _super);
function DataPivotHierarchyCollection() {
/// Represents a collection of DataPivotHierarchy items associated with the PivotTable. [Api set: ExcelApi 1.8]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
DataPivotHierarchyCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
DataPivotHierarchyCollection.prototype.add = function(pivotHierarchy) {
///
/// Adds the PivotHierarchy to the current axis. [Api set: ExcelApi 1.8]
///
///
}
DataPivotHierarchyCollection.prototype.getCount = function() {
///
/// Gets the number of pivot hierarchies in the collection. [Api set: ExcelApi 1.8]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
DataPivotHierarchyCollection.prototype.getItem = function(name) {
///
/// Gets a DataPivotHierarchy by its name or ID. [Api set: ExcelApi 1.8]
///
/// Name of the DataPivotHierarchy to be retrieved.
///
}
DataPivotHierarchyCollection.prototype.getItemOrNullObject = function(name) {
///
/// Gets a DataPivotHierarchy by name. If the DataPivotHierarchy does not exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.8]
///
/// Name of the DataPivotHierarchy to be retrieved.
///
}
DataPivotHierarchyCollection.prototype.remove = function(DataPivotHierarchy) {
///
/// Removes the PivotHierarchy from the current axis. [Api set: ExcelApi 1.8]
///
///
}
return DataPivotHierarchyCollection;
})(OfficeExtension.ClientObject);
Excel.DataPivotHierarchyCollection = DataPivotHierarchyCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var DataValidation = (function(_super) {
__extends(DataValidation, _super);
function DataValidation() {
/// Represents the data validation applied to the current range. To learn more about the data validation object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-data-validation | Add data validation to Excel ranges}. [Api set: ExcelApi 1.8]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Error alert when user enters invalid data. [Api set: ExcelApi 1.8]
/// Specifies if data validation will be performed on blank cells. Default is `true`. [Api set: ExcelApi 1.8]
/// Prompt when users select a cell. [Api set: ExcelApi 1.8]
/// Data validation rule that contains different type of data validation criteria. [Api set: ExcelApi 1.8]
/// Type of the data validation, see `Excel.DataValidationType` for details. [Api set: ExcelApi 1.8]
/// 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. [Api set: ExcelApi 1.8]
}
DataValidation.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
DataValidation.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.DataValidationUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing DataValidation object, with properties that have already been loaded and synced.
///
}
DataValidation.prototype.clear = function() {
///
/// Clears the data validation from the current range. [Api set: ExcelApi 1.8]
///
///
}
DataValidation.prototype.getInvalidCells = function() {
///
/// Returns a `RangeAreas` object, comprising one or more rectangular ranges, with invalid cell values. If all cell values are valid, this function will throw an `ItemNotFound` error. [Api set: ExcelApi 1.9]
///
///
}
DataValidation.prototype.getInvalidCellsOrNullObject = function() {
///
/// 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`. [Api set: ExcelApi 1.9]
///
///
}
return DataValidation;
})(OfficeExtension.ClientObject);
Excel.DataValidation = DataValidation;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the data validation error alert style. The default is `Stop`. [Api set: ExcelApi 1.8]
var DataValidationAlertStyle = {
__proto__: null,
"stop": "stop",
"warning": "warning",
"information": "information",
}
Excel.DataValidationAlertStyle = DataValidationAlertStyle;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var DataValidationErrorAlert = (function() {
function DataValidationErrorAlert() {
/// Represents the error alert properties for the data validation. [Api set: ExcelApi 1.8]
/// Represents the error alert message. [Api set: ExcelApi 1.8]
/// Specifies whether to show an error alert dialog when a user enters invalid data. The default is `true`. [Api set: ExcelApi 1.8]
/// The data validation alert type, please see `Excel.DataValidationAlertStyle` for details. [Api set: ExcelApi 1.8]
/// Represents the error alert dialog title. [Api set: ExcelApi 1.8]
}
return DataValidationErrorAlert;
})();
Interfaces.DataValidationErrorAlert.__proto__ = null;
Interfaces.DataValidationErrorAlert = DataValidationErrorAlert;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the data validation operator enum. [Api set: ExcelApi 1.8]
var DataValidationOperator = {
__proto__: null,
"between": "between",
"notBetween": "notBetween",
"equalTo": "equalTo",
"notEqualTo": "notEqualTo",
"greaterThan": "greaterThan",
"lessThan": "lessThan",
"greaterThanOrEqualTo": "greaterThanOrEqualTo",
"lessThanOrEqualTo": "lessThanOrEqualTo",
}
Excel.DataValidationOperator = DataValidationOperator;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var DataValidationPrompt = (function() {
function DataValidationPrompt() {
/// Represents the user prompt properties for the data validation. [Api set: ExcelApi 1.8]
/// Specifies the message of the prompt. [Api set: ExcelApi 1.8]
/// Specifies if a prompt is shown when a user selects a cell with data validation. [Api set: ExcelApi 1.8]
/// Specifies the title for the prompt. [Api set: ExcelApi 1.8]
}
return DataValidationPrompt;
})();
Interfaces.DataValidationPrompt.__proto__ = null;
Interfaces.DataValidationPrompt = DataValidationPrompt;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var DataValidationRule = (function() {
function DataValidationRule() {
/// A data validation rule contains different types of data validation. You can only use one of them at a time according the `Excel.DataValidationType`. [Api set: ExcelApi 1.8]
/// Custom data validation criteria. [Api set: ExcelApi 1.8]
/// Date data validation criteria. [Api set: ExcelApi 1.8]
/// Decimal data validation criteria. [Api set: ExcelApi 1.8]
/// List data validation criteria. [Api set: ExcelApi 1.8]
/// Text length data validation criteria. [Api set: ExcelApi 1.8]
/// Time data validation criteria. [Api set: ExcelApi 1.8]
/// Whole number data validation criteria. [Api set: ExcelApi 1.8]
}
return DataValidationRule;
})();
Interfaces.DataValidationRule.__proto__ = null;
Interfaces.DataValidationRule = DataValidationRule;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the data validation type enum. [Api set: ExcelApi 1.8]
var DataValidationType = {
__proto__: null,
"none": "none",
"wholeNumber": "wholeNumber",
"decimal": "decimal",
"list": "list",
"date": "date",
"time": "time",
"textLength": "textLength",
"custom": "custom",
"inconsistent": "inconsistent",
"mixedCriteria": "mixedCriteria",
}
Excel.DataValidationType = DataValidationType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// 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. [Api set: ExcelApi 1.12]
var DateFilterCondition = {
__proto__: null,
"unknown": "unknown",
"equals": "equals",
"before": "before",
"beforeOrEqualTo": "beforeOrEqualTo",
"after": "after",
"afterOrEqualTo": "afterOrEqualTo",
"between": "between",
"tomorrow": "tomorrow",
"today": "today",
"yesterday": "yesterday",
"nextWeek": "nextWeek",
"thisWeek": "thisWeek",
"lastWeek": "lastWeek",
"nextMonth": "nextMonth",
"thisMonth": "thisMonth",
"lastMonth": "lastMonth",
"nextQuarter": "nextQuarter",
"thisQuarter": "thisQuarter",
"lastQuarter": "lastQuarter",
"nextYear": "nextYear",
"thisYear": "thisYear",
"lastYear": "lastYear",
"yearToDate": "yearToDate",
"allDatesInPeriodQuarter1": "allDatesInPeriodQuarter1",
"allDatesInPeriodQuarter2": "allDatesInPeriodQuarter2",
"allDatesInPeriodQuarter3": "allDatesInPeriodQuarter3",
"allDatesInPeriodQuarter4": "allDatesInPeriodQuarter4",
"allDatesInPeriodJanuary": "allDatesInPeriodJanuary",
"allDatesInPeriodFebruary": "allDatesInPeriodFebruary",
"allDatesInPeriodMarch": "allDatesInPeriodMarch",
"allDatesInPeriodApril": "allDatesInPeriodApril",
"allDatesInPeriodMay": "allDatesInPeriodMay",
"allDatesInPeriodJune": "allDatesInPeriodJune",
"allDatesInPeriodJuly": "allDatesInPeriodJuly",
"allDatesInPeriodAugust": "allDatesInPeriodAugust",
"allDatesInPeriodSeptember": "allDatesInPeriodSeptember",
"allDatesInPeriodOctober": "allDatesInPeriodOctober",
"allDatesInPeriodNovember": "allDatesInPeriodNovember",
"allDatesInPeriodDecember": "allDatesInPeriodDecember",
}
Excel.DateFilterCondition = DateFilterCondition;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var DateTimeDataValidation = (function() {
function DateTimeDataValidation() {
/// Represents the date data validation criteria. [Api set: ExcelApi 1.8]
/// 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. [Api set: ExcelApi 1.8]
/// 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. [Api set: ExcelApi 1.8]
/// The operator to use for validating the data. [Api set: ExcelApi 1.8]
}
return DateTimeDataValidation;
})();
Interfaces.DateTimeDataValidation.__proto__ = null;
Interfaces.DateTimeDataValidation = DateTimeDataValidation;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var DatetimeFormatInfo = (function(_super) {
__extends(DatetimeFormatInfo, _super);
function DatetimeFormatInfo() {
/// Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings. [Api set: ExcelApi 1.12]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the string used as the date separator. This is based on current system settings. [Api set: ExcelApi 1.12]
/// Gets the format string for a long date value. This is based on current system settings. [Api set: ExcelApi 1.12]
/// Gets the format string for a long time value. This is based on current system settings. [Api set: ExcelApi 1.12]
/// Gets the format string for a short date value. This is based on current system settings. [Api set: ExcelApi 1.12]
/// Gets the string used as the time separator. This is based on current system settings. [Api set: ExcelApi 1.12]
}
DatetimeFormatInfo.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
return DatetimeFormatInfo;
})(OfficeExtension.ClientObject);
Excel.DatetimeFormatInfo = DatetimeFormatInfo;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.1]
var DeleteShiftDirection = {
__proto__: null,
"up": "up",
"left": "left",
}
Excel.DeleteShiftDirection = DeleteShiftDirection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var DocumentProperties = (function(_super) {
__extends(DocumentProperties, _super);
function DocumentProperties() {
/// Represents workbook properties. [Api set: ExcelApi 1.7]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// The author of the workbook. [Api set: ExcelApi 1.7]
/// The category of the workbook. [Api set: ExcelApi 1.7]
/// The comments of the workbook. [Api set: ExcelApi 1.7]
/// The company of the workbook. [Api set: ExcelApi 1.7]
/// Gets the creation date of the workbook. Read only. [Api set: ExcelApi 1.7]
/// Gets the collection of custom properties of the workbook. Read only. [Api set: ExcelApi 1.7]
/// The keywords of the workbook. [Api set: ExcelApi 1.7]
/// Gets the last author of the workbook. Read only. [Api set: ExcelApi 1.7]
/// The manager of the workbook. [Api set: ExcelApi 1.7]
/// Gets the revision number of the workbook. Read only. [Api set: ExcelApi 1.7]
/// The subject of the workbook. [Api set: ExcelApi 1.7]
/// The title of the workbook. [Api set: ExcelApi 1.7]
}
DocumentProperties.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
DocumentProperties.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.DocumentPropertiesUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing DocumentProperties object, with properties that have already been loaded and synced.
///
}
return DocumentProperties;
})(OfficeExtension.ClientObject);
Excel.DocumentProperties = DocumentProperties;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.7]
var DocumentPropertyItem = {
__proto__: null,
"title": "title",
"subject": "subject",
"author": "author",
"keywords": "keywords",
"comments": "comments",
"template": "template",
"lastAuth": "lastAuth",
"revision": "revision",
"appName": "appName",
"lastPrint": "lastPrint",
"creation": "creation",
"lastSave": "lastSave",
"category": "category",
"format": "format",
"manager": "manager",
"company": "company",
}
Excel.DocumentPropertyItem = DocumentPropertyItem;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.7]
var DocumentPropertyType = {
__proto__: null,
"number": "number",
"boolean": "boolean",
"date": "date",
"string": "string",
"float": "float",
}
Excel.DocumentPropertyType = DocumentPropertyType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.2]
var DynamicFilterCriteria = {
__proto__: null,
"unknown": "unknown",
"aboveAverage": "aboveAverage",
"allDatesInPeriodApril": "allDatesInPeriodApril",
"allDatesInPeriodAugust": "allDatesInPeriodAugust",
"allDatesInPeriodDecember": "allDatesInPeriodDecember",
"allDatesInPeriodFebruray": "allDatesInPeriodFebruray",
"allDatesInPeriodJanuary": "allDatesInPeriodJanuary",
"allDatesInPeriodJuly": "allDatesInPeriodJuly",
"allDatesInPeriodJune": "allDatesInPeriodJune",
"allDatesInPeriodMarch": "allDatesInPeriodMarch",
"allDatesInPeriodMay": "allDatesInPeriodMay",
"allDatesInPeriodNovember": "allDatesInPeriodNovember",
"allDatesInPeriodOctober": "allDatesInPeriodOctober",
"allDatesInPeriodQuarter1": "allDatesInPeriodQuarter1",
"allDatesInPeriodQuarter2": "allDatesInPeriodQuarter2",
"allDatesInPeriodQuarter3": "allDatesInPeriodQuarter3",
"allDatesInPeriodQuarter4": "allDatesInPeriodQuarter4",
"allDatesInPeriodSeptember": "allDatesInPeriodSeptember",
"belowAverage": "belowAverage",
"lastMonth": "lastMonth",
"lastQuarter": "lastQuarter",
"lastWeek": "lastWeek",
"lastYear": "lastYear",
"nextMonth": "nextMonth",
"nextQuarter": "nextQuarter",
"nextWeek": "nextWeek",
"nextYear": "nextYear",
"thisMonth": "thisMonth",
"thisQuarter": "thisQuarter",
"thisWeek": "thisWeek",
"thisYear": "thisYear",
"today": "today",
"tomorrow": "tomorrow",
"yearToDate": "yearToDate",
"yesterday": "yesterday",
}
Excel.DynamicFilterCriteria = DynamicFilterCriteria;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.7]
var EventSource = {
__proto__: null,
"local": "local",
"remote": "remote",
}
Excel.EventSource = EventSource;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.14]
var EventTriggerSource = {
__proto__: null,
"unknown": "unknown",
"thisLocalAddin": "thisLocalAddin",
}
Excel.EventTriggerSource = EventTriggerSource;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.7]
var EventType = {
__proto__: null,
"worksheetChanged": "worksheetChanged",
"worksheetSelectionChanged": "worksheetSelectionChanged",
"worksheetAdded": "worksheetAdded",
"worksheetActivated": "worksheetActivated",
"worksheetDeactivated": "worksheetDeactivated",
"tableChanged": "tableChanged",
"tableSelectionChanged": "tableSelectionChanged",
"worksheetDeleted": "worksheetDeleted",
"chartAdded": "chartAdded",
"chartActivated": "chartActivated",
"chartDeactivated": "chartDeactivated",
"chartDeleted": "chartDeleted",
"worksheetCalculated": "worksheetCalculated",
"visualSelectionChanged": "visualSelectionChanged",
"agaveVisualUpdate": "agaveVisualUpdate",
"tableAdded": "tableAdded",
"tableDeleted": "tableDeleted",
"tableFiltered": "tableFiltered",
"worksheetFiltered": "worksheetFiltered",
"shapeActivated": "shapeActivated",
"shapeDeactivated": "shapeDeactivated",
"visualChange": "visualChange",
"workbookAutoSaveSettingChanged": "workbookAutoSaveSettingChanged",
"worksheetFormatChanged": "worksheetFormatChanged",
"wacoperationEvent": "wacoperationEvent",
"ribbonCommandExecuted": "ribbonCommandExecuted",
"worksheetRowSorted": "worksheetRowSorted",
"worksheetColumnSorted": "worksheetColumnSorted",
"worksheetSingleClicked": "worksheetSingleClicked",
"worksheetRowHiddenChanged": "worksheetRowHiddenChanged",
"recordingStateChangedEvent": "recordingStateChangedEvent",
"commentAdded": "commentAdded",
"commentDeleted": "commentDeleted",
"commentChanged": "commentChanged",
"linkedDataTypeRefreshRequestCompleted": "linkedDataTypeRefreshRequestCompleted",
"linkedDataTypeRefreshModeChanged": "linkedDataTypeRefreshModeChanged",
"linkedDataTypeLinkedDataTypeAdded": "linkedDataTypeLinkedDataTypeAdded",
"worksheetFormulaChanged": "worksheetFormulaChanged",
"workbookActivated": "workbookActivated",
"linkedWorkbookWorkbookLinksChanged": "linkedWorkbookWorkbookLinksChanged",
"linkedWorkbookRefreshCompleted": "linkedWorkbookRefreshCompleted",
"worksheetProtectionChanged": "worksheetProtectionChanged",
"worksheetNameChanged": "worksheetNameChanged",
"worksheetVisibilityChanged": "worksheetVisibilityChanged",
"worksheetMoved": "worksheetMoved",
"lineageActivityUpdateAvailable": "lineageActivityUpdateAvailable",
}
Excel.EventType = EventType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.9]
var FillPattern = {
__proto__: null,
"none": "none",
"solid": "solid",
"gray50": "gray50",
"gray75": "gray75",
"gray25": "gray25",
"horizontal": "horizontal",
"vertical": "vertical",
"down": "down",
"up": "up",
"checker": "checker",
"semiGray75": "semiGray75",
"lightHorizontal": "lightHorizontal",
"lightVertical": "lightVertical",
"lightDown": "lightDown",
"lightUp": "lightUp",
"grid": "grid",
"crissCross": "crissCross",
"gray16": "gray16",
"gray8": "gray8",
"linearGradient": "linearGradient",
"rectangularGradient": "rectangularGradient",
}
Excel.FillPattern = FillPattern;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Filter = (function(_super) {
__extends(Filter, _super);
function Filter() {
/// Manages the filtering of a table's column. [Api set: ExcelApi 1.2]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// The currently applied filter on the given column. [Api set: ExcelApi 1.2]
}
Filter.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Filter.prototype.apply = function(criteria) {
///
/// Apply the given filter criteria on the given column. [Api set: ExcelApi 1.2]
///
/// The criteria to apply.
///
}
Filter.prototype.applyBottomItemsFilter = function(count) {
///
/// Apply a "Bottom Item" filter to the column for the given number of elements. [Api set: ExcelApi 1.2]
///
/// The number of elements from the bottom to show.
///
}
Filter.prototype.applyBottomPercentFilter = function(percent) {
///
/// Apply a "Bottom Percent" filter to the column for the given percentage of elements. [Api set: ExcelApi 1.2]
///
/// The percentage of elements from the bottom to show.
///
}
Filter.prototype.applyCellColorFilter = function(color) {
///
/// Apply a "Cell Color" filter to the column for the given color. [Api set: ExcelApi 1.2]
///
/// The background color of the cells to show.
///
}
Filter.prototype.applyCustomFilter = function(criteria1, criteria2, oper) {
///
/// Apply an "Icon" filter to the column for the given criteria strings. [Api set: ExcelApi 1.2]
///
/// The first criteria string.
/// Optional. The second criteria string.
/// Optional. The operator that describes how the two criteria are joined.
///
}
Filter.prototype.applyDynamicFilter = function(criteria) {
///
/// Apply a "Dynamic" filter to the column. [Api set: ExcelApi 1.2]
///
/// The dynamic criteria to apply.
///
}
Filter.prototype.applyFontColorFilter = function(color) {
///
/// Apply a "Font Color" filter to the column for the given color. [Api set: ExcelApi 1.2]
///
/// The font color of the cells to show.
///
}
Filter.prototype.applyIconFilter = function(icon) {
///
/// Apply an "Icon" filter to the column for the given icon. [Api set: ExcelApi 1.2]
///
/// The icons of the cells to show.
///
}
Filter.prototype.applyTopItemsFilter = function(count) {
///
/// Apply a "Top Item" filter to the column for the given number of elements. [Api set: ExcelApi 1.2]
///
/// The number of elements from the top to show.
///
}
Filter.prototype.applyTopPercentFilter = function(percent) {
///
/// Apply a "Top Percent" filter to the column for the given percentage of elements. [Api set: ExcelApi 1.2]
///
/// The percentage of elements from the top to show.
///
}
Filter.prototype.applyValuesFilter = function(values) {
///
/// Apply a "Values" filter to the column for the given values. [Api set: ExcelApi 1.2]
///
/// The list of values to show. This must be an array of strings or an array of `Excel.FilterDateTime` objects.
///
}
Filter.prototype.clear = function() {
///
/// Clear the filter on the given column. [Api set: ExcelApi 1.2]
///
///
}
return Filter;
})(OfficeExtension.ClientObject);
Excel.Filter = Filter;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var FilterCriteria = (function() {
function FilterCriteria() {
/// Represents the filtering criteria applied to a column. [Api set: ExcelApi 1.2]
/// The HTML color string used to filter cells. Used with `cellColor` and `fontColor` filtering. [Api set: ExcelApi 1.2]
/// 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`). [Api set: ExcelApi 1.2]
/// The second criterion used to filter data. Only used as an operator in the case of `custom` filtering. [Api set: ExcelApi 1.2]
/// The dynamic criteria from the `Excel.DynamicFilterCriteria` set to apply on this column. Used with `dynamic` filtering. [Api set: ExcelApi 1.2]
/// The property used by the filter to determine whether the values should stay visible. [Api set: ExcelApi 1.2]
/// The icon used to filter cells. Used with `icon` filtering. [Api set: ExcelApi 1.2]
/// The operator used to combine criterion 1 and 2 when using `custom` filtering. [Api set: ExcelApi 1.2]
/// The property used by the filter to do a rich filter on rich values. [Api set: ExcelApi 1.9]
/// The set of values to be used as part of `values` filtering. [Api set: ExcelApi 1.2]
}
return FilterCriteria;
})();
Interfaces.FilterCriteria.__proto__ = null;
Interfaces.FilterCriteria = FilterCriteria;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var FilterDatetime = (function() {
function FilterDatetime() {
/// Represents how to filter a date when filtering on values. [Api set: ExcelApi 1.2]
/// The date in ISO8601 format used to filter data. [Api set: ExcelApi 1.2]
/// How specific the date should be used to keep data. For example, if the date is 2005-04-02 and the specifity is set to "month", the filter operation will keep all rows with a date in the month of April 2005. [Api set: ExcelApi 1.2]
}
return FilterDatetime;
})();
Interfaces.FilterDatetime.__proto__ = null;
Interfaces.FilterDatetime = FilterDatetime;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.2]
var FilterDatetimeSpecificity = {
__proto__: null,
"year": "year",
"month": "month",
"day": "day",
"hour": "hour",
"minute": "minute",
"second": "second",
}
Excel.FilterDatetimeSpecificity = FilterDatetimeSpecificity;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.2]
var FilterOn = {
__proto__: null,
"bottomItems": "bottomItems",
"bottomPercent": "bottomPercent",
"cellColor": "cellColor",
"dynamic": "dynamic",
"fontColor": "fontColor",
"values": "values",
"topItems": "topItems",
"topPercent": "topPercent",
"icon": "icon",
"custom": "custom",
}
Excel.FilterOn = FilterOn;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.2]
var FilterOperator = {
__proto__: null,
"and": "and",
"or": "or",
}
Excel.FilterOperator = FilterOperator;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var FilterPivotHierarchy = (function(_super) {
__extends(FilterPivotHierarchy, _super);
function FilterPivotHierarchy() {
/// Represents the Excel FilterPivotHierarchy. [Api set: ExcelApi 1.8]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Determines whether to allow multiple filter items. [Api set: ExcelApi 1.8]
/// Returns the PivotFields associated with the FilterPivotHierarchy. [Api set: ExcelApi 1.8]
/// ID of the FilterPivotHierarchy. [Api set: ExcelApi 1.8]
/// Name of the FilterPivotHierarchy. [Api set: ExcelApi 1.8]
/// Position of the FilterPivotHierarchy. [Api set: ExcelApi 1.8]
}
FilterPivotHierarchy.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
FilterPivotHierarchy.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.FilterPivotHierarchyUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing FilterPivotHierarchy object, with properties that have already been loaded and synced.
///
}
FilterPivotHierarchy.prototype.setToDefault = function() {
///
/// Reset the FilterPivotHierarchy back to its default values. [Api set: ExcelApi 1.8]
///
///
}
return FilterPivotHierarchy;
})(OfficeExtension.ClientObject);
Excel.FilterPivotHierarchy = FilterPivotHierarchy;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var FilterPivotHierarchyCollection = (function(_super) {
__extends(FilterPivotHierarchyCollection, _super);
function FilterPivotHierarchyCollection() {
/// Represents a collection of FilterPivotHierarchy items associated with the PivotTable. [Api set: ExcelApi 1.8]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
FilterPivotHierarchyCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
FilterPivotHierarchyCollection.prototype.add = function(pivotHierarchy) {
///
/// 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. [Api set: ExcelApi 1.8]
///
///
}
FilterPivotHierarchyCollection.prototype.getCount = function() {
///
/// Gets the number of pivot hierarchies in the collection. [Api set: ExcelApi 1.8]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
FilterPivotHierarchyCollection.prototype.getItem = function(name) {
///
/// Gets a FilterPivotHierarchy by its name or ID. [Api set: ExcelApi 1.8]
///
/// Name of the FilterPivotHierarchy to be retrieved.
///
}
FilterPivotHierarchyCollection.prototype.getItemOrNullObject = function(name) {
///
/// Gets a FilterPivotHierarchy by name. If the FilterPivotHierarchy does not exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.8]
///
/// Name of the FilterPivotHierarchy to be retrieved.
///
}
FilterPivotHierarchyCollection.prototype.remove = function(filterPivotHierarchy) {
///
/// Removes the PivotHierarchy from the current axis. [Api set: ExcelApi 1.8]
///
///
}
return FilterPivotHierarchyCollection;
})(OfficeExtension.ClientObject);
Excel.FilterPivotHierarchyCollection = FilterPivotHierarchyCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var FormatProtection = (function(_super) {
__extends(FormatProtection, _super);
function FormatProtection() {
/// Represents the format protection of a range object. [Api set: ExcelApi 1.2]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// 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. [Api set: ExcelApi 1.2]
/// Specifies if Excel locks the cells in the object. A `null` value indicates that the entire range doesn't have a uniform lock setting. [Api set: ExcelApi 1.2]
}
FormatProtection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
FormatProtection.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.FormatProtectionUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing FormatProtection object, with properties that have already been loaded and synced.
///
}
return FormatProtection;
})(OfficeExtension.ClientObject);
Excel.FormatProtection = FormatProtection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var FormulaChangedEventDetail = (function() {
function FormulaChangedEventDetail() {
/// Provides information about a changed formula during a formula changed event. [Api set: ExcelApi 1.13]
/// The address of the cell that contains the changed formula. [Api set: ExcelApi 1.13]
/// Represents the previous formula, before it was changed. [Api set: ExcelApi 1.13]
}
return FormulaChangedEventDetail;
})();
Interfaces.FormulaChangedEventDetail.__proto__ = null;
Interfaces.FormulaChangedEventDetail = FormulaChangedEventDetail;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var FunctionResult = (function(_super) {
__extends(FunctionResult, _super);
function FunctionResult() {
/// An object containing the result of a function-evaluation operation [Api set: ExcelApi 1.2]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Error value (such as "#DIV/0") representing the error. If the error string is not set, then the function succeeded, and its result is written to the Value field. The error is always in the English locale. [Api set: ExcelApi 1.2]
/// The value of function evaluation. The value field will be populated only if no error has occurred (i.e., the Error property is not set). [Api set: ExcelApi 1.2]
}
FunctionResult.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
return FunctionResult;
})(OfficeExtension.ClientObject);
Excel.FunctionResult = FunctionResult;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Functions = (function(_super) {
__extends(Functions, _super);
function Functions() {
/// An object for evaluating Excel functions. [Api set: ExcelApi 1.2]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
}
Functions.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Functions.prototype.abs = function(number) {
///
/// Returns the absolute value of a number, a number without its sign. [Api set: ExcelApi 1.2]
///
/// Is the real number for which you want the absolute value.
///
}
Functions.prototype.accrInt = function(issue, firstInterest, settlement, rate, par, frequency, basis, calcMethod) {
///
/// Returns the accrued interest for a security that pays periodic interest. [Api set: ExcelApi 1.2]
///
/// Is the security's issue date, expressed as a serial date number.
/// Is the security's first interest date, expressed as a serial date number.
/// Is the security's settlement date, expressed as a serial date number.
/// Is the security's annual coupon rate.
/// Is the security's par value.
/// Is the number of coupon payments per year.
/// Is the type of day count basis to use.
/// Is a logical value: to accrued interest from issue date = TRUE or omitted; to calculate from last coupon payment date = FALSE.
///
}
Functions.prototype.accrIntM = function(issue, settlement, rate, par, basis) {
///
/// Returns the accrued interest for a security that pays interest at maturity. [Api set: ExcelApi 1.2]
///
/// Is the security's issue date, expressed as a serial date number.
/// Is the security's maturity date, expressed as a serial date number.
/// Is the security's annual coupon rate.
/// Is the security's par value.
/// Is the type of day count basis to use.
///
}
Functions.prototype.acos = function(number) {
///
/// Returns the arccosine of a number, in radians in the range 0 to Pi. The arccosine is the angle whose cosine is Number. [Api set: ExcelApi 1.2]
///
/// Is the cosine of the angle you want and must be from -1 to 1.
///
}
Functions.prototype.acosh = function(number) {
///
/// Returns the inverse hyperbolic cosine of a number. [Api set: ExcelApi 1.2]
///
/// Is any real number equal to or greater than 1.
///
}
Functions.prototype.acot = function(number) {
///
/// Returns the arccotangent of a number, in radians in the range 0 to Pi. [Api set: ExcelApi 1.2]
///
/// Is the cotangent of the angle you want.
///
}
Functions.prototype.acoth = function(number) {
///
/// Returns the inverse hyperbolic cotangent of a number. [Api set: ExcelApi 1.2]
///
/// Is the hyperbolic cotangent of the angle that you want.
///
}
Functions.prototype.amorDegrc = function(cost, datePurchased, firstPeriod, salvage, period, rate, basis) {
///
/// Returns the prorated linear depreciation of an asset for each accounting period. [Api set: ExcelApi 1.2]
///
/// Is the cost of the asset.
/// Is the date the asset is purchased.
/// Is the date of the end of the first period.
/// Is the salvage value at the end of life of the asset.
/// Is the period.
/// Is the rate of depreciation.
/// Year_basis : 0 for year of 360 days, 1 for actual, 3 for year of 365 days.
///
}
Functions.prototype.amorLinc = function(cost, datePurchased, firstPeriod, salvage, period, rate, basis) {
///
/// Returns the prorated linear depreciation of an asset for each accounting period. [Api set: ExcelApi 1.2]
///
/// Is the cost of the asset.
/// Is the date the asset is purchased.
/// Is the date of the end of the first period.
/// Is the salvage value at the end of life of the asset.
/// Is the period.
/// Is the rate of depreciation.
/// Year_basis : 0 for year of 360 days, 1 for actual, 3 for year of 365 days.
///
}
Functions.prototype.and = function(values) {
///
/// Checks whether all arguments are TRUE, and returns TRUE if all arguments are TRUE. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 conditions you want to test that can be either TRUE or FALSE and can be logical values, arrays, or references.
///
}
Functions.prototype.arabic = function(text) {
///
/// Converts a Roman numeral to Arabic. [Api set: ExcelApi 1.2]
///
/// Is the Roman numeral you want to convert.
///
}
Functions.prototype.areas = function(reference) {
///
/// Returns the number of areas in a reference. An area is a range of contiguous cells or a single cell. [Api set: ExcelApi 1.2]
///
/// Is a reference to a cell or range of cells and can refer to multiple areas.
///
}
Functions.prototype.asc = function(text) {
///
/// Changes full-width (double-byte) characters to half-width (single-byte) characters. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2]
///
/// Is a text, or a reference to a cell containing a text.
///
}
Functions.prototype.asin = function(number) {
///
/// Returns the arcsine of a number in radians, in the range -Pi/2 to Pi/2. [Api set: ExcelApi 1.2]
///
/// Is the sine of the angle you want and must be from -1 to 1.
///
}
Functions.prototype.asinh = function(number) {
///
/// Returns the inverse hyperbolic sine of a number. [Api set: ExcelApi 1.2]
///
/// Is any real number equal to or greater than 1.
///
}
Functions.prototype.atan = function(number) {
///
/// Returns the arctangent of a number in radians, in the range -Pi/2 to Pi/2. [Api set: ExcelApi 1.2]
///
/// Is the tangent of the angle you want.
///
}
Functions.prototype.atan2 = function(xNum, yNum) {
///
/// Returns the arctangent of the specified x- and y- coordinates, in radians between -Pi and Pi, excluding -Pi. [Api set: ExcelApi 1.2]
///
/// Is the x-coordinate of the point.
/// Is the y-coordinate of the point.
///
}
Functions.prototype.atanh = function(number) {
///
/// Returns the inverse hyperbolic tangent of a number. [Api set: ExcelApi 1.2]
///
/// Is any real number between -1 and 1 excluding -1 and 1.
///
}
Functions.prototype.aveDev = function(values) {
///
/// Returns the average of the absolute deviations of data points from their mean. Arguments can be numbers or names, arrays, or references that contain numbers. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 arguments for which you want the average of the absolute deviations.
///
}
Functions.prototype.average = function(values) {
///
/// Returns the average (arithmetic mean) of its arguments, which can be numbers or names, arrays, or references that contain numbers. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 numeric arguments for which you want the average.
///
}
Functions.prototype.averageA = function(values) {
///
/// Returns the average (arithmetic mean) of its arguments, evaluating text and FALSE in arguments as 0; TRUE evaluates as 1. Arguments can be numbers, names, arrays, or references. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 arguments for which you want the average.
///
}
Functions.prototype.averageIf = function(range, criteria, averageRange) {
///
/// Finds average(arithmetic mean) for the cells specified by a given condition or criteria. [Api set: ExcelApi 1.2]
///
/// Is the range of cells you want evaluated.
/// Is the condition or criteria in the form of a number, expression, or text that defines which cells will be used to find the average.
/// Are the actual cells to be used to find the average. If omitted, the cells in range are used.
///
}
Functions.prototype.averageIfs = function(averageRange, values) {
///
/// Finds average(arithmetic mean) for the cells specified by a given set of conditions or criteria. [Api set: ExcelApi 1.2]
///
/// Are the actual cells to be used to find the average.
/// List of parameters, where the first element of each pair is the Is the range of cells you want evaluated for the particular condition , and the second element is is the condition or criteria in the form of a number, expression, or text that defines which cells will be used to find the average.
///
}
Functions.prototype.bahtText = function(number) {
///
/// Converts a number to text (baht). [Api set: ExcelApi 1.2]
///
/// Is a number that you want to convert.
///
}
Functions.prototype.base = function(number, radix, minLength) {
///
/// Converts a number into a text representation with the given radix (base). [Api set: ExcelApi 1.2]
///
/// Is the number that you want to convert.
/// Is the base Radix that you want to convert the number into.
/// Is the minimum length of the returned string. If omitted leading zeros are not added.
///
}
Functions.prototype.besselI = function(x, n) {
///
/// Returns the modified Bessel function In(x). [Api set: ExcelApi 1.2]
///
/// Is the value at which to evaluate the function.
/// Is the order of the Bessel function.
///
}
Functions.prototype.besselJ = function(x, n) {
///
/// Returns the Bessel function Jn(x). [Api set: ExcelApi 1.2]
///
/// Is the value at which to evaluate the function.
/// Is the order of the Bessel function.
///
}
Functions.prototype.besselK = function(x, n) {
///
/// Returns the modified Bessel function Kn(x). [Api set: ExcelApi 1.2]
///
/// Is the value at which to evaluate the function.
/// Is the order of the function.
///
}
Functions.prototype.besselY = function(x, n) {
///
/// Returns the Bessel function Yn(x). [Api set: ExcelApi 1.2]
///
/// Is the value at which to evaluate the function.
/// Is the order of the function.
///
}
Functions.prototype.beta_Dist = function(x, alpha, beta, cumulative, A, B) {
///
/// Returns the beta probability distribution function. [Api set: ExcelApi 1.2]
///
/// Is the value between A and B at which to evaluate the function.
/// Is a parameter to the distribution and must be greater than 0.
/// Is a parameter to the distribution and must be greater than 0.
/// Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE.
/// Is an optional lower bound to the interval of x. If omitted, A = 0.
/// Is an optional upper bound to the interval of x. If omitted, B = 1.
///
}
Functions.prototype.beta_Inv = function(probability, alpha, beta, A, B) {
///
/// Returns the inverse of the cumulative beta probability density function (BETA.DIST). [Api set: ExcelApi 1.2]
///
/// Is a probability associated with the beta distribution.
/// Is a parameter to the distribution and must be greater than 0.
/// Is a parameter to the distribution and must be greater than 0.
/// Is an optional lower bound to the interval of x. If omitted, A = 0.
/// Is an optional upper bound to the interval of x. If omitted, B = 1.
///
}
Functions.prototype.bin2Dec = function(number) {
///
/// Converts a binary number to decimal. [Api set: ExcelApi 1.2]
///
/// Is the binary number you want to convert.
///
}
Functions.prototype.bin2Hex = function(number, places) {
///
/// Converts a binary number to hexadecimal. [Api set: ExcelApi 1.2]
///
/// Is the binary number you want to convert.
/// Is the number of characters to use.
///
}
Functions.prototype.bin2Oct = function(number, places) {
///
/// Converts a binary number to octal. [Api set: ExcelApi 1.2]
///
/// Is the binary number you want to convert.
/// Is the number of characters to use.
///
}
Functions.prototype.binom_Dist = function(numberS, trials, probabilityS, cumulative) {
///
/// Returns the individual term binomial distribution probability. [Api set: ExcelApi 1.2]
///
/// Is the number of successes in trials.
/// Is the number of independent trials.
/// Is the probability of success on each trial.
/// Is a logical value: for the cumulative distribution function, use TRUE; for the probability mass function, use FALSE.
///
}
Functions.prototype.binom_Dist_Range = function(trials, probabilityS, numberS, numberS2) {
///
/// Returns the probability of a trial result using a binomial distribution. [Api set: ExcelApi 1.2]
///
/// Is the number of independent trials.
/// Is the probability of success on each trial.
/// Is the number of successes in trials.
/// If provided this function returns the probability that the number of successful trials shall lie between numberS and numberS2.
///
}
Functions.prototype.binom_Inv = function(trials, probabilityS, alpha) {
///
/// Returns the smallest value for which the cumulative binomial distribution is greater than or equal to a criterion value. [Api set: ExcelApi 1.2]
///
/// Is the number of Bernoulli trials.
/// Is the probability of success on each trial, a number between 0 and 1 inclusive.
/// Is the criterion value, a number between 0 and 1 inclusive.
///
}
Functions.prototype.bitand = function(number1, number2) {
///
/// Returns a bitwise 'And' of two numbers. [Api set: ExcelApi 1.2]
///
/// Is the decimal representation of the binary number you want to evaluate.
/// Is the decimal representation of the binary number you want to evaluate.
///
}
Functions.prototype.bitlshift = function(number, shiftAmount) {
///
/// Returns a number shifted left by shift_amount bits. [Api set: ExcelApi 1.2]
///
/// Is the decimal representation of the binary number you want to evaluate.
/// Is the number of bits that you want to shift Number left by.
///
}
Functions.prototype.bitor = function(number1, number2) {
///
/// Returns a bitwise 'Or' of two numbers. [Api set: ExcelApi 1.2]
///
/// Is the decimal representation of the binary number you want to evaluate.
/// Is the decimal representation of the binary number you want to evaluate.
///
}
Functions.prototype.bitrshift = function(number, shiftAmount) {
///
/// Returns a number shifted right by shift_amount bits. [Api set: ExcelApi 1.2]
///
/// Is the decimal representation of the binary number you want to evaluate.
/// Is the number of bits that you want to shift Number right by.
///
}
Functions.prototype.bitxor = function(number1, number2) {
///
/// Returns a bitwise 'Exclusive Or' of two numbers. [Api set: ExcelApi 1.2]
///
/// Is the decimal representation of the binary number you want to evaluate.
/// Is the decimal representation of the binary number you want to evaluate.
///
}
Functions.prototype.ceiling_Math = function(number, significance, mode) {
///
/// Rounds a number up, to the nearest integer or to the nearest multiple of significance. [Api set: ExcelApi 1.2]
///
/// Is the value you want to round.
/// Is the multiple to which you want to round.
/// When given and nonzero this function will round away from zero.
///
}
Functions.prototype.ceiling_Precise = function(number, significance) {
///
/// Rounds a number up, to the nearest integer or to the nearest multiple of significance. [Api set: ExcelApi 1.2]
///
/// Is the value you want to round.
/// Is the multiple to which you want to round.
///
}
Functions.prototype.char = function(number) {
///
/// Returns the character specified by the code number from the character set for your computer. [Api set: ExcelApi 1.2]
///
/// Is a number between 1 and 255 specifying which character you want.
///
}
Functions.prototype.chiSq_Dist = function(x, degFreedom, cumulative) {
///
/// Returns the left-tailed probability of the chi-squared distribution. [Api set: ExcelApi 1.2]
///
/// Is the value at which you want to evaluate the distribution, a nonnegative number.
/// Is the number of degrees of freedom, a number between 1 and 10^10, excluding 10^10.
/// Is a logical value for the function to return: the cumulative distribution function = TRUE; the probability density function = FALSE.
///
}
Functions.prototype.chiSq_Dist_RT = function(x, degFreedom) {
///
/// Returns the right-tailed probability of the chi-squared distribution. [Api set: ExcelApi 1.2]
///
/// Is the value at which you want to evaluate the distribution, a nonnegative number.
/// Is the number of degrees of freedom, a number between 1 and 10^10, excluding 10^10.
///
}
Functions.prototype.chiSq_Inv = function(probability, degFreedom) {
///
/// Returns the inverse of the left-tailed probability of the chi-squared distribution. [Api set: ExcelApi 1.2]
///
/// Is a probability associated with the chi-squared distribution, a value between 0 and 1 inclusive.
/// Is the number of degrees of freedom, a number between 1 and 10^10, excluding 10^10.
///
}
Functions.prototype.chiSq_Inv_RT = function(probability, degFreedom) {
///
/// Returns the inverse of the right-tailed probability of the chi-squared distribution. [Api set: ExcelApi 1.2]
///
/// Is a probability associated with the chi-squared distribution, a value between 0 and 1 inclusive.
/// Is the number of degrees of freedom, a number between 1 and 10^10, excluding 10^10.
///
}
Functions.prototype.choose = function(indexNum, values) {
///
/// Chooses a value or action to perform from a list of values, based on an index number. [Api set: ExcelApi 1.2]
///
/// Specifies which value argument is selected. indexNum must be between 1 and 254, or a formula or a reference to a number between 1 and 254.
/// List of parameters, whose elements are 1 to 254 numbers, cell references, defined names, formulas, functions, or text arguments from which CHOOSE selects.
///
}
Functions.prototype.clean = function(text) {
///
/// Removes all nonprintable characters from text. [Api set: ExcelApi 1.2]
///
/// Is any worksheet information from which you want to remove nonprintable characters.
///
}
Functions.prototype.code = function(text) {
///
/// Returns a numeric code for the first character in a text string, in the character set used by your computer. [Api set: ExcelApi 1.2]
///
/// Is the text for which you want the code of the first character.
///
}
Functions.prototype.columns = function(array) {
///
/// Returns the number of columns in an array or reference. [Api set: ExcelApi 1.2]
///
/// Is an array or array formula, or a reference to a range of cells for which you want the number of columns.
///
}
Functions.prototype.combin = function(number, numberChosen) {
///
/// Returns the number of combinations for a given number of items. [Api set: ExcelApi 1.2]
///
/// Is the total number of items.
/// Is the number of items in each combination.
///
}
Functions.prototype.combina = function(number, numberChosen) {
///
/// Returns the number of combinations with repetitions for a given number of items. [Api set: ExcelApi 1.2]
///
/// Is the total number of items.
/// Is the number of items in each combination.
///
}
Functions.prototype.complex = function(realNum, iNum, suffix) {
///
/// Converts real and imaginary coefficients into a complex number. [Api set: ExcelApi 1.2]
///
/// Is the real coefficient of the complex number.
/// Is the imaginary coefficient of the complex number.
/// Is the suffix for the imaginary component of the complex number.
///
}
Functions.prototype.concatenate = function(values) {
///
/// Joins several text strings into one text string. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 text strings to be joined into a single text string and can be text strings, numbers, or single-cell references.
///
}
Functions.prototype.confidence_Norm = function(alpha, standardDev, size) {
///
/// Returns the confidence interval for a population mean, using a normal distribution. [Api set: ExcelApi 1.2]
///
/// Is the significance level used to compute the confidence level, a number greater than 0 and less than 1.
/// Is the population standard deviation for the data range and is assumed to be known. standardDev must be greater than 0.
/// Is the sample size.
///
}
Functions.prototype.confidence_T = function(alpha, standardDev, size) {
///
/// Returns the confidence interval for a population mean, using a Student's T distribution. [Api set: ExcelApi 1.2]
///
/// Is the significance level used to compute the confidence level, a number greater than 0 and less than 1.
/// Is the population standard deviation for the data range and is assumed to be known. standardDev must be greater than 0.
/// Is the sample size.
///
}
Functions.prototype.convert = function(number, fromUnit, toUnit) {
///
/// Converts a number from one measurement system to another. [Api set: ExcelApi 1.2]
///
/// Is the value in from_units to convert.
/// Is the units for number.
/// Is the units for the result.
///
}
Functions.prototype.cos = function(number) {
///
/// Returns the cosine of an angle. [Api set: ExcelApi 1.2]
///
/// Is the angle in radians for which you want the cosine.
///
}
Functions.prototype.cosh = function(number) {
///
/// Returns the hyperbolic cosine of a number. [Api set: ExcelApi 1.2]
///
/// Is any real number.
///
}
Functions.prototype.cot = function(number) {
///
/// Returns the cotangent of an angle. [Api set: ExcelApi 1.2]
///
/// Is the angle in radians for which you want the cotangent.
///
}
Functions.prototype.coth = function(number) {
///
/// Returns the hyperbolic cotangent of a number. [Api set: ExcelApi 1.2]
///
/// Is the angle in radians for which you want the hyperbolic cotangent.
///
}
Functions.prototype.count = function(values) {
///
/// Counts the number of cells in a range that contain numbers. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 arguments that can contain or refer to a variety of different types of data, but only numbers are counted.
///
}
Functions.prototype.countA = function(values) {
///
/// Counts the number of cells in a range that are not empty. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 arguments representing the values and cells you want to count. Values can be any type of information.
///
}
Functions.prototype.countBlank = function(range) {
///
/// Counts the number of empty cells in a specified range of cells. [Api set: ExcelApi 1.2]
///
/// Is the range from which you want to count the empty cells.
///
}
Functions.prototype.countIf = function(range, criteria) {
///
/// Counts the number of cells within a range that meet the given condition. [Api set: ExcelApi 1.2]
///
/// Is the range of cells from which you want to count nonblank cells.
/// Is the condition in the form of a number, expression, or text that defines which cells will be counted.
///
}
Functions.prototype.countIfs = function(values) {
///
/// Counts the number of cells specified by a given set of conditions or criteria. [Api set: ExcelApi 1.2]
///
/// List of parameters, where the first element of each pair is the Is the range of cells you want evaluated for the particular condition , and the second element is is the condition in the form of a number, expression, or text that defines which cells will be counted.
///
}
Functions.prototype.coupDayBs = function(settlement, maturity, frequency, basis) {
///
/// Returns the number of days from the beginning of the coupon period to the settlement date. [Api set: ExcelApi 1.2]
///
/// Is the security's settlement date, expressed as a serial date number.
/// Is the security's maturity date, expressed as a serial date number.
/// Is the number of coupon payments per year.
/// Is the type of day count basis to use.
///
}
Functions.prototype.coupDays = function(settlement, maturity, frequency, basis) {
///
/// Returns the number of days in the coupon period that contains the settlement date. [Api set: ExcelApi 1.2]
///
/// Is the security's settlement date, expressed as a serial date number.
/// Is the security's maturity date, expressed as a serial date number.
/// Is the number of coupon payments per year.
/// Is the type of day count basis to use.
///
}
Functions.prototype.coupDaysNc = function(settlement, maturity, frequency, basis) {
///
/// Returns the number of days from the settlement date to the next coupon date. [Api set: ExcelApi 1.2]
///
/// Is the security's settlement date, expressed as a serial date number.
/// Is the security's maturity date, expressed as a serial date number.
/// Is the number of coupon payments per year.
/// Is the type of day count basis to use.
///
}
Functions.prototype.coupNcd = function(settlement, maturity, frequency, basis) {
///
/// Returns the next coupon date after the settlement date. [Api set: ExcelApi 1.2]
///
/// Is the security's settlement date, expressed as a serial date number.
/// Is the security's maturity date, expressed as a serial date number.
/// Is the number of coupon payments per year.
/// Is the type of day count basis to use.
///
}
Functions.prototype.coupNum = function(settlement, maturity, frequency, basis) {
///
/// Returns the number of coupons payable between the settlement date and maturity date. [Api set: ExcelApi 1.2]
///
/// Is the security's settlement date, expressed as a serial date number.
/// Is the security's maturity date, expressed as a serial date number.
/// Is the number of coupon payments per year.
/// Is the type of day count basis to use.
///
}
Functions.prototype.coupPcd = function(settlement, maturity, frequency, basis) {
///
/// Returns the previous coupon date before the settlement date. [Api set: ExcelApi 1.2]
///
/// Is the security's settlement date, expressed as a serial date number.
/// Is the security's maturity date, expressed as a serial date number.
/// Is the number of coupon payments per year.
/// Is the type of day count basis to use.
///
}
Functions.prototype.csc = function(number) {
///
/// Returns the cosecant of an angle. [Api set: ExcelApi 1.2]
///
/// Is the angle in radians for which you want the cosecant.
///
}
Functions.prototype.csch = function(number) {
///
/// Returns the hyperbolic cosecant of an angle. [Api set: ExcelApi 1.2]
///
/// Is the angle in radians for which you want the hyperbolic cosecant.
///
}
Functions.prototype.cumIPmt = function(rate, nper, pv, startPeriod, endPeriod, type) {
///
/// Returns the cumulative interest paid between two periods. [Api set: ExcelApi 1.2]
///
/// Is the interest rate.
/// Is the total number of payment periods.
/// Is the present value.
/// Is the first period in the calculation.
/// Is the last period in the calculation.
/// Is the timing of the payment.
///
}
Functions.prototype.cumPrinc = function(rate, nper, pv, startPeriod, endPeriod, type) {
///
/// Returns the cumulative principal paid on a loan between two periods. [Api set: ExcelApi 1.2]
///
/// Is the interest rate.
/// Is the total number of payment periods.
/// Is the present value.
/// Is the first period in the calculation.
/// Is the last period in the calculation.
/// Is the timing of the payment.
///
}
Functions.prototype.daverage = function(database, field, criteria) {
///
/// Averages the values in a column in a list or database that match conditions you specify. [Api set: ExcelApi 1.2]
///
/// Is the range of cells that makes up the list or database. A database is a list of related data.
/// Is either the label of the column in double quotation marks or a number that represents the column's position in the list.
/// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
///
}
Functions.prototype.dcount = function(database, field, criteria) {
///
/// Counts the cells containing numbers in the field (column) of records in the database that match the conditions you specify. [Api set: ExcelApi 1.2]
///
/// Is the range of cells that makes up the list or database. A database is a list of related data.
/// Is either the label of the column in double quotation marks or a number that represents the column's position in the list.
/// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
///
}
Functions.prototype.dcountA = function(database, field, criteria) {
///
/// Counts nonblank cells in the field (column) of records in the database that match the conditions you specify. [Api set: ExcelApi 1.2]
///
/// Is the range of cells that makes up the list or database. A database is a list of related data.
/// Is either the label of the column in double quotation marks or a number that represents the column's position in the list.
/// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
///
}
Functions.prototype.dget = function(database, field, criteria) {
///
/// Extracts from a database a single record that matches the conditions you specify. [Api set: ExcelApi 1.2]
///
/// Is the range of cells that makes up the list or database. A database is a list of related data.
/// Is either the label of the column in double quotation marks or a number that represents the column's position in the list.
/// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
///
}
Functions.prototype.dmax = function(database, field, criteria) {
///
/// Returns the largest number in the field (column) of records in the database that match the conditions you specify. [Api set: ExcelApi 1.2]
///
/// Is the range of cells that makes up the list or database. A database is a list of related data.
/// Is either the label of the column in double quotation marks or a number that represents the column's position in the list.
/// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
///
}
Functions.prototype.dmin = function(database, field, criteria) {
///
/// Returns the smallest number in the field (column) of records in the database that match the conditions you specify. [Api set: ExcelApi 1.2]
///
/// Is the range of cells that makes up the list or database. A database is a list of related data.
/// Is either the label of the column in double quotation marks or a number that represents the column's position in the list.
/// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
///
}
Functions.prototype.dproduct = function(database, field, criteria) {
///
/// Multiplies the values in the field (column) of records in the database that match the conditions you specify. [Api set: ExcelApi 1.2]
///
/// Is the range of cells that makes up the list or database. A database is a list of related data.
/// Is either the label of the column in double quotation marks or a number that represents the column's position in the list.
/// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
///
}
Functions.prototype.dstDev = function(database, field, criteria) {
///
/// Estimates the standard deviation based on a sample from selected database entries. [Api set: ExcelApi 1.2]
///
/// Is the range of cells that makes up the list or database. A database is a list of related data.
/// Is either the label of the column in double quotation marks or a number that represents the column's position in the list.
/// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
///
}
Functions.prototype.dstDevP = function(database, field, criteria) {
///
/// Calculates the standard deviation based on the entire population of selected database entries. [Api set: ExcelApi 1.2]
///
/// Is the range of cells that makes up the list or database. A database is a list of related data.
/// Is either the label of the column in double quotation marks or a number that represents the column's position in the list.
/// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
///
}
Functions.prototype.dsum = function(database, field, criteria) {
///
/// Adds the numbers in the field (column) of records in the database that match the conditions you specify. [Api set: ExcelApi 1.2]
///
/// Is the range of cells that makes up the list or database. A database is a list of related data.
/// Is either the label of the column in double quotation marks or a number that represents the column's position in the list.
/// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
///
}
Functions.prototype.dvar = function(database, field, criteria) {
///
/// Estimates variance based on a sample from selected database entries. [Api set: ExcelApi 1.2]
///
/// Is the range of cells that makes up the list or database. A database is a list of related data.
/// Is either the label of the column in double quotation marks or a number that represents the column's position in the list.
/// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
///
}
Functions.prototype.dvarP = function(database, field, criteria) {
///
/// Calculates variance based on the entire population of selected database entries. [Api set: ExcelApi 1.2]
///
/// Is the range of cells that makes up the list or database. A database is a list of related data.
/// Is either the label of the column in double quotation marks or a number that represents the column's position in the list.
/// Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
///
}
Functions.prototype.date = function(year, month, day) {
///
/// Returns the number that represents the date in Microsoft Excel date-time code. [Api set: ExcelApi 1.2]
///
/// Is a number from 1900 or 1904 (depending on the workbook's date system) to 9999.
/// Is a number from 1 to 12 representing the month of the year.
/// Is a number from 1 to 31 representing the day of the month.
///
}
Functions.prototype.datevalue = function(dateText) {
///
/// Converts a date in the form of text to a number that represents the date in Microsoft Excel date-time code. [Api set: ExcelApi 1.2]
///
/// Is text that represents a date in a Microsoft Excel date format, between 1/1/1900 or 1/1/1904 (depending on the workbook's date system) and 12/31/9999.
///
}
Functions.prototype.day = function(serialNumber) {
///
/// Returns the day of the month, a number from 1 to 31. [Api set: ExcelApi 1.2]
///
/// Is a number in the date-time code used by Microsoft Excel.
///
}
Functions.prototype.days = function(endDate, startDate) {
///
/// Returns the number of days between the two dates. [Api set: ExcelApi 1.2]
///
/// startDate and endDate are the two dates between which you want to know the number of days.
/// startDate and endDate are the two dates between which you want to know the number of days.
///
}
Functions.prototype.days360 = function(startDate, endDate, method) {
///
/// Returns the number of days between two dates based on a 360-day year (twelve 30-day months). [Api set: ExcelApi 1.2]
///
/// startDate and endDate are the two dates between which you want to know the number of days.
/// startDate and endDate are the two dates between which you want to know the number of days.
/// Is a logical value specifying the calculation method: U.S. (NASD) = FALSE or omitted; European = TRUE.
///
}
Functions.prototype.db = function(cost, salvage, life, period, month) {
///
/// Returns the depreciation of an asset for a specified period using the fixed-declining balance method. [Api set: ExcelApi 1.2]
///
/// Is the initial cost of the asset.
/// Is the salvage value at the end of the life of the asset.
/// Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset).
/// Is the period for which you want to calculate the depreciation. Period must use the same units as Life.
/// Is the number of months in the first year. If month is omitted, it is assumed to be 12.
///
}
Functions.prototype.dbcs = function(text) {
///
/// Changes half-width (single-byte) characters within a character string to full-width (double-byte) characters. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2]
///
/// Is a text, or a reference to a cell containing a text.
///
}
Functions.prototype.ddb = function(cost, salvage, life, period, factor) {
///
/// Returns the depreciation of an asset for a specified period using the double-declining balance method or some other method you specify. [Api set: ExcelApi 1.2]
///
/// Is the initial cost of the asset.
/// Is the salvage value at the end of the life of the asset.
/// Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset).
/// Is the period for which you want to calculate the depreciation. Period must use the same units as Life.
/// Is the rate at which the balance declines. If Factor is omitted, it is assumed to be 2 (the double-declining balance method).
///
}
Functions.prototype.dec2Bin = function(number, places) {
///
/// Converts a decimal number to binary. [Api set: ExcelApi 1.2]
///
/// Is the decimal integer you want to convert.
/// Is the number of characters to use.
///
}
Functions.prototype.dec2Hex = function(number, places) {
///
/// Converts a decimal number to hexadecimal. [Api set: ExcelApi 1.2]
///
/// Is the decimal integer you want to convert.
/// Is the number of characters to use.
///
}
Functions.prototype.dec2Oct = function(number, places) {
///
/// Converts a decimal number to octal. [Api set: ExcelApi 1.2]
///
/// Is the decimal integer you want to convert.
/// Is the number of characters to use.
///
}
Functions.prototype.decimal = function(number, radix) {
///
/// Converts a text representation of a number in a given base into a decimal number. [Api set: ExcelApi 1.2]
///
/// Is the number that you want to convert.
/// Is the base Radix of the number you are converting.
///
}
Functions.prototype.degrees = function(angle) {
///
/// Converts radians to degrees. [Api set: ExcelApi 1.2]
///
/// Is the angle in radians that you want to convert.
///
}
Functions.prototype.delta = function(number1, number2) {
///
/// Tests whether two numbers are equal. [Api set: ExcelApi 1.2]
///
/// Is the first number.
/// Is the second number.
///
}
Functions.prototype.devSq = function(values) {
///
/// Returns the sum of squares of deviations of data points from their sample mean. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 arguments, or an array or array reference, on which you want DEVSQ to calculate.
///
}
Functions.prototype.disc = function(settlement, maturity, pr, redemption, basis) {
///
/// Returns the discount rate for a security. [Api set: ExcelApi 1.2]
///
/// Is the security's settlement date, expressed as a serial date number.
/// Is the security's maturity date, expressed as a serial date number.
/// Is the security's price per $100 face value.
/// Is the security's redemption value per $100 face value.
/// Is the type of day count basis to use.
///
}
Functions.prototype.dollar = function(number, decimals) {
///
/// Converts a number to text, using currency format. [Api set: ExcelApi 1.2]
///
/// Is a number, a reference to a cell containing a number, or a formula that evaluates to a number.
/// Is the number of digits to the right of the decimal point. The number is rounded as necessary; if omitted, Decimals = 2.
///
}
Functions.prototype.dollarDe = function(fractionalDollar, fraction) {
///
/// Converts a dollar price, expressed as a fraction, into a dollar price, expressed as a decimal number. [Api set: ExcelApi 1.2]
///
/// Is a number expressed as a fraction.
/// Is the integer to use in the denominator of the fraction.
///
}
Functions.prototype.dollarFr = function(decimalDollar, fraction) {
///
/// Converts a dollar price, expressed as a decimal number, into a dollar price, expressed as a fraction. [Api set: ExcelApi 1.2]
///
/// Is a decimal number.
/// Is the integer to use in the denominator of a fraction.
///
}
Functions.prototype.duration = function(settlement, maturity, coupon, yld, frequency, basis) {
///
/// Returns the annual duration of a security with periodic interest payments. [Api set: ExcelApi 1.2]
///
/// Is the security's settlement date, expressed as a serial date number.
/// Is the security's maturity date, expressed as a serial date number.
/// Is the security's annual coupon rate.
/// Is the security's annual yield.
/// Is the number of coupon payments per year.
/// Is the type of day count basis to use.
///
}
Functions.prototype.ecma_Ceiling = function(number, significance) {
///
/// Rounds a number up, to the nearest integer or to the nearest multiple of significance. [Api set: ExcelApi 1.2]
///
/// Is the value you want to round.
/// Is the multiple to which you want to round.
///
}
Functions.prototype.edate = function(startDate, months) {
///
/// Returns the serial number of the date that is the indicated number of months before or after the start date. [Api set: ExcelApi 1.2]
///
/// Is a serial date number that represents the start date.
/// Is the number of months before or after startDate.
///
}
Functions.prototype.effect = function(nominalRate, npery) {
///
/// Returns the effective annual interest rate. [Api set: ExcelApi 1.2]
///
/// Is the nominal interest rate.
/// Is the number of compounding periods per year.
///
}
Functions.prototype.eoMonth = function(startDate, months) {
///
/// Returns the serial number of the last day of the month before or after a specified number of months. [Api set: ExcelApi 1.2]
///
/// Is a serial date number that represents the start date.
/// Is the number of months before or after the startDate.
///
}
Functions.prototype.erf = function(lowerLimit, upperLimit) {
///
/// Returns the error function. [Api set: ExcelApi 1.2]
///
/// Is the lower bound for integrating ERF.
/// Is the upper bound for integrating ERF.
///
}
Functions.prototype.erfC = function(x) {
///
/// Returns the complementary error function. [Api set: ExcelApi 1.2]
///
/// Is the lower bound for integrating ERF.
///
}
Functions.prototype.erfC_Precise = function(X) {
///
/// Returns the complementary error function. [Api set: ExcelApi 1.2]
///
/// Is the lower bound for integrating ERFC.PRECISE.
///
}
Functions.prototype.erf_Precise = function(X) {
///
/// Returns the error function. [Api set: ExcelApi 1.2]
///
/// Is the lower bound for integrating ERF.PRECISE.
///
}
Functions.prototype.error_Type = function(errorVal) {
///
/// Returns a number matching an error value. [Api set: ExcelApi 1.2]
///
/// Is the error value for which you want the identifying number, and can be an actual error value or a reference to a cell containing an error value.
///
}
Functions.prototype.even = function(number) {
///
/// Rounds a positive number up and negative number down to the nearest even integer. [Api set: ExcelApi 1.2]
///
/// Is the value to round.
///
}
Functions.prototype.exact = function(text1, text2) {
///
/// Checks whether two text strings are exactly the same, and returns TRUE or FALSE. EXACT is case-sensitive. [Api set: ExcelApi 1.2]
///
/// Is the first text string.
/// Is the second text string.
///
}
Functions.prototype.exp = function(number) {
///
/// Returns e raised to the power of a given number. [Api set: ExcelApi 1.2]
///
/// Is the exponent applied to the base e. The constant e equals 2.71828182845904, the base of the natural logarithm.
///
}
Functions.prototype.expon_Dist = function(x, lambda, cumulative) {
///
/// Returns the exponential distribution. [Api set: ExcelApi 1.2]
///
/// Is the value of the function, a nonnegative number.
/// Is the parameter value, a positive number.
/// Is a logical value for the function to return: the cumulative distribution function = TRUE; the probability density function = FALSE.
///
}
Functions.prototype.fvschedule = function(principal, schedule) {
///
/// Returns the future value of an initial principal after applying a series of compound interest rates. [Api set: ExcelApi 1.2]
///
/// Is the present value.
/// Is an array of interest rates to apply.
///
}
Functions.prototype.f_Dist = function(x, degFreedom1, degFreedom2, cumulative) {
///
/// Returns the (left-tailed) F probability distribution (degree of diversity) for two data sets. [Api set: ExcelApi 1.2]
///
/// Is the value at which to evaluate the function, a nonnegative number.
/// Is the numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10.
/// Is the denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10.
/// Is a logical value for the function to return: the cumulative distribution function = TRUE; the probability density function = FALSE.
///
}
Functions.prototype.f_Dist_RT = function(x, degFreedom1, degFreedom2) {
///
/// Returns the (right-tailed) F probability distribution (degree of diversity) for two data sets. [Api set: ExcelApi 1.2]
///
/// Is the value at which to evaluate the function, a nonnegative number.
/// Is the numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10.
/// Is the denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10.
///
}
Functions.prototype.f_Inv = function(probability, degFreedom1, degFreedom2) {
///
/// Returns the inverse of the (left-tailed) F probability distribution: if p = F.DIST(x,...), then F.INV(p,...) = x. [Api set: ExcelApi 1.2]
///
/// Is a probability associated with the F cumulative distribution, a number between 0 and 1 inclusive.
/// Is the numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10.
/// Is the denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10.
///
}
Functions.prototype.f_Inv_RT = function(probability, degFreedom1, degFreedom2) {
///
/// Returns the inverse of the (right-tailed) F probability distribution: if p = F.DIST.RT(x,...), then F.INV.RT(p,...) = x. [Api set: ExcelApi 1.2]
///
/// Is a probability associated with the F cumulative distribution, a number between 0 and 1 inclusive.
/// Is the numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10.
/// Is the denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10.
///
}
Functions.prototype.fact = function(number) {
///
/// Returns the factorial of a number, equal to 1*2*3*...* Number. [Api set: ExcelApi 1.2]
///
/// Is the nonnegative number you want the factorial of.
///
}
Functions.prototype.factDouble = function(number) {
///
/// Returns the double factorial of a number. [Api set: ExcelApi 1.2]
///
/// Is the value for which to return the double factorial.
///
}
Functions.prototype.false = function() {
///
/// Returns the logical value FALSE. [Api set: ExcelApi 1.2]
///
///
}
Functions.prototype.find = function(findText, withinText, startNum) {
///
/// Returns the starting position of one text string within another text string. FIND is case-sensitive. [Api set: ExcelApi 1.2]
///
/// Is the text you want to find. Use double quotes (empty text) to match the first character in withinText; wildcard characters not allowed.
/// Is the text containing the text you want to find.
/// Specifies the character at which to start the search. The first character in withinText is character number 1. If omitted, startNum = 1.
///
}
Functions.prototype.findB = function(findText, withinText, startNum) {
///
/// Finds the starting position of one text string within another text string. FINDB is case-sensitive. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2]
///
/// Is the text you want to find.
/// Is the text containing the text you want to find.
/// Specifies the character at which to start the search.
///
}
Functions.prototype.fisher = function(x) {
///
/// Returns the Fisher transformation. [Api set: ExcelApi 1.2]
///
/// Is the value for which you want the transformation, a number between -1 and 1, excluding -1 and 1.
///
}
Functions.prototype.fisherInv = function(y) {
///
/// Returns the inverse of the Fisher transformation: if y = FISHER(x), then FISHERINV(y) = x. [Api set: ExcelApi 1.2]
///
/// Is the value for which you want to perform the inverse of the transformation.
///
}
Functions.prototype.fixed = function(number, decimals, noCommas) {
///
/// Rounds a number to the specified number of decimals and returns the result as text with or without commas. [Api set: ExcelApi 1.2]
///
/// Is the number you want to round and convert to text.
/// Is the number of digits to the right of the decimal point. If omitted, Decimals = 2.
/// Is a logical value: do not display commas in the returned text = TRUE; do display commas in the returned text = FALSE or omitted.
///
}
Functions.prototype.floor_Math = function(number, significance, mode) {
///
/// Rounds a number down, to the nearest integer or to the nearest multiple of significance. [Api set: ExcelApi 1.2]
///
/// Is the value you want to round.
/// Is the multiple to which you want to round.
/// When given and nonzero this function will round towards zero.
///
}
Functions.prototype.floor_Precise = function(number, significance) {
///
/// Rounds a number down, to the nearest integer or to the nearest multiple of significance. [Api set: ExcelApi 1.2]
///
/// Is the numeric value you want to round.
/// Is the multiple to which you want to round.
///
}
Functions.prototype.fv = function(rate, nper, pmt, pv, type) {
///
/// Returns the future value of an investment based on periodic, constant payments and a constant interest rate. [Api set: ExcelApi 1.2]
///
/// Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR.
/// Is the total number of payment periods in the investment.
/// Is the payment made each period; it cannot change over the life of the investment.
/// Is the present value, or the lump-sum amount that a series of future payments is worth now. If omitted, Pv = 0.
/// Is a value representing the timing of payment: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted.
///
}
Functions.prototype.gamma = function(x) {
///
/// Returns the Gamma function value. [Api set: ExcelApi 1.2]
///
/// Is the value for which you want to calculate Gamma.
///
}
Functions.prototype.gammaLn = function(x) {
///
/// Returns the natural logarithm of the gamma function. [Api set: ExcelApi 1.2]
///
/// Is the value for which you want to calculate GAMMALN, a positive number.
///
}
Functions.prototype.gammaLn_Precise = function(x) {
///
/// Returns the natural logarithm of the gamma function. [Api set: ExcelApi 1.2]
///
/// Is the value for which you want to calculate GAMMALN.PRECISE, a positive number.
///
}
Functions.prototype.gamma_Dist = function(x, alpha, beta, cumulative) {
///
/// Returns the gamma distribution. [Api set: ExcelApi 1.2]
///
/// Is the value at which you want to evaluate the distribution, a nonnegative number.
/// Is a parameter to the distribution, a positive number.
/// Is a parameter to the distribution, a positive number. If beta = 1, GAMMA.DIST returns the standard gamma distribution.
/// Is a logical value: return the cumulative distribution function = TRUE; return the probability mass function = FALSE or omitted.
///
}
Functions.prototype.gamma_Inv = function(probability, alpha, beta) {
///
/// Returns the inverse of the gamma cumulative distribution: if p = GAMMA.DIST(x,...), then GAMMA.INV(p,...) = x. [Api set: ExcelApi 1.2]
///
/// Is the probability associated with the gamma distribution, a number between 0 and 1, inclusive.
/// Is a parameter to the distribution, a positive number.
/// Is a parameter to the distribution, a positive number. If beta = 1, GAMMA.INV returns the inverse of the standard gamma distribution.
///
}
Functions.prototype.gauss = function(x) {
///
/// Returns 0.5 less than the standard normal cumulative distribution. [Api set: ExcelApi 1.2]
///
/// Is the value for which you want the distribution.
///
}
Functions.prototype.gcd = function(values) {
///
/// Returns the greatest common divisor. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 values.
///
}
Functions.prototype.geStep = function(number, step) {
///
/// Tests whether a number is greater than a threshold value. [Api set: ExcelApi 1.2]
///
/// Is the value to test against step.
/// Is the threshold value.
///
}
Functions.prototype.geoMean = function(values) {
///
/// Returns the geometric mean of an array or range of positive numeric data. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the mean.
///
}
Functions.prototype.hlookup = function(lookupValue, tableArray, rowIndexNum, rangeLookup) {
///
/// Looks for a value in the top row of a table or array of values and returns the value in the same column from a row you specify. [Api set: ExcelApi 1.2]
///
/// Is the value to be found in the first row of the table and can be a value, a reference, or a text string.
/// Is a table of text, numbers, or logical values in which data is looked up. tableArray can be a reference to a range or a range name.
/// Is the row number in tableArray from which the matching value should be returned. The first row of values in the table is row 1.
/// Is a logical value: to find the closest match in the top row (sorted in ascending order) = TRUE or omitted; find an exact match = FALSE.
///
}
Functions.prototype.harMean = function(values) {
///
/// Returns the harmonic mean of a data set of positive numbers: the reciprocal of the arithmetic mean of reciprocals. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the harmonic mean.
///
}
Functions.prototype.hex2Bin = function(number, places) {
///
/// Converts a Hexadecimal number to binary. [Api set: ExcelApi 1.2]
///
/// Is the hexadecimal number you want to convert.
/// Is the number of characters to use.
///
}
Functions.prototype.hex2Dec = function(number) {
///
/// Converts a hexadecimal number to decimal. [Api set: ExcelApi 1.2]
///
/// Is the hexadecimal number you want to convert.
///
}
Functions.prototype.hex2Oct = function(number, places) {
///
/// Converts a hexadecimal number to octal. [Api set: ExcelApi 1.2]
///
/// Is the hexadecimal number you want to convert.
/// Is the number of characters to use.
///
}
Functions.prototype.hour = function(serialNumber) {
///
/// Returns the hour as a number from 0 (12:00 A.M.) to 23 (11:00 P.M.). [Api set: ExcelApi 1.2]
///
/// Is a number in the date-time code used by Microsoft Excel, or text in time format, such as 16:48:00 or 4:48:00 PM.
///
}
Functions.prototype.hypGeom_Dist = function(sampleS, numberSample, populationS, numberPop, cumulative) {
///
/// Returns the hypergeometric distribution. [Api set: ExcelApi 1.2]
///
/// Is the number of successes in the sample.
/// Is the size of the sample.
/// Is the number of successes in the population.
/// Is the population size.
/// Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE.
///
}
Functions.prototype.hyperlink = function(linkLocation, friendlyName) {
///
/// Creates a shortcut or jump that opens a document stored on your hard drive, a network server, or on the Internet. [Api set: ExcelApi 1.2]
///
/// Is the text giving the path and file name to the document to be opened, a hard drive location, UNC address, or URL path.
/// Is text or a number that is displayed in the cell. If omitted, the cell displays the linkLocation text.
///
}
Functions.prototype.iso_Ceiling = function(number, significance) {
///
/// Rounds a number up, to the nearest integer or to the nearest multiple of significance. [Api set: ExcelApi 1.2]
///
/// Is the value you want to round.
/// Is the optional multiple to which you want to round.
///
}
Functions.prototype.if = function(logicalTest, valueIfTrue, valueIfFalse) {
///
/// Checks whether a condition is met, and returns one value if TRUE, and another value if FALSE. [Api set: ExcelApi 1.2]
///
/// Is any value or expression that can be evaluated to TRUE or FALSE.
/// Is the value that is returned if logicalTest is TRUE. If omitted, TRUE is returned. You can nest up to seven IF functions.
/// Is the value that is returned if logicalTest is FALSE. If omitted, FALSE is returned.
///
}
Functions.prototype.imAbs = function(inumber) {
///
/// Returns the absolute value (modulus) of a complex number. [Api set: ExcelApi 1.2]
///
/// Is a complex number for which you want the absolute value.
///
}
Functions.prototype.imArgument = function(inumber) {
///
/// Returns the argument q, an angle expressed in radians. [Api set: ExcelApi 1.2]
///
/// Is a complex number for which you want the argument.
///
}
Functions.prototype.imConjugate = function(inumber) {
///
/// Returns the complex conjugate of a complex number. [Api set: ExcelApi 1.2]
///
/// Is a complex number for which you want the conjugate.
///
}
Functions.prototype.imCos = function(inumber) {
///
/// Returns the cosine of a complex number. [Api set: ExcelApi 1.2]
///
/// Is a complex number for which you want the cosine.
///
}
Functions.prototype.imCosh = function(inumber) {
///
/// Returns the hyperbolic cosine of a complex number. [Api set: ExcelApi 1.2]
///
/// Is a complex number for which you want the hyperbolic cosine.
///
}
Functions.prototype.imCot = function(inumber) {
///
/// Returns the cotangent of a complex number. [Api set: ExcelApi 1.2]
///
/// Is a complex number for which you want the cotangent.
///
}
Functions.prototype.imCsc = function(inumber) {
///
/// Returns the cosecant of a complex number. [Api set: ExcelApi 1.2]
///
/// Is a complex number for which you want the cosecant.
///
}
Functions.prototype.imCsch = function(inumber) {
///
/// Returns the hyperbolic cosecant of a complex number. [Api set: ExcelApi 1.2]
///
/// Is a complex number for which you want the hyperbolic cosecant.
///
}
Functions.prototype.imDiv = function(inumber1, inumber2) {
///
/// Returns the quotient of two complex numbers. [Api set: ExcelApi 1.2]
///
/// Is the complex numerator or dividend.
/// Is the complex denominator or divisor.
///
}
Functions.prototype.imExp = function(inumber) {
///
/// Returns the exponential of a complex number. [Api set: ExcelApi 1.2]
///
/// Is a complex number for which you want the exponential.
///
}
Functions.prototype.imLn = function(inumber) {
///
/// Returns the natural logarithm of a complex number. [Api set: ExcelApi 1.2]
///
/// Is a complex number for which you want the natural logarithm.
///
}
Functions.prototype.imLog10 = function(inumber) {
///
/// Returns the base-10 logarithm of a complex number. [Api set: ExcelApi 1.2]
///
/// Is a complex number for which you want the common logarithm.
///
}
Functions.prototype.imLog2 = function(inumber) {
///
/// Returns the base-2 logarithm of a complex number. [Api set: ExcelApi 1.2]
///
/// Is a complex number for which you want the base-2 logarithm.
///
}
Functions.prototype.imPower = function(inumber, number) {
///
/// Returns a complex number raised to an integer power. [Api set: ExcelApi 1.2]
///
/// Is a complex number you want to raise to a power.
/// Is the power to which you want to raise the complex number.
///
}
Functions.prototype.imProduct = function(values) {
///
/// Returns the product of 1 to 255 complex numbers. [Api set: ExcelApi 1.2]
///
/// Inumber1, Inumber2,... are from 1 to 255 complex numbers to multiply.
///
}
Functions.prototype.imReal = function(inumber) {
///
/// Returns the real coefficient of a complex number. [Api set: ExcelApi 1.2]
///
/// Is a complex number for which you want the real coefficient.
///
}
Functions.prototype.imSec = function(inumber) {
///
/// Returns the secant of a complex number. [Api set: ExcelApi 1.2]
///
/// Is a complex number for which you want the secant.
///
}
Functions.prototype.imSech = function(inumber) {
///
/// Returns the hyperbolic secant of a complex number. [Api set: ExcelApi 1.2]
///
/// Is a complex number for which you want the hyperbolic secant.
///
}
Functions.prototype.imSin = function(inumber) {
///
/// Returns the sine of a complex number. [Api set: ExcelApi 1.2]
///
/// Is a complex number for which you want the sine.
///
}
Functions.prototype.imSinh = function(inumber) {
///
/// Returns the hyperbolic sine of a complex number. [Api set: ExcelApi 1.2]
///
/// Is a complex number for which you want the hyperbolic sine.
///
}
Functions.prototype.imSqrt = function(inumber) {
///
/// Returns the square root of a complex number. [Api set: ExcelApi 1.2]
///
/// Is a complex number for which you want the square root.
///
}
Functions.prototype.imSub = function(inumber1, inumber2) {
///
/// Returns the difference of two complex numbers. [Api set: ExcelApi 1.2]
///
/// Is the complex number from which to subtract inumber2.
/// Is the complex number to subtract from inumber1.
///
}
Functions.prototype.imSum = function(values) {
///
/// Returns the sum of complex numbers. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are from 1 to 255 complex numbers to add.
///
}
Functions.prototype.imTan = function(inumber) {
///
/// Returns the tangent of a complex number. [Api set: ExcelApi 1.2]
///
/// Is a complex number for which you want the tangent.
///
}
Functions.prototype.imaginary = function(inumber) {
///
/// Returns the imaginary coefficient of a complex number. [Api set: ExcelApi 1.2]
///
/// Is a complex number for which you want the imaginary coefficient.
///
}
Functions.prototype.int = function(number) {
///
/// Rounds a number down to the nearest integer. [Api set: ExcelApi 1.2]
///
/// Is the real number you want to round down to an integer.
///
}
Functions.prototype.intRate = function(settlement, maturity, investment, redemption, basis) {
///
/// Returns the interest rate for a fully invested security. [Api set: ExcelApi 1.2]
///
/// Is the security's settlement date, expressed as a serial date number.
/// Is the security's maturity date, expressed as a serial date number.
/// Is the amount invested in the security.
/// Is the amount to be received at maturity.
/// Is the type of day count basis to use.
///
}
Functions.prototype.ipmt = function(rate, per, nper, pv, fv, type) {
///
/// Returns the interest payment for a given period for an investment, based on periodic, constant payments and a constant interest rate. [Api set: ExcelApi 1.2]
///
/// Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR.
/// Is the period for which you want to find the interest and must be in the range 1 to Nper.
/// Is the total number of payment periods in an investment.
/// Is the present value, or the lump-sum amount that a series of future payments is worth now.
/// Is the future value, or a cash balance you want to attain after the last payment is made. If omitted, Fv = 0.
/// Is a logical value representing the timing of payment: at the end of the period = 0 or omitted, at the beginning of the period = 1.
///
}
Functions.prototype.irr = function(values, guess) {
///
/// Returns the internal rate of return for a series of cash flows. [Api set: ExcelApi 1.2]
///
/// Is an array or a reference to cells that contain numbers for which you want to calculate the internal rate of return.
/// Is a number that you guess is close to the result of IRR; 0.1 (10 percent) if omitted.
///
}
Functions.prototype.isErr = function(value) {
///
/// Checks whether a value is an error (#VALUE!, #REF!, #DIV/0!, #NUM!, #NAME?, or #NULL!) excluding #N/A, and returns TRUE or FALSE. [Api set: ExcelApi 1.2]
///
/// Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.
///
}
Functions.prototype.isError = function(value) {
///
/// Checks whether a value is an error (#N/A, #VALUE!, #REF!, #DIV/0!, #NUM!, #NAME?, or #NULL!), and returns TRUE or FALSE. [Api set: ExcelApi 1.2]
///
/// Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.
///
}
Functions.prototype.isEven = function(number) {
///
/// Returns TRUE if the number is even. [Api set: ExcelApi 1.2]
///
/// Is the value to test.
///
}
Functions.prototype.isFormula = function(reference) {
///
/// Checks whether a reference is to a cell containing a formula, and returns TRUE or FALSE. [Api set: ExcelApi 1.2]
///
/// Is a reference to the cell you want to test. Reference can be a cell reference, a formula, or name that refers to a cell.
///
}
Functions.prototype.isLogical = function(value) {
///
/// Checks whether a value is a logical value (TRUE or FALSE), and returns TRUE or FALSE. [Api set: ExcelApi 1.2]
///
/// Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.
///
}
Functions.prototype.isNA = function(value) {
///
/// Checks whether a value is #N/A, and returns TRUE or FALSE. [Api set: ExcelApi 1.2]
///
/// Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.
///
}
Functions.prototype.isNonText = function(value) {
///
/// Checks whether a value is not text (blank cells are not text), and returns TRUE or FALSE. [Api set: ExcelApi 1.2]
///
/// Is the value you want tested: a cell; a formula; or a name referring to a cell, formula, or value.
///
}
Functions.prototype.isNumber = function(value) {
///
/// Checks whether a value is a number, and returns TRUE or FALSE. [Api set: ExcelApi 1.2]
///
/// Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.
///
}
Functions.prototype.isOdd = function(number) {
///
/// Returns TRUE if the number is odd. [Api set: ExcelApi 1.2]
///
/// Is the value to test.
///
}
Functions.prototype.isText = function(value) {
///
/// Checks whether a value is text, and returns TRUE or FALSE. [Api set: ExcelApi 1.2]
///
/// Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.
///
}
Functions.prototype.isoWeekNum = function(date) {
///
/// Returns the ISO week number in the year for a given date. [Api set: ExcelApi 1.2]
///
/// Is the date-time code used by Microsoft Excel for date and time calculation.
///
}
Functions.prototype.ispmt = function(rate, per, nper, pv) {
///
/// Returns the interest paid during a specific period of an investment. [Api set: ExcelApi 1.2]
///
/// Interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR.
/// Period for which you want to find the interest.
/// Number of payment periods in an investment.
/// Lump sum amount that a series of future payments is right now.
///
}
Functions.prototype.isref = function(value) {
///
/// Checks whether a value is a reference, and returns TRUE or FALSE. [Api set: ExcelApi 1.2]
///
/// Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.
///
}
Functions.prototype.kurt = function(values) {
///
/// Returns the kurtosis of a data set. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the kurtosis.
///
}
Functions.prototype.large = function(array, k) {
///
/// Returns the k-th largest value in a data set. For example, the fifth largest number. [Api set: ExcelApi 1.2]
///
/// Is the array or range of data for which you want to determine the k-th largest value.
/// Is the position (from the largest) in the array or cell range of the value to return.
///
}
Functions.prototype.lcm = function(values) {
///
/// Returns the least common multiple. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 values for which you want the least common multiple.
///
}
Functions.prototype.left = function(text, numChars) {
///
/// Returns the specified number of characters from the start of a text string. [Api set: ExcelApi 1.2]
///
/// Is the text string containing the characters you want to extract.
/// Specifies how many characters you want LEFT to extract; 1 if omitted.
///
}
Functions.prototype.leftb = function(text, numBytes) {
///
/// Returns the specified number of characters from the start of a text string. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2]
///
/// Is the text string containing the characters you want to extract.
/// Specifies how many characters you want LEFT to return.
///
}
Functions.prototype.len = function(text) {
///
/// Returns the number of characters in a text string. [Api set: ExcelApi 1.2]
///
/// Is the text whose length you want to find. Spaces count as characters.
///
}
Functions.prototype.lenb = function(text) {
///
/// Returns the number of characters in a text string. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2]
///
/// Is the text whose length you want to find.
///
}
Functions.prototype.ln = function(number) {
///
/// Returns the natural logarithm of a number. [Api set: ExcelApi 1.2]
///
/// Is the positive real number for which you want the natural logarithm.
///
}
Functions.prototype.log = function(number, base) {
///
/// Returns the logarithm of a number to the base you specify. [Api set: ExcelApi 1.2]
///
/// Is the positive real number for which you want the logarithm.
/// Is the base of the logarithm; 10 if omitted.
///
}
Functions.prototype.log10 = function(number) {
///
/// Returns the base-10 logarithm of a number. [Api set: ExcelApi 1.2]
///
/// Is the positive real number for which you want the base-10 logarithm.
///
}
Functions.prototype.logNorm_Dist = function(x, mean, standardDev, cumulative) {
///
/// Returns the lognormal distribution of x, where ln(x) is normally distributed with parameters Mean and Standard_dev. [Api set: ExcelApi 1.2]
///
/// Is the value at which to evaluate the function, a positive number.
/// Is the mean of ln(x).
/// Is the standard deviation of ln(x), a positive number.
/// Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE.
///
}
Functions.prototype.logNorm_Inv = function(probability, mean, standardDev) {
///
/// Returns the inverse of the lognormal cumulative distribution function of x, where ln(x) is normally distributed with parameters Mean and Standard_dev. [Api set: ExcelApi 1.2]
///
/// Is a probability associated with the lognormal distribution, a number between 0 and 1, inclusive.
/// Is the mean of ln(x).
/// Is the standard deviation of ln(x), a positive number.
///
}
Functions.prototype.lookup = function(lookupValue, lookupVector, resultVector) {
///
/// Looks up a value either from a one-row or one-column range or from an array. Provided for backward compatibility. [Api set: ExcelApi 1.2]
///
/// Is a value that LOOKUP searches for in lookupVector and can be a number, text, a logical value, or a name or reference to a value.
/// Is a range that contains only one row or one column of text, numbers, or logical values, placed in ascending order.
/// Is a range that contains only one row or column, the same size as lookupVector.
///
}
Functions.prototype.lower = function(text) {
///
/// Converts all letters in a text string to lowercase. [Api set: ExcelApi 1.2]
///
/// Is the text you want to convert to lowercase. Characters in Text that are not letters are not changed.
///
}
Functions.prototype.mduration = function(settlement, maturity, coupon, yld, frequency, basis) {
///
/// Returns the Macauley modified duration for a security with an assumed par value of $100. [Api set: ExcelApi 1.2]
///
/// Is the security's settlement date, expressed as a serial date number.
/// Is the security's maturity date, expressed as a serial date number.
/// Is the security's annual coupon rate.
/// Is the security's annual yield.
/// Is the number of coupon payments per year.
/// Is the type of day count basis to use.
///
}
Functions.prototype.mirr = function(values, financeRate, reinvestRate) {
///
/// Returns the internal rate of return for a series of periodic cash flows, considering both cost of investment and interest on reinvestment of cash. [Api set: ExcelApi 1.2]
///
/// Is an array or a reference to cells that contain numbers that represent a series of payments (negative) and income (positive) at regular periods.
/// Is the interest rate you pay on the money used in the cash flows.
/// Is the interest rate you receive on the cash flows as you reinvest them.
///
}
Functions.prototype.mround = function(number, multiple) {
///
/// Returns a number rounded to the desired multiple. [Api set: ExcelApi 1.2]
///
/// Is the value to round.
/// Is the multiple to which you want to round number.
///
}
Functions.prototype.match = function(lookupValue, lookupArray, matchType) {
///
/// Returns the relative position of an item in an array that matches a specified value in a specified order. [Api set: ExcelApi 1.2]
///
/// Is the value you use to find the value you want in the array, a number, text, or logical value, or a reference to one of these.
/// Is a contiguous range of cells containing possible lookup values, an array of values, or a reference to an array.
/// Is a number 1, 0, or -1 indicating which value to return.
///
}
Functions.prototype.max = function(values) {
///
/// Returns the largest value in a set of values. Ignores logical values and text. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the maximum.
///
}
Functions.prototype.maxA = function(values) {
///
/// Returns the largest value in a set of values. Does not ignore logical values and text. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the maximum.
///
}
Functions.prototype.median = function(values) {
///
/// Returns the median, or the number in the middle of the set of given numbers. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the median.
///
}
Functions.prototype.mid = function(text, startNum, numChars) {
///
/// Returns the characters from the middle of a text string, given a starting position and length. [Api set: ExcelApi 1.2]
///
/// Is the text string from which you want to extract the characters.
/// Is the position of the first character you want to extract. The first character in Text is 1.
/// Specifies how many characters to return from Text.
///
}
Functions.prototype.midb = function(text, startNum, numBytes) {
///
/// Returns characters from the middle of a text string, given a starting position and length. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2]
///
/// Is the text string containing the characters you want to extract.
/// Is the position of the first character you want to extract in text.
/// Specifies how many characters to return from text.
///
}
Functions.prototype.min = function(values) {
///
/// Returns the smallest number in a set of values. Ignores logical values and text. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the minimum.
///
}
Functions.prototype.minA = function(values) {
///
/// Returns the smallest value in a set of values. Does not ignore logical values and text. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the minimum.
///
}
Functions.prototype.minute = function(serialNumber) {
///
/// Returns the minute, a number from 0 to 59. [Api set: ExcelApi 1.2]
///
/// Is a number in the date-time code used by Microsoft Excel or text in time format, such as 16:48:00 or 4:48:00 PM.
///
}
Functions.prototype.mod = function(number, divisor) {
///
/// Returns the remainder after a number is divided by a divisor. [Api set: ExcelApi 1.2]
///
/// Is the number for which you want to find the remainder after the division is performed.
/// Is the number by which you want to divide Number.
///
}
Functions.prototype.month = function(serialNumber) {
///
/// Returns the month, a number from 1 (January) to 12 (December). [Api set: ExcelApi 1.2]
///
/// Is a number in the date-time code used by Microsoft Excel.
///
}
Functions.prototype.multiNomial = function(values) {
///
/// Returns the multinomial of a set of numbers. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 values for which you want the multinomial.
///
}
Functions.prototype.n = function(value) {
///
/// Converts non-number value to a number, dates to serial numbers, TRUE to 1, anything else to 0 (zero). [Api set: ExcelApi 1.2]
///
/// Is the value you want converted.
///
}
Functions.prototype.nper = function(rate, pmt, pv, fv, type) {
///
/// Returns the number of periods for an investment based on periodic, constant payments and a constant interest rate. [Api set: ExcelApi 1.2]
///
/// Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR.
/// Is the payment made each period; it cannot change over the life of the investment.
/// Is the present value, or the lump-sum amount that a series of future payments is worth now.
/// Is the future value, or a cash balance you want to attain after the last payment is made. If omitted, zero is used.
/// Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted.
///
}
Functions.prototype.na = function() {
///
/// Returns the error value #N/A (value not available). [Api set: ExcelApi 1.2]
///
///
}
Functions.prototype.negBinom_Dist = function(numberF, numberS, probabilityS, cumulative) {
///
/// Returns the negative binomial distribution, the probability that there will be Number_f failures before the Number_s-th success, with Probability_s probability of a success. [Api set: ExcelApi 1.2]
///
/// Is the number of failures.
/// Is the threshold number of successes.
/// Is the probability of a success; a number between 0 and 1.
/// Is a logical value: for the cumulative distribution function, use TRUE; for the probability mass function, use FALSE.
///
}
Functions.prototype.networkDays = function(startDate, endDate, holidays) {
///
/// Returns the number of whole workdays between two dates. [Api set: ExcelApi 1.2]
///
/// Is a serial date number that represents the start date.
/// Is a serial date number that represents the end date.
/// Is an optional set of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays.
///
}
Functions.prototype.networkDays_Intl = function(startDate, endDate, weekend, holidays) {
///
/// Returns the number of whole workdays between two dates with custom weekend parameters. [Api set: ExcelApi 1.2]
///
/// Is a serial date number that represents the start date.
/// Is a serial date number that represents the end date.
/// Is a number or string specifying when weekends occur.
/// Is an optional set of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays.
///
}
Functions.prototype.nominal = function(effectRate, npery) {
///
/// Returns the annual nominal interest rate. [Api set: ExcelApi 1.2]
///
/// Is the effective interest rate.
/// Is the number of compounding periods per year.
///
}
Functions.prototype.norm_Dist = function(x, mean, standardDev, cumulative) {
///
/// Returns the normal distribution for the specified mean and standard deviation. [Api set: ExcelApi 1.2]
///
/// Is the value for which you want the distribution.
/// Is the arithmetic mean of the distribution.
/// Is the standard deviation of the distribution, a positive number.
/// Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE.
///
}
Functions.prototype.norm_Inv = function(probability, mean, standardDev) {
///
/// Returns the inverse of the normal cumulative distribution for the specified mean and standard deviation. [Api set: ExcelApi 1.2]
///
/// Is a probability corresponding to the normal distribution, a number between 0 and 1 inclusive.
/// Is the arithmetic mean of the distribution.
/// Is the standard deviation of the distribution, a positive number.
///
}
Functions.prototype.norm_S_Dist = function(z, cumulative) {
///
/// Returns the standard normal distribution (has a mean of zero and a standard deviation of one). [Api set: ExcelApi 1.2]
///
/// Is the value for which you want the distribution.
/// Is a logical value for the function to return: the cumulative distribution function = TRUE; the probability density function = FALSE.
///
}
Functions.prototype.norm_S_Inv = function(probability) {
///
/// Returns the inverse of the standard normal cumulative distribution (has a mean of zero and a standard deviation of one). [Api set: ExcelApi 1.2]
///
/// Is a probability corresponding to the normal distribution, a number between 0 and 1 inclusive.
///
}
Functions.prototype.not = function(logical) {
///
/// Changes FALSE to TRUE, or TRUE to FALSE. [Api set: ExcelApi 1.2]
///
/// Is a value or expression that can be evaluated to TRUE or FALSE.
///
}
Functions.prototype.now = function() {
///
/// Returns the current date and time formatted as a date and time. [Api set: ExcelApi 1.2]
///
///
}
Functions.prototype.npv = function(rate, values) {
///
/// Returns the net present value of an investment based on a discount rate and a series of future payments (negative values) and income (positive values). [Api set: ExcelApi 1.2]
///
/// Is the rate of discount over the length of one period.
/// List of parameters, whose elements are 1 to 254 payments and income, equally spaced in time and occurring at the end of each period.
///
}
Functions.prototype.numberValue = function(text, decimalSeparator, groupSeparator) {
///
/// Converts text to number in a locale-independent manner. [Api set: ExcelApi 1.2]
///
/// Is the string representing the number you want to convert.
/// Is the character used as the decimal separator in the string.
/// Is the character used as the group separator in the string.
///
}
Functions.prototype.oct2Bin = function(number, places) {
///
/// Converts an octal number to binary. [Api set: ExcelApi 1.2]
///
/// Is the octal number you want to convert.
/// Is the number of characters to use.
///
}
Functions.prototype.oct2Dec = function(number) {
///
/// Converts an octal number to decimal. [Api set: ExcelApi 1.2]
///
/// Is the octal number you want to convert.
///
}
Functions.prototype.oct2Hex = function(number, places) {
///
/// Converts an octal number to hexadecimal. [Api set: ExcelApi 1.2]
///
/// Is the octal number you want to convert.
/// Is the number of characters to use.
///
}
Functions.prototype.odd = function(number) {
///
/// Rounds a positive number up and negative number down to the nearest odd integer. [Api set: ExcelApi 1.2]
///
/// Is the value to round.
///
}
Functions.prototype.oddFPrice = function(settlement, maturity, issue, firstCoupon, rate, yld, redemption, frequency, basis) {
///
/// Returns the price per $100 face value of a security with an odd first period. [Api set: ExcelApi 1.2]
///
/// Is the security's settlement date, expressed as a serial date number.
/// Is the security's maturity date, expressed as a serial date number.
/// Is the security's issue date, expressed as a serial date number.
/// Is the security's first coupon date, expressed as a serial date number.
/// Is the security's interest rate.
/// Is the security's annual yield.
/// Is the security's redemption value per $100 face value.
/// Is the number of coupon payments per year.
/// Is the type of day count basis to use.
///
}
Functions.prototype.oddFYield = function(settlement, maturity, issue, firstCoupon, rate, pr, redemption, frequency, basis) {
///
/// Returns the yield of a security with an odd first period. [Api set: ExcelApi 1.2]
///
/// Is the security's settlement date, expressed as a serial date number.
/// Is the security's maturity date, expressed as a serial date number.
/// Is the security's issue date, expressed as a serial date number.
/// Is the security's first coupon date, expressed as a serial date number.
/// Is the security's interest rate.
/// Is the security's price.
/// Is the security's redemption value per $100 face value.
/// Is the number of coupon payments per year.
/// Is the type of day count basis to use.
///
}
Functions.prototype.oddLPrice = function(settlement, maturity, lastInterest, rate, yld, redemption, frequency, basis) {
///
/// Returns the price per $100 face value of a security with an odd last period. [Api set: ExcelApi 1.2]
///
/// Is the security's settlement date, expressed as a serial date number.
/// Is the security's maturity date, expressed as a serial date number.
/// Is the security's last coupon date, expressed as a serial date number.
/// Is the security's interest rate.
/// Is the security's annual yield.
/// Is the security's redemption value per $100 face value.
/// Is the number of coupon payments per year.
/// Is the type of day count basis to use.
///
}
Functions.prototype.oddLYield = function(settlement, maturity, lastInterest, rate, pr, redemption, frequency, basis) {
///
/// Returns the yield of a security with an odd last period. [Api set: ExcelApi 1.2]
///
/// Is the security's settlement date, expressed as a serial date number.
/// Is the security's maturity date, expressed as a serial date number.
/// Is the security's last coupon date, expressed as a serial date number.
/// Is the security's interest rate.
/// Is the security's price.
/// Is the security's redemption value per $100 face value.
/// Is the number of coupon payments per year.
/// Is the type of day count basis to use.
///
}
Functions.prototype.or = function(values) {
///
/// Checks whether any of the arguments are TRUE, and returns TRUE or FALSE. Returns FALSE only if all arguments are FALSE. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 conditions that you want to test that can be either TRUE or FALSE.
///
}
Functions.prototype.pduration = function(rate, pv, fv) {
///
/// Returns the number of periods required by an investment to reach a specified value. [Api set: ExcelApi 1.2]
///
/// Is the interest rate per period.
/// Is the present value of the investment.
/// Is the desired future value of the investment.
///
}
Functions.prototype.percentRank_Exc = function(array, x, significance) {
///
/// Returns the rank of a value in a data set as a percentage of the data set as a percentage (0..1, exclusive) of the data set. [Api set: ExcelApi 1.2]
///
/// Is the array or range of data with numeric values that defines relative standing.
/// Is the value for which you want to know the rank.
/// Is an optional value that identifies the number of significant digits for the returned percentage, three digits if omitted (0.xxx%).
///
}
Functions.prototype.percentRank_Inc = function(array, x, significance) {
///
/// Returns the rank of a value in a data set as a percentage of the data set as a percentage (0..1, inclusive) of the data set. [Api set: ExcelApi 1.2]
///
/// Is the array or range of data with numeric values that defines relative standing.
/// Is the value for which you want to know the rank.
/// Is an optional value that identifies the number of significant digits for the returned percentage, three digits if omitted (0.xxx%).
///
}
Functions.prototype.percentile_Exc = function(array, k) {
///
/// Returns the k-th percentile of values in a range, where k is in the range 0..1, exclusive. [Api set: ExcelApi 1.2]
///
/// Is the array or range of data that defines relative standing.
/// Is the percentile value that is between 0 through 1, inclusive.
///
}
Functions.prototype.percentile_Inc = function(array, k) {
///
/// Returns the k-th percentile of values in a range, where k is in the range 0..1, inclusive. [Api set: ExcelApi 1.2]
///
/// Is the array or range of data that defines relative standing.
/// Is the percentile value that is between 0 through 1, inclusive.
///
}
Functions.prototype.permut = function(number, numberChosen) {
///
/// Returns the number of permutations for a given number of objects that can be selected from the total objects. [Api set: ExcelApi 1.2]
///
/// Is the total number of objects.
/// Is the number of objects in each permutation.
///
}
Functions.prototype.permutationa = function(number, numberChosen) {
///
/// Returns the number of permutations for a given number of objects (with repetitions) that can be selected from the total objects. [Api set: ExcelApi 1.2]
///
/// Is the total number of objects.
/// Is the number of objects in each permutation.
///
}
Functions.prototype.phi = function(x) {
///
/// Returns the value of the density function for a standard normal distribution. [Api set: ExcelApi 1.2]
///
/// Is the number for which you want the density of the standard normal distribution.
///
}
Functions.prototype.pi = function() {
///
/// Returns the value of Pi, 3.14159265358979, accurate to 15 digits. [Api set: ExcelApi 1.2]
///
///
}
Functions.prototype.pmt = function(rate, nper, pv, fv, type) {
///
/// Calculates the payment for a loan based on constant payments and a constant interest rate. [Api set: ExcelApi 1.2]
///
/// Is the interest rate per period for the loan. For example, use 6%/4 for quarterly payments at 6% APR.
/// Is the total number of payments for the loan.
/// Is the present value: the total amount that a series of future payments is worth now.
/// Is the future value, or a cash balance you want to attain after the last payment is made, 0 (zero) if omitted.
/// Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted.
///
}
Functions.prototype.poisson_Dist = function(x, mean, cumulative) {
///
/// Returns the Poisson distribution. [Api set: ExcelApi 1.2]
///
/// Is the number of events.
/// Is the expected numeric value, a positive number.
/// Is a logical value: for the cumulative Poisson probability, use TRUE; for the Poisson probability mass function, use FALSE.
///
}
Functions.prototype.power = function(number, power) {
///
/// Returns the result of a number raised to a power. [Api set: ExcelApi 1.2]
///
/// Is the base number, any real number.
/// Is the exponent, to which the base number is raised.
///
}
Functions.prototype.ppmt = function(rate, per, nper, pv, fv, type) {
///
/// Returns the payment on the principal for a given investment based on periodic, constant payments and a constant interest rate. [Api set: ExcelApi 1.2]
///
/// Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR.
/// Specifies the period and must be in the range 1 to nper.
/// Is the total number of payment periods in an investment.
/// Is the present value: the total amount that a series of future payments is worth now.
/// Is the future value, or cash balance you want to attain after the last payment is made.
/// Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted.
///
}
Functions.prototype.price = function(settlement, maturity, rate, yld, redemption, frequency, basis) {
///
/// Returns the price per $100 face value of a security that pays periodic interest. [Api set: ExcelApi 1.2]
///
/// Is the security's settlement date, expressed as a serial date number.
/// Is the security's maturity date, expressed as a serial date number.
/// Is the security's annual coupon rate.
/// Is the security's annual yield.
/// Is the security's redemption value per $100 face value.
/// Is the number of coupon payments per year.
/// Is the type of day count basis to use.
///
}
Functions.prototype.priceDisc = function(settlement, maturity, discount, redemption, basis) {
///
/// Returns the price per $100 face value of a discounted security. [Api set: ExcelApi 1.2]
///
/// Is the security's settlement date, expressed as a serial date number.
/// Is the security's maturity date, expressed as a serial date number.
/// Is the security's discount rate.
/// Is the security's redemption value per $100 face value.
/// Is the type of day count basis to use.
///
}
Functions.prototype.priceMat = function(settlement, maturity, issue, rate, yld, basis) {
///
/// Returns the price per $100 face value of a security that pays interest at maturity. [Api set: ExcelApi 1.2]
///
/// Is the security's settlement date, expressed as a serial date number.
/// Is the security's maturity date, expressed as a serial date number.
/// Is the security's issue date, expressed as a serial date number.
/// Is the security's interest rate at date of issue.
/// Is the security's annual yield.
/// Is the type of day count basis to use.
///
}
Functions.prototype.product = function(values) {
///
/// Multiplies all the numbers given as arguments. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 numbers, logical values, or text representations of numbers that you want to multiply.
///
}
Functions.prototype.proper = function(text) {
///
/// Converts a text string to proper case; the first letter in each word to uppercase, and all other letters to lowercase. [Api set: ExcelApi 1.2]
///
/// Is text enclosed in quotation marks, a formula that returns text, or a reference to a cell containing text to partially capitalize.
///
}
Functions.prototype.pv = function(rate, nper, pmt, fv, type) {
///
/// Returns the present value of an investment: the total amount that a series of future payments is worth now. [Api set: ExcelApi 1.2]
///
/// Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR.
/// Is the total number of payment periods in an investment.
/// Is the payment made each period and cannot change over the life of the investment.
/// Is the future value, or a cash balance you want to attain after the last payment is made.
/// Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted.
///
}
Functions.prototype.quartile_Exc = function(array, quart) {
///
/// Returns the quartile of a data set, based on percentile values from 0..1, exclusive. [Api set: ExcelApi 1.2]
///
/// Is the array or cell range of numeric values for which you want the quartile value.
/// Is a number: minimum value = 0; 1st quartile = 1; median value = 2; 3rd quartile = 3; maximum value = 4.
///
}
Functions.prototype.quartile_Inc = function(array, quart) {
///
/// Returns the quartile of a data set, based on percentile values from 0..1, inclusive. [Api set: ExcelApi 1.2]
///
/// Is the array or cell range of numeric values for which you want the quartile value.
/// Is a number: minimum value = 0; 1st quartile = 1; median value = 2; 3rd quartile = 3; maximum value = 4.
///
}
Functions.prototype.quotient = function(numerator, denominator) {
///
/// Returns the integer portion of a division. [Api set: ExcelApi 1.2]
///
/// Is the dividend.
/// Is the divisor.
///
}
Functions.prototype.radians = function(angle) {
///
/// Converts degrees to radians. [Api set: ExcelApi 1.2]
///
/// Is an angle in degrees that you want to convert.
///
}
Functions.prototype.rand = function() {
///
/// Returns a random number greater than or equal to 0 and less than 1, evenly distributed (changes on recalculation). [Api set: ExcelApi 1.2]
///
///
}
Functions.prototype.randBetween = function(bottom, top) {
///
/// Returns a random number between the numbers you specify. [Api set: ExcelApi 1.2]
///
/// Is the smallest integer RANDBETWEEN will return.
/// Is the largest integer RANDBETWEEN will return.
///
}
Functions.prototype.rank_Avg = function(number, ref, order) {
///
/// Returns the rank of a number in a list of numbers: its size relative to other values in the list; if more than one value has the same rank, the average rank is returned. [Api set: ExcelApi 1.2]
///
/// Is the number for which you want to find the rank.
/// Is an array of, or a reference to, a list of numbers. Nonnumeric values are ignored.
/// Is a number: rank in the list sorted descending = 0 or omitted; rank in the list sorted ascending = any nonzero value.
///
}
Functions.prototype.rank_Eq = function(number, ref, order) {
///
/// Returns the rank of a number in a list of numbers: its size relative to other values in the list; if more than one value has the same rank, the top rank of that set of values is returned. [Api set: ExcelApi 1.2]
///
/// Is the number for which you want to find the rank.
/// Is an array of, or a reference to, a list of numbers. Nonnumeric values are ignored.
/// Is a number: rank in the list sorted descending = 0 or omitted; rank in the list sorted ascending = any nonzero value.
///
}
Functions.prototype.rate = function(nper, pmt, pv, fv, type, guess) {
///
/// Returns the interest rate per period of a loan or an investment. For example, use 6%/4 for quarterly payments at 6% APR. [Api set: ExcelApi 1.2]
///
/// Is the total number of payment periods for the loan or investment.
/// Is the payment made each period and cannot change over the life of the loan or investment.
/// Is the present value: the total amount that a series of future payments is worth now.
/// Is the future value, or a cash balance you want to attain after the last payment is made. If omitted, uses Fv = 0.
/// Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted.
/// Is your guess for what the rate will be; if omitted, Guess = 0.1 (10 percent).
///
}
Functions.prototype.received = function(settlement, maturity, investment, discount, basis) {
///
/// Returns the amount received at maturity for a fully invested security. [Api set: ExcelApi 1.2]
///
/// Is the security's settlement date, expressed as a serial date number.
/// Is the security's maturity date, expressed as a serial date number.
/// Is the amount invested in the security.
/// Is the security's discount rate.
/// Is the type of day count basis to use.
///
}
Functions.prototype.replace = function(oldText, startNum, numChars, newText) {
///
/// Replaces part of a text string with a different text string. [Api set: ExcelApi 1.2]
///
/// Is text in which you want to replace some characters.
/// Is the position of the character in oldText that you want to replace with newText.
/// Is the number of characters in oldText that you want to replace.
/// Is the text that will replace characters in oldText.
///
}
Functions.prototype.replaceB = function(oldText, startNum, numBytes, newText) {
///
/// Replaces part of a text string with a different text string. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2]
///
/// Is text in which you want to replace some characters.
/// Is the position of the character in oldText that you want to replace with newText.
/// Is the number of characters in oldText that you want to replace with newText.
/// Is the text that will replace characters in oldText.
///
}
Functions.prototype.rept = function(text, numberTimes) {
///
/// Repeats text a given number of times. Use REPT to fill a cell with a number of instances of a text string. [Api set: ExcelApi 1.2]
///
/// Is the text you want to repeat.
/// Is a positive number specifying the number of times to repeat text.
///
}
Functions.prototype.right = function(text, numChars) {
///
/// Returns the specified number of characters from the end of a text string. [Api set: ExcelApi 1.2]
///
/// Is the text string that contains the characters you want to extract.
/// Specifies how many characters you want to extract, 1 if omitted.
///
}
Functions.prototype.rightb = function(text, numBytes) {
///
/// Returns the specified number of characters from the end of a text string. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2]
///
/// Is the text string containing the characters you want to extract.
/// Specifies how many characters you want to extract.
///
}
Functions.prototype.roman = function(number, form) {
///
/// Converts an Arabic numeral to Roman, as text. [Api set: ExcelApi 1.2]
///
/// Is the Arabic numeral you want to convert.
/// Is the number specifying the type of Roman numeral you want.
///
}
Functions.prototype.round = function(number, numDigits) {
///
/// Rounds a number to a specified number of digits. [Api set: ExcelApi 1.2]
///
/// Is the number you want to round.
/// Is the number of digits to which you want to round. Negative rounds to the left of the decimal point; zero to the nearest integer.
///
}
Functions.prototype.roundDown = function(number, numDigits) {
///
/// Rounds a number down, toward zero. [Api set: ExcelApi 1.2]
///
/// Is any real number that you want rounded down.
/// Is the number of digits to which you want to round. Negative rounds to the left of the decimal point; zero or omitted, to the nearest integer.
///
}
Functions.prototype.roundUp = function(number, numDigits) {
///
/// Rounds a number up, away from zero. [Api set: ExcelApi 1.2]
///
/// Is any real number that you want rounded up.
/// Is the number of digits to which you want to round. Negative rounds to the left of the decimal point; zero or omitted, to the nearest integer.
///
}
Functions.prototype.rows = function(array) {
///
/// Returns the number of rows in a reference or array. [Api set: ExcelApi 1.2]
///
/// Is an array, an array formula, or a reference to a range of cells for which you want the number of rows.
///
}
Functions.prototype.rri = function(nper, pv, fv) {
///
/// Returns an equivalent interest rate for the growth of an investment. [Api set: ExcelApi 1.2]
///
/// Is the number of periods for the investment.
/// Is the present value of the investment.
/// Is the future value of the investment.
///
}
Functions.prototype.sec = function(number) {
///
/// Returns the secant of an angle. [Api set: ExcelApi 1.2]
///
/// Is the angle in radians for which you want the secant.
///
}
Functions.prototype.sech = function(number) {
///
/// Returns the hyperbolic secant of an angle. [Api set: ExcelApi 1.2]
///
/// Is the angle in radians for which you want the hyperbolic secant.
///
}
Functions.prototype.second = function(serialNumber) {
///
/// Returns the second, a number from 0 to 59. [Api set: ExcelApi 1.2]
///
/// Is a number in the date-time code used by Microsoft Excel or text in time format, such as 16:48:23 or 4:48:47 PM.
///
}
Functions.prototype.seriesSum = function(x, n, m, coefficients) {
///
/// Returns the sum of a power series based on the formula. [Api set: ExcelApi 1.2]
///
/// Is the input value to the power series.
/// Is the initial power to which you want to raise x.
/// Is the step by which to increase n for each term in the series.
/// Is a set of coefficients by which each successive power of x is multiplied.
///
}
Functions.prototype.sheet = function(value) {
///
/// Returns the sheet number of the referenced sheet. [Api set: ExcelApi 1.2]
///
/// Is the name of a sheet or a reference that you want the sheet number of. If omitted the number of the sheet containing the function is returned.
///
}
Functions.prototype.sheets = function(reference) {
///
/// Returns the number of sheets in a reference. [Api set: ExcelApi 1.2]
///
/// Is a reference for which you want to know the number of sheets it contains. If omitted the number of sheets in the workbook containing the function is returned.
///
}
Functions.prototype.sign = function(number) {
///
/// Returns the sign of a number: 1 if the number is positive, zero if the number is zero, or -1 if the number is negative. [Api set: ExcelApi 1.2]
///
/// Is any real number.
///
}
Functions.prototype.sin = function(number) {
///
/// Returns the sine of an angle. [Api set: ExcelApi 1.2]
///
/// Is the angle in radians for which you want the sine. Degrees * PI()/180 = radians.
///
}
Functions.prototype.sinh = function(number) {
///
/// Returns the hyperbolic sine of a number. [Api set: ExcelApi 1.2]
///
/// Is any real number.
///
}
Functions.prototype.skew = function(values) {
///
/// Returns the skewness of a distribution: a characterization of the degree of asymmetry of a distribution around its mean. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the skewness.
///
}
Functions.prototype.skew_p = function(values) {
///
/// Returns the skewness of a distribution based on a population: a characterization of the degree of asymmetry of a distribution around its mean. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 254 numbers or names, arrays, or references that contain numbers for which you want the population skewness.
///
}
Functions.prototype.sln = function(cost, salvage, life) {
///
/// Returns the straight-line depreciation of an asset for one period. [Api set: ExcelApi 1.2]
///
/// Is the initial cost of the asset.
/// Is the salvage value at the end of the life of the asset.
/// Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset).
///
}
Functions.prototype.small = function(array, k) {
///
/// Returns the k-th smallest value in a data set. For example, the fifth smallest number. [Api set: ExcelApi 1.2]
///
/// Is an array or range of numerical data for which you want to determine the k-th smallest value.
/// Is the position (from the smallest) in the array or range of the value to return.
///
}
Functions.prototype.sqrt = function(number) {
///
/// Returns the square root of a number. [Api set: ExcelApi 1.2]
///
/// Is the number for which you want the square root.
///
}
Functions.prototype.sqrtPi = function(number) {
///
/// Returns the square root of (number * Pi). [Api set: ExcelApi 1.2]
///
/// Is the number by which p is multiplied.
///
}
Functions.prototype.stDevA = function(values) {
///
/// Estimates standard deviation based on a sample, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 values corresponding to a sample of a population and can be values or names or references to values.
///
}
Functions.prototype.stDevPA = function(values) {
///
/// Calculates standard deviation based on an entire population, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 values corresponding to a population and can be values, names, arrays, or references that contain values.
///
}
Functions.prototype.stDev_P = function(values) {
///
/// Calculates standard deviation based on the entire population given as arguments (ignores logical values and text). [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 numbers corresponding to a population and can be numbers or references that contain numbers.
///
}
Functions.prototype.stDev_S = function(values) {
///
/// Estimates standard deviation based on a sample (ignores logical values and text in the sample). [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 numbers corresponding to a sample of a population and can be numbers or references that contain numbers.
///
}
Functions.prototype.standardize = function(x, mean, standardDev) {
///
/// Returns a normalized value from a distribution characterized by a mean and standard deviation. [Api set: ExcelApi 1.2]
///
/// Is the value you want to normalize.
/// Is the arithmetic mean of the distribution.
/// Is the standard deviation of the distribution, a positive number.
///
}
Functions.prototype.substitute = function(text, oldText, newText, instanceNum) {
///
/// Replaces existing text with new text in a text string. [Api set: ExcelApi 1.2]
///
/// Is the text or the reference to a cell containing text in which you want to substitute characters.
/// Is the existing text you want to replace. If the case of oldText does not match the case of text, SUBSTITUTE will not replace the text.
/// Is the text you want to replace oldText with.
/// Specifies which occurrence of oldText you want to replace. If omitted, every instance of oldText is replaced.
///
}
Functions.prototype.subtotal = function(functionNum, values) {
///
/// Returns a subtotal in a list or database. [Api set: ExcelApi 1.2]
///
/// Is the number 1 to 11 that specifies the summary function for the subtotal.
/// List of parameters, whose elements are 1 to 254 ranges or references for which you want the subtotal.
///
}
Functions.prototype.sum = function(values) {
///
/// Adds all the numbers in a range of cells. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 numbers to sum. Logical values and text are ignored in cells, included if typed as arguments.
///
}
Functions.prototype.sumIf = function(range, criteria, sumRange) {
///
/// Adds the cells specified by a given condition or criteria. [Api set: ExcelApi 1.2]
///
/// Is the range of cells you want evaluated.
/// Is the condition or criteria in the form of a number, expression, or text that defines which cells will be added.
/// Are the actual cells to sum. If omitted, the cells in range are used.
///
}
Functions.prototype.sumIfs = function(sumRange, values) {
///
/// Adds the cells specified by a given set of conditions or criteria. [Api set: ExcelApi 1.2]
///
/// Are the actual cells to sum.
/// List of parameters, where the first element of each pair is the Is the range of cells you want evaluated for the particular condition , and the second element is is the condition or criteria in the form of a number, expression, or text that defines which cells will be added.
///
}
Functions.prototype.sumSq = function(values) {
///
/// Returns the sum of the squares of the arguments. The arguments can be numbers, arrays, names, or references to cells that contain numbers. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 numbers, arrays, names, or references to arrays for which you want the sum of the squares.
///
}
Functions.prototype.syd = function(cost, salvage, life, per) {
///
/// Returns the sum-of-years' digits depreciation of an asset for a specified period. [Api set: ExcelApi 1.2]
///
/// Is the initial cost of the asset.
/// Is the salvage value at the end of the life of the asset.
/// Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset).
/// Is the period and must use the same units as Life.
///
}
Functions.prototype.t = function(value) {
///
/// Checks whether a value is text, and returns the text if it is, or returns double quotes (empty text) if it is not. [Api set: ExcelApi 1.2]
///
/// Is the value to test.
///
}
Functions.prototype.tbillEq = function(settlement, maturity, discount) {
///
/// Returns the bond-equivalent yield for a treasury bill. [Api set: ExcelApi 1.2]
///
/// Is the Treasury bill's settlement date, expressed as a serial date number.
/// Is the Treasury bill's maturity date, expressed as a serial date number.
/// Is the Treasury bill's discount rate.
///
}
Functions.prototype.tbillPrice = function(settlement, maturity, discount) {
///
/// Returns the price per $100 face value for a treasury bill. [Api set: ExcelApi 1.2]
///
/// Is the Treasury bill's settlement date, expressed as a serial date number.
/// Is the Treasury bill's maturity date, expressed as a serial date number.
/// Is the Treasury bill's discount rate.
///
}
Functions.prototype.tbillYield = function(settlement, maturity, pr) {
///
/// Returns the yield for a treasury bill. [Api set: ExcelApi 1.2]
///
/// Is the Treasury bill's settlement date, expressed as a serial date number.
/// Is the Treasury bill's maturity date, expressed as a serial date number.
/// Is the Treasury Bill's price per $100 face value.
///
}
Functions.prototype.t_Dist = function(x, degFreedom, cumulative) {
///
/// Returns the left-tailed Student's t-distribution. [Api set: ExcelApi 1.2]
///
/// Is the numeric value at which to evaluate the distribution.
/// Is an integer indicating the number of degrees of freedom that characterize the distribution.
/// Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE.
///
}
Functions.prototype.t_Dist_2T = function(x, degFreedom) {
///
/// Returns the two-tailed Student's t-distribution. [Api set: ExcelApi 1.2]
///
/// Is the numeric value at which to evaluate the distribution.
/// Is an integer indicating the number of degrees of freedom that characterize the distribution.
///
}
Functions.prototype.t_Dist_RT = function(x, degFreedom) {
///
/// Returns the right-tailed Student's t-distribution. [Api set: ExcelApi 1.2]
///
/// Is the numeric value at which to evaluate the distribution.
/// Is an integer indicating the number of degrees of freedom that characterize the distribution.
///
}
Functions.prototype.t_Inv = function(probability, degFreedom) {
///
/// Returns the left-tailed inverse of the Student's t-distribution. [Api set: ExcelApi 1.2]
///
/// Is the probability associated with the two-tailed Student's t-distribution, a number between 0 and 1 inclusive.
/// Is a positive integer indicating the number of degrees of freedom to characterize the distribution.
///
}
Functions.prototype.t_Inv_2T = function(probability, degFreedom) {
///
/// Returns the two-tailed inverse of the Student's t-distribution. [Api set: ExcelApi 1.2]
///
/// Is the probability associated with the two-tailed Student's t-distribution, a number between 0 and 1 inclusive.
/// Is a positive integer indicating the number of degrees of freedom to characterize the distribution.
///
}
Functions.prototype.tan = function(number) {
///
/// Returns the tangent of an angle. [Api set: ExcelApi 1.2]
///
/// Is the angle in radians for which you want the tangent. Degrees * PI()/180 = radians.
///
}
Functions.prototype.tanh = function(number) {
///
/// Returns the hyperbolic tangent of a number. [Api set: ExcelApi 1.2]
///
/// Is any real number.
///
}
Functions.prototype.text = function(value, formatText) {
///
/// Converts a value to text in a specific number format. [Api set: ExcelApi 1.2]
///
/// Is a number, a formula that evaluates to a numeric value, or a reference to a cell containing a numeric value.
/// Is a number format in text form from the Category box on the Number tab in the Format Cells dialog box (not General).
///
}
Functions.prototype.time = function(hour, minute, second) {
///
/// Converts hours, minutes, and seconds given as numbers to an Excel serial number, formatted with a time format. [Api set: ExcelApi 1.2]
///
/// Is a number from 0 to 23 representing the hour.
/// Is a number from 0 to 59 representing the minute.
/// Is a number from 0 to 59 representing the second.
///
}
Functions.prototype.timevalue = function(timeText) {
///
/// Converts a text time to an Excel serial number for a time, a number from 0 (12:00:00 AM) to 0.999988426 (11:59:59 PM). Format the number with a time format after entering the formula. [Api set: ExcelApi 1.2]
///
/// Is a text string that gives a time in any one of the Microsoft Excel time formats (date information in the string is ignored).
///
}
Functions.prototype.today = function() {
///
/// Returns the current date formatted as a date. [Api set: ExcelApi 1.2]
///
///
}
Functions.prototype.trim = function(text) {
///
/// Removes all spaces from a text string except for single spaces between words. [Api set: ExcelApi 1.2]
///
/// Is the text from which you want spaces removed.
///
}
Functions.prototype.trimMean = function(array, percent) {
///
/// Returns the mean of the interior portion of a set of data values. [Api set: ExcelApi 1.2]
///
/// Is the range or array of values to trim and average.
/// Is the fractional number of data points to exclude from the top and bottom of the data set.
///
}
Functions.prototype.true = function() {
///
/// Returns the logical value TRUE. [Api set: ExcelApi 1.2]
///
///
}
Functions.prototype.trunc = function(number, numDigits) {
///
/// Truncates a number to an integer by removing the decimal, or fractional, part of the number. [Api set: ExcelApi 1.2]
///
/// Is the number you want to truncate.
/// Is a number specifying the precision of the truncation, 0 (zero) if omitted.
///
}
Functions.prototype.type = function(value) {
///
/// Returns an integer representing the data type of a value: number = 1; text = 2; logical value = 4; error value = 16; array = 64. [Api set: ExcelApi 1.2]
///
/// Can be any value.
///
}
Functions.prototype.usdollar = function(number, decimals) {
///
/// Converts a number to text, using currency format. [Api set: ExcelApi 1.2]
///
/// Is a number, a reference to a cell containing a number, or a formula that evaluates to a number.
/// Is the number of digits to the right of the decimal point.
///
}
Functions.prototype.unichar = function(number) {
///
/// Returns the Unicode character referenced by the given numeric value. [Api set: ExcelApi 1.2]
///
/// Is the Unicode number representing a character.
///
}
Functions.prototype.unicode = function(text) {
///
/// Returns the number (code point) corresponding to the first character of the text. [Api set: ExcelApi 1.2]
///
/// Is the character that you want the Unicode value of.
///
}
Functions.prototype.upper = function(text) {
///
/// Converts a text string to all uppercase letters. [Api set: ExcelApi 1.2]
///
/// Is the text you want converted to uppercase, a reference or a text string.
///
}
Functions.prototype.vlookup = function(lookupValue, tableArray, colIndexNum, rangeLookup) {
///
/// Looks for a value in the leftmost column of a table, and then returns a value in the same row from a column you specify. By default, the table must be sorted in an ascending order. [Api set: ExcelApi 1.2]
///
/// Is the value to be found in the first column of the table, and can be a value, a reference, or a text string.
/// Is a table of text, numbers, or logical values, in which data is retrieved. tableArray can be a reference to a range or a range name.
/// Is the column number in tableArray from which the matching value should be returned. The first column of values in the table is column 1.
/// Is a logical value: to find the closest match in the first column (sorted in ascending order) = TRUE or omitted; find an exact match = FALSE.
///
}
Functions.prototype.value = function(text) {
///
/// Converts a text string that represents a number to a number. [Api set: ExcelApi 1.2]
///
/// Is the text enclosed in quotation marks or a reference to a cell containing the text you want to convert.
///
}
Functions.prototype.varA = function(values) {
///
/// Estimates variance based on a sample, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 value arguments corresponding to a sample of a population.
///
}
Functions.prototype.varPA = function(values) {
///
/// Calculates variance based on the entire population, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 value arguments corresponding to a population.
///
}
Functions.prototype.var_P = function(values) {
///
/// Calculates variance based on the entire population (ignores logical values and text in the population). [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 numeric arguments corresponding to a population.
///
}
Functions.prototype.var_S = function(values) {
///
/// Estimates variance based on a sample (ignores logical values and text in the sample). [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 255 numeric arguments corresponding to a sample of a population.
///
}
Functions.prototype.vdb = function(cost, salvage, life, startPeriod, endPeriod, factor, noSwitch) {
///
/// Returns the depreciation of an asset for any period you specify, including partial periods, using the double-declining balance method or some other method you specify. [Api set: ExcelApi 1.2]
///
/// Is the initial cost of the asset.
/// Is the salvage value at the end of the life of the asset.
/// Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset).
/// Is the starting period for which you want to calculate the depreciation, in the same units as Life.
/// Is the ending period for which you want to calculate the depreciation, in the same units as Life.
/// Is the rate at which the balance declines, 2 (double-declining balance) if omitted.
/// Switch to straight-line depreciation when depreciation is greater than the declining balance = FALSE or omitted; do not switch = TRUE.
///
}
Functions.prototype.weekNum = function(serialNumber, returnType) {
///
/// Returns the week number in the year. [Api set: ExcelApi 1.2]
///
/// Is the date-time code used by Microsoft Excel for date and time calculation.
/// Is a number (1 or 2) that determines the type of the return value.
///
}
Functions.prototype.weekday = function(serialNumber, returnType) {
///
/// Returns a number from 1 to 7 identifying the day of the week of a date. [Api set: ExcelApi 1.2]
///
/// Is a number that represents a date.
/// Is a number: for Sunday=1 through Saturday=7, use 1; for Monday=1 through Sunday=7, use 2; for Monday=0 through Sunday=6, use 3.
///
}
Functions.prototype.weibull_Dist = function(x, alpha, beta, cumulative) {
///
/// Returns the Weibull distribution. [Api set: ExcelApi 1.2]
///
/// Is the value at which to evaluate the function, a nonnegative number.
/// Is a parameter to the distribution, a positive number.
/// Is a parameter to the distribution, a positive number.
/// Is a logical value: for the cumulative distribution function, use TRUE; for the probability mass function, use FALSE.
///
}
Functions.prototype.workDay = function(startDate, days, holidays) {
///
/// Returns the serial number of the date before or after a specified number of workdays. [Api set: ExcelApi 1.2]
///
/// Is a serial date number that represents the start date.
/// Is the number of nonweekend and non-holiday days before or after startDate.
/// Is an optional array of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays.
///
}
Functions.prototype.workDay_Intl = function(startDate, days, weekend, holidays) {
///
/// Returns the serial number of the date before or after a specified number of workdays with custom weekend parameters. [Api set: ExcelApi 1.2]
///
/// Is a serial date number that represents the start date.
/// Is the number of nonweekend and non-holiday days before or after startDate.
/// Is a number or string specifying when weekends occur.
/// Is an optional array of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays.
///
}
Functions.prototype.xirr = function(values, dates, guess) {
///
/// Returns the internal rate of return for a schedule of cash flows. [Api set: ExcelApi 1.2]
///
/// Is a series of cash flows that correspond to a schedule of payments in dates.
/// Is a schedule of payment dates that corresponds to the cash flow payments.
/// Is a number that you guess is close to the result of XIRR.
///
}
Functions.prototype.xnpv = function(rate, values, dates) {
///
/// Returns the net present value for a schedule of cash flows. [Api set: ExcelApi 1.2]
///
/// Is the discount rate to apply to the cash flows.
/// Is a series of cash flows that correspond to a schedule of payments in dates.
/// Is a schedule of payment dates that corresponds to the cash flow payments.
///
}
Functions.prototype.xor = function(values) {
///
/// Returns a logical 'Exclusive Or' of all arguments. [Api set: ExcelApi 1.2]
///
/// List of parameters, whose elements are 1 to 254 conditions you want to test that can be either TRUE or FALSE and can be logical values, arrays, or references.
///
}
Functions.prototype.year = function(serialNumber) {
///
/// Returns the year of a date, an integer in the range 1900 - 9999. [Api set: ExcelApi 1.2]
///
/// Is a number in the date-time code used by Microsoft Excel.
///
}
Functions.prototype.yearFrac = function(startDate, endDate, basis) {
///
/// Returns the year fraction representing the number of whole days between start_date and end_date. [Api set: ExcelApi 1.2]
///
/// Is a serial date number that represents the start date.
/// Is a serial date number that represents the end date.
/// Is the type of day count basis to use.
///
}
Functions.prototype.yield = function(settlement, maturity, rate, pr, redemption, frequency, basis) {
///
/// Returns the yield on a security that pays periodic interest. [Api set: ExcelApi 1.2]
///
/// Is the security's settlement date, expressed as a serial date number.
/// Is the security's maturity date, expressed as a serial date number.
/// Is the security's annual coupon rate.
/// Is the security's price per $100 face value.
/// Is the security's redemption value per $100 face value.
/// Is the number of coupon payments per year.
/// Is the type of day count basis to use.
///
}
Functions.prototype.yieldDisc = function(settlement, maturity, pr, redemption, basis) {
///
/// Returns the annual yield for a discounted security. For example, a treasury bill. [Api set: ExcelApi 1.2]
///
/// Is the security's settlement date, expressed as a serial date number.
/// Is the security's maturity date, expressed as a serial date number.
/// Is the security's price per $100 face value.
/// Is the security's redemption value per $100 face value.
/// Is the type of day count basis to use.
///
}
Functions.prototype.yieldMat = function(settlement, maturity, issue, rate, pr, basis) {
///
/// Returns the annual yield of a security that pays interest at maturity. [Api set: ExcelApi 1.2]
///
/// Is the security's settlement date, expressed as a serial date number.
/// Is the security's maturity date, expressed as a serial date number.
/// Is the security's issue date, expressed as a serial date number.
/// Is the security's interest rate at date of issue.
/// Is the security's price per $100 face value.
/// Is the type of day count basis to use.
///
}
Functions.prototype.z_Test = function(array, x, sigma) {
///
/// Returns the one-tailed P-value of a z-test. [Api set: ExcelApi 1.2]
///
/// Is the array or range of data against which to test X.
/// Is the value to test.
/// Is the population (known) standard deviation. If omitted, the sample standard deviation is used.
///
}
return Functions;
})(OfficeExtension.ClientObject);
Excel.Functions = Functions;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var GeometricShape = (function(_super) {
__extends(GeometricShape, _super);
function GeometricShape() {
/// Represents a geometric shape inside a worksheet. A geometric shape can be a rectangle, block arrow, equation symbol, flowchart item, star, banner, callout, or any other basic shape in Excel. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Returns the shape identifier. [Api set: ExcelApi 1.9]
/// Returns the `Shape` object for the geometric shape. [Api set: ExcelApi 1.9]
}
GeometricShape.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
return GeometricShape;
})(OfficeExtension.ClientObject);
Excel.GeometricShape = GeometricShape;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Specifies the shape type for a `GeometricShape` object. [Api set: ExcelApi 1.9]
var GeometricShapeType = {
__proto__: null,
"lineInverse": "lineInverse",
"triangle": "triangle",
"rightTriangle": "rightTriangle",
"rectangle": "rectangle",
"diamond": "diamond",
"parallelogram": "parallelogram",
"trapezoid": "trapezoid",
"nonIsoscelesTrapezoid": "nonIsoscelesTrapezoid",
"pentagon": "pentagon",
"hexagon": "hexagon",
"heptagon": "heptagon",
"octagon": "octagon",
"decagon": "decagon",
"dodecagon": "dodecagon",
"star4": "star4",
"star5": "star5",
"star6": "star6",
"star7": "star7",
"star8": "star8",
"star10": "star10",
"star12": "star12",
"star16": "star16",
"star24": "star24",
"star32": "star32",
"roundRectangle": "roundRectangle",
"round1Rectangle": "round1Rectangle",
"round2SameRectangle": "round2SameRectangle",
"round2DiagonalRectangle": "round2DiagonalRectangle",
"snipRoundRectangle": "snipRoundRectangle",
"snip1Rectangle": "snip1Rectangle",
"snip2SameRectangle": "snip2SameRectangle",
"snip2DiagonalRectangle": "snip2DiagonalRectangle",
"plaque": "plaque",
"ellipse": "ellipse",
"teardrop": "teardrop",
"homePlate": "homePlate",
"chevron": "chevron",
"pieWedge": "pieWedge",
"pie": "pie",
"blockArc": "blockArc",
"donut": "donut",
"noSmoking": "noSmoking",
"rightArrow": "rightArrow",
"leftArrow": "leftArrow",
"upArrow": "upArrow",
"downArrow": "downArrow",
"stripedRightArrow": "stripedRightArrow",
"notchedRightArrow": "notchedRightArrow",
"bentUpArrow": "bentUpArrow",
"leftRightArrow": "leftRightArrow",
"upDownArrow": "upDownArrow",
"leftUpArrow": "leftUpArrow",
"leftRightUpArrow": "leftRightUpArrow",
"quadArrow": "quadArrow",
"leftArrowCallout": "leftArrowCallout",
"rightArrowCallout": "rightArrowCallout",
"upArrowCallout": "upArrowCallout",
"downArrowCallout": "downArrowCallout",
"leftRightArrowCallout": "leftRightArrowCallout",
"upDownArrowCallout": "upDownArrowCallout",
"quadArrowCallout": "quadArrowCallout",
"bentArrow": "bentArrow",
"uturnArrow": "uturnArrow",
"circularArrow": "circularArrow",
"leftCircularArrow": "leftCircularArrow",
"leftRightCircularArrow": "leftRightCircularArrow",
"curvedRightArrow": "curvedRightArrow",
"curvedLeftArrow": "curvedLeftArrow",
"curvedUpArrow": "curvedUpArrow",
"curvedDownArrow": "curvedDownArrow",
"swooshArrow": "swooshArrow",
"cube": "cube",
"can": "can",
"lightningBolt": "lightningBolt",
"heart": "heart",
"sun": "sun",
"moon": "moon",
"smileyFace": "smileyFace",
"irregularSeal1": "irregularSeal1",
"irregularSeal2": "irregularSeal2",
"foldedCorner": "foldedCorner",
"bevel": "bevel",
"frame": "frame",
"halfFrame": "halfFrame",
"corner": "corner",
"diagonalStripe": "diagonalStripe",
"chord": "chord",
"arc": "arc",
"leftBracket": "leftBracket",
"rightBracket": "rightBracket",
"leftBrace": "leftBrace",
"rightBrace": "rightBrace",
"bracketPair": "bracketPair",
"bracePair": "bracePair",
"callout1": "callout1",
"callout2": "callout2",
"callout3": "callout3",
"accentCallout1": "accentCallout1",
"accentCallout2": "accentCallout2",
"accentCallout3": "accentCallout3",
"borderCallout1": "borderCallout1",
"borderCallout2": "borderCallout2",
"borderCallout3": "borderCallout3",
"accentBorderCallout1": "accentBorderCallout1",
"accentBorderCallout2": "accentBorderCallout2",
"accentBorderCallout3": "accentBorderCallout3",
"wedgeRectCallout": "wedgeRectCallout",
"wedgeRRectCallout": "wedgeRRectCallout",
"wedgeEllipseCallout": "wedgeEllipseCallout",
"cloudCallout": "cloudCallout",
"cloud": "cloud",
"ribbon": "ribbon",
"ribbon2": "ribbon2",
"ellipseRibbon": "ellipseRibbon",
"ellipseRibbon2": "ellipseRibbon2",
"leftRightRibbon": "leftRightRibbon",
"verticalScroll": "verticalScroll",
"horizontalScroll": "horizontalScroll",
"wave": "wave",
"doubleWave": "doubleWave",
"plus": "plus",
"flowChartProcess": "flowChartProcess",
"flowChartDecision": "flowChartDecision",
"flowChartInputOutput": "flowChartInputOutput",
"flowChartPredefinedProcess": "flowChartPredefinedProcess",
"flowChartInternalStorage": "flowChartInternalStorage",
"flowChartDocument": "flowChartDocument",
"flowChartMultidocument": "flowChartMultidocument",
"flowChartTerminator": "flowChartTerminator",
"flowChartPreparation": "flowChartPreparation",
"flowChartManualInput": "flowChartManualInput",
"flowChartManualOperation": "flowChartManualOperation",
"flowChartConnector": "flowChartConnector",
"flowChartPunchedCard": "flowChartPunchedCard",
"flowChartPunchedTape": "flowChartPunchedTape",
"flowChartSummingJunction": "flowChartSummingJunction",
"flowChartOr": "flowChartOr",
"flowChartCollate": "flowChartCollate",
"flowChartSort": "flowChartSort",
"flowChartExtract": "flowChartExtract",
"flowChartMerge": "flowChartMerge",
"flowChartOfflineStorage": "flowChartOfflineStorage",
"flowChartOnlineStorage": "flowChartOnlineStorage",
"flowChartMagneticTape": "flowChartMagneticTape",
"flowChartMagneticDisk": "flowChartMagneticDisk",
"flowChartMagneticDrum": "flowChartMagneticDrum",
"flowChartDisplay": "flowChartDisplay",
"flowChartDelay": "flowChartDelay",
"flowChartAlternateProcess": "flowChartAlternateProcess",
"flowChartOffpageConnector": "flowChartOffpageConnector",
"actionButtonBlank": "actionButtonBlank",
"actionButtonHome": "actionButtonHome",
"actionButtonHelp": "actionButtonHelp",
"actionButtonInformation": "actionButtonInformation",
"actionButtonForwardNext": "actionButtonForwardNext",
"actionButtonBackPrevious": "actionButtonBackPrevious",
"actionButtonEnd": "actionButtonEnd",
"actionButtonBeginning": "actionButtonBeginning",
"actionButtonReturn": "actionButtonReturn",
"actionButtonDocument": "actionButtonDocument",
"actionButtonSound": "actionButtonSound",
"actionButtonMovie": "actionButtonMovie",
"gear6": "gear6",
"gear9": "gear9",
"funnel": "funnel",
"mathPlus": "mathPlus",
"mathMinus": "mathMinus",
"mathMultiply": "mathMultiply",
"mathDivide": "mathDivide",
"mathEqual": "mathEqual",
"mathNotEqual": "mathNotEqual",
"cornerTabs": "cornerTabs",
"squareTabs": "squareTabs",
"plaqueTabs": "plaqueTabs",
"chartX": "chartX",
"chartStar": "chartStar",
"chartPlus": "chartPlus",
}
Excel.GeometricShapeType = GeometricShapeType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.10]
var GroupOption = {
__proto__: null,
"byRows": "byRows",
"byColumns": "byColumns",
}
Excel.GroupOption = GroupOption;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var GroupShapeCollection = (function(_super) {
__extends(GroupShapeCollection, _super);
function GroupShapeCollection() {
/// Represents the shape collection inside a shape group. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
GroupShapeCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
GroupShapeCollection.prototype.getCount = function() {
///
/// Returns the number of shapes in the shape group. [Api set: ExcelApi 1.9]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
GroupShapeCollection.prototype.getItem = function(key) {
///
/// Gets a shape using its name or ID. [Api set: ExcelApi 1.9]
///
/// The name or ID of the shape to be retrieved.
///
}
GroupShapeCollection.prototype.getItemAt = function(index) {
///
/// Gets a shape based on its position in the collection. [Api set: ExcelApi 1.9]
///
/// The zero-based index value of the object to be retrieved.
///
}
GroupShapeCollection.prototype.getItemOrNullObject = function(key) {
///
/// Gets a shape using its name or ID. If the shape object does not exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.14]
///
/// The Name or ID of the shape to be retrieved.
///
}
return GroupShapeCollection;
})(OfficeExtension.ClientObject);
Excel.GroupShapeCollection = GroupShapeCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var HeaderFooter = (function(_super) {
__extends(HeaderFooter, _super);
function HeaderFooter() {
/// [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// 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. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9]
}
HeaderFooter.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
HeaderFooter.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.HeaderFooterUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing HeaderFooter object, with properties that have already been loaded and synced.
///
}
return HeaderFooter;
})(OfficeExtension.ClientObject);
Excel.HeaderFooter = HeaderFooter;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var HeaderFooterGroup = (function(_super) {
__extends(HeaderFooterGroup, _super);
function HeaderFooterGroup() {
/// [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// The general header/footer, used for all pages unless even/odd or first page is specified. [Api set: ExcelApi 1.9]
/// The header/footer to use for even pages, odd header/footer needs to be specified for odd pages. [Api set: ExcelApi 1.9]
/// The first page header/footer, for all other pages general or even/odd is used. [Api set: ExcelApi 1.9]
/// The header/footer to use for odd pages, even header/footer needs to be specified for even pages. [Api set: ExcelApi 1.9]
/// The state by which headers/footers are set. See `Excel.HeaderFooterState` for details. [Api set: ExcelApi 1.9]
/// Gets or sets a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9]
}
HeaderFooterGroup.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
HeaderFooterGroup.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.HeaderFooterGroupUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing HeaderFooterGroup object, with properties that have already been loaded and synced.
///
}
return HeaderFooterGroup;
})(OfficeExtension.ClientObject);
Excel.HeaderFooterGroup = HeaderFooterGroup;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.9]
var HeaderFooterState = {
__proto__: null,
"default": "default",
"firstAndDefault": "firstAndDefault",
"oddAndEven": "oddAndEven",
"firstOddAndEven": "firstOddAndEven",
}
Excel.HeaderFooterState = HeaderFooterState;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.1]
var HorizontalAlignment = {
__proto__: null,
"general": "general",
"left": "left",
"center": "center",
"right": "right",
"fill": "fill",
"justify": "justify",
"centerAcrossSelection": "centerAcrossSelection",
"distributed": "distributed",
}
Excel.HorizontalAlignment = HorizontalAlignment;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var Icon = (function() {
function Icon() {
/// Represents a cell icon. [Api set: ExcelApi 1.2]
/// Specifies the index of the icon in the given set. [Api set: ExcelApi 1.2]
/// Specifies the set that the icon is part of. [Api set: ExcelApi 1.2]
}
return Icon;
})();
Interfaces.Icon.__proto__ = null;
Interfaces.Icon = Icon;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.2]
var IconSet = {
__proto__: null,
"invalid": "invalid",
"threeArrows": "threeArrows",
"threeArrowsGray": "threeArrowsGray",
"threeFlags": "threeFlags",
"threeTrafficLights1": "threeTrafficLights1",
"threeTrafficLights2": "threeTrafficLights2",
"threeSigns": "threeSigns",
"threeSymbols": "threeSymbols",
"threeSymbols2": "threeSymbols2",
"fourArrows": "fourArrows",
"fourArrowsGray": "fourArrowsGray",
"fourRedToBlack": "fourRedToBlack",
"fourRating": "fourRating",
"fourTrafficLights": "fourTrafficLights",
"fiveArrows": "fiveArrows",
"fiveArrowsGray": "fiveArrowsGray",
"fiveRating": "fiveRating",
"fiveQuarters": "fiveQuarters",
"threeStars": "threeStars",
"threeTriangles": "threeTriangles",
"fiveBoxes": "fiveBoxes",
}
Excel.IconSet = IconSet;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var IconSetConditionalFormat = (function(_super) {
__extends(IconSetConditionalFormat, _super);
function IconSetConditionalFormat() {
/// Represents an icon set criteria for conditional formatting. [Api set: ExcelApi 1.6]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// 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. [Api set: ExcelApi 1.6]
/// If `true`, reverses the icon orders for the icon set. Note that this cannot be set if custom icons are used. [Api set: ExcelApi 1.6]
/// If `true`, hides the values and only shows icons. [Api set: ExcelApi 1.6]
/// If set, displays the icon set option for the conditional format. [Api set: ExcelApi 1.6]
}
IconSetConditionalFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
IconSetConditionalFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.IconSetConditionalFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing IconSetConditionalFormat object, with properties that have already been loaded and synced.
///
}
return IconSetConditionalFormat;
})(OfficeExtension.ClientObject);
Excel.IconSetConditionalFormat = IconSetConditionalFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Image = (function(_super) {
__extends(Image, _super);
function Image() {
/// Represents an image in the worksheet. To get the corresponding `Shape` object, use `Image.shape`. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies the shape identifier for the image object. [Api set: ExcelApi 1.9]
/// Returns the `Shape` object associated with the image. [Api set: ExcelApi 1.9]
/// Returns the format of the image. [Api set: ExcelApi 1.9]
}
Image.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
return Image;
})(OfficeExtension.ClientObject);
Excel.Image = Image;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.2]
var ImageFittingMode = {
__proto__: null,
"fit": "fit",
"fitAndCenter": "fitAndCenter",
"fill": "fill",
}
Excel.ImageFittingMode = ImageFittingMode;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.1]
var InsertShiftDirection = {
__proto__: null,
"down": "down",
"right": "right",
}
Excel.InsertShiftDirection = InsertShiftDirection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var InsertWorksheetOptions = (function() {
function InsertWorksheetOptions() {
/// The options that define which worksheets to insert and where in the workbook the new worksheets will be inserted. [Api set: ExcelApi 1.13]
/// The insert position, in the current workbook, of the new worksheets. See `Excel.WorksheetPositionType` for details. The default position is "End". [Api set: ExcelApi 1.13]
/// The worksheet in the current workbook that is referenced for the `WorksheetPositionType` parameter. The default is `null`. If the `relativeTo` parameter is not set, worksheets will be inserted based on `positionType`, at the start or end of the current workbook. [Api set: ExcelApi 1.13]
/// The names of individual worksheets to insert. By default, all the worksheets from the source workbook are inserted. [Api set: ExcelApi 1.13]
}
return InsertWorksheetOptions;
})();
Interfaces.InsertWorksheetOptions.__proto__ = null;
Interfaces.InsertWorksheetOptions = InsertWorksheetOptions;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var IterativeCalculation = (function(_super) {
__extends(IterativeCalculation, _super);
function IterativeCalculation() {
/// Represents the iterative calculation settings. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// True if Excel will use iteration to resolve circular references. [Api set: ExcelApi 1.9]
/// Specifies the maximum amount of change between each iteration as Excel resolves circular references. [Api set: ExcelApi 1.9]
/// Specifies the maximum number of iterations that Excel can use to resolve a circular reference. [Api set: ExcelApi 1.9]
}
IterativeCalculation.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
IterativeCalculation.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.IterativeCalculationUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing IterativeCalculation object, with properties that have already been loaded and synced.
///
}
return IterativeCalculation;
})(OfficeExtension.ClientObject);
Excel.IterativeCalculation = IterativeCalculation;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.13]
var KeyboardDirection = {
__proto__: null,
"left": "left",
"right": "right",
"up": "up",
"down": "down",
}
Excel.KeyboardDirection = KeyboardDirection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// 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. [Api set: ExcelApi 1.12]
var LabelFilterCondition = {
__proto__: null,
"unknown": "unknown",
"equals": "equals",
"beginsWith": "beginsWith",
"endsWith": "endsWith",
"contains": "contains",
"greaterThan": "greaterThan",
"greaterThanOrEqualTo": "greaterThanOrEqualTo",
"lessThan": "lessThan",
"lessThanOrEqualTo": "lessThanOrEqualTo",
"between": "between",
}
Excel.LabelFilterCondition = LabelFilterCondition;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Line = (function(_super) {
__extends(Line, _super);
function Line() {
/// Represents a line inside a worksheet. To get the corresponding `Shape` object, use `Line.shape`. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the length of the arrowhead at the beginning of the specified line. [Api set: ExcelApi 1.9]
/// Represents the style of the arrowhead at the beginning of the specified line. [Api set: ExcelApi 1.9]
/// Represents the width of the arrowhead at the beginning of the specified line. [Api set: ExcelApi 1.9]
/// Represents the shape to which the beginning of the specified line is attached. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9]
/// Represents the length of the arrowhead at the end of the specified line. [Api set: ExcelApi 1.9]
/// Represents the style of the arrowhead at the end of the specified line. [Api set: ExcelApi 1.9]
/// Represents the width of the arrowhead at the end of the specified line. [Api set: ExcelApi 1.9]
/// Represents the shape to which the end of the specified line is attached. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9]
/// Specifies the shape identifier. [Api set: ExcelApi 1.9]
/// Specifies if the beginning of the specified line is connected to a shape. [Api set: ExcelApi 1.9]
/// Specifies if the end of the specified line is connected to a shape. [Api set: ExcelApi 1.9]
/// Returns the `Shape` object associated with the line. [Api set: ExcelApi 1.9]
/// Represents the connector type for the line. [Api set: ExcelApi 1.9]
}
Line.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Line.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.LineUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing Line object, with properties that have already been loaded and synced.
///
}
Line.prototype.connectBeginShape = function(shape, connectionSite) {
///
/// Attaches the beginning of the specified connector to a specified shape. [Api set: ExcelApi 1.9]
///
/// The shape to connect.
/// 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).
///
}
Line.prototype.connectEndShape = function(shape, connectionSite) {
///
/// Attaches the end of the specified connector to a specified shape. [Api set: ExcelApi 1.9]
///
/// The shape to connect.
/// 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).
///
}
Line.prototype.disconnectBeginShape = function() {
///
/// Detaches the beginning of the specified connector from a shape. [Api set: ExcelApi 1.9]
///
///
}
Line.prototype.disconnectEndShape = function() {
///
/// Detaches the end of the specified connector from a shape. [Api set: ExcelApi 1.9]
///
///
}
return Line;
})(OfficeExtension.ClientObject);
Excel.Line = Line;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.9]
var LinkedDataTypeState = {
__proto__: null,
"none": "none",
"validLinkedData": "validLinkedData",
"disambiguationNeeded": "disambiguationNeeded",
"brokenLinkedData": "brokenLinkedData",
"fetchingData": "fetchingData",
}
Excel.LinkedDataTypeState = LinkedDataTypeState;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var LinkedWorkbook = (function(_super) {
__extends(LinkedWorkbook, _super);
function LinkedWorkbook() {
/// Contains information about a linked workbook. If a workbook has links pointing to data in another workbook, the second workbook is linked to the first workbook. In this scenario, the second workbook is called the "linked workbook". [Api set: ExcelApiOnline 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// The original URL pointing to the linked workbook. It is unique across all linked workbooks in the collection. [Api set: ExcelApiOnline 1.1]
}
LinkedWorkbook.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
LinkedWorkbook.prototype.breakLinks = function() {
///
/// 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`. [Api set: ExcelApiOnline 1.1]
///
///
}
LinkedWorkbook.prototype.refresh = function() {
///
/// Makes a request to refresh the data retrieved from the linked workbook. [Api set: ExcelApiOnline 1.1]
///
///
}
return LinkedWorkbook;
})(OfficeExtension.ClientObject);
Excel.LinkedWorkbook = LinkedWorkbook;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var LinkedWorkbookCollection = (function(_super) {
__extends(LinkedWorkbookCollection, _super);
function LinkedWorkbookCollection() {
/// Represents a collection of linked workbook objects. [Api set: ExcelApiOnline 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the update mode of the workbook links. The mode is same for all of the workbook links present in the workbook. [Api set: ExcelApiOnline 1.1]
/// Gets the loaded child items in this collection.
}
LinkedWorkbookCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
LinkedWorkbookCollection.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.LinkedWorkbookCollectionUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing LinkedWorkbookCollection object, with properties that have already been loaded and synced.
///
}
LinkedWorkbookCollection.prototype.breakAllLinks = function() {
///
/// 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. [Api set: ExcelApiOnline 1.1]
///
///
}
LinkedWorkbookCollection.prototype.getItem = function(key) {
///
/// Gets information about a linked workbook by its URL. [Api set: ExcelApiOnline 1.1]
///
/// The URL of the linked workbook.
/// The linked workbook with the given URL.
}
LinkedWorkbookCollection.prototype.getItemOrNullObject = function(key) {
///
/// Gets information about a linked workbook by its URL. If the workbook does not exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApiOnline 1.1]
///
/// The URL of the linked workbook.
/// The linked workbook with given URL.
}
LinkedWorkbookCollection.prototype.refreshAll = function() {
///
/// Makes a request to refresh all the workbook links. [Api set: ExcelApiOnline 1.1]
///
///
}
return LinkedWorkbookCollection;
})(OfficeExtension.ClientObject);
Excel.LinkedWorkbookCollection = LinkedWorkbookCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ListDataValidation = (function() {
function ListDataValidation() {
/// Represents the List data validation criteria. [Api set: ExcelApi 1.8]
/// Specifies whether to display the list in a cell drop-down. The default is `true`. [Api set: ExcelApi 1.8]
/// 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. [Api set: ExcelApi 1.8]
}
return ListDataValidation;
})();
Interfaces.ListDataValidation.__proto__ = null;
Interfaces.ListDataValidation = ListDataValidation;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// An enum that specifies the query load to destination. [Api set: ExcelApi 1.14]
var LoadToType = {
__proto__: null,
"connectionOnly": "connectionOnly",
"table": "table",
"pivotTable": "pivotTable",
"pivotChart": "pivotChart",
}
Excel.LoadToType = LoadToType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var NamedItem = (function(_super) {
__extends(NamedItem, _super);
function NamedItem() {
/// Represents a defined name for a range of cells or value. Names can be primitive named objects (as seen in the type below), range object, or a reference to a range. This object can be used to obtain range object associated with names. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Returns an object containing values and types of the named item. [Api set: ExcelApi 1.7]
/// Specifies the comment associated with this name. [Api set: ExcelApi 1.4]
/// The formula of the named item. Formulas always start with an equal sign ("="). [Api set: ExcelApi 1.7]
/// The name of the object. [Api set: ExcelApi 1.1]
/// Specifies if the name is scoped to the workbook or to a specific worksheet. Possible values are: Worksheet, Workbook. [Api set: ExcelApi 1.4]
/// Specifies the type of the value returned by the name's formula. See `Excel.NamedItemType` for details. [Api set: ExcelApi 1.1 for String,Integer,Double,Boolean,Range,Error; 1.7 for Array]
/// Represents the value computed by the name's formula. For a named range, will return the range address. [Api set: ExcelApi 1.1]
/// Specifies if the object is visible. [Api set: ExcelApi 1.1]
/// Returns the worksheet on which the named item is scoped to. Throws an error if the item is scoped to the workbook instead. [Api set: ExcelApi 1.4]
/// Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.4]
}
NamedItem.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
NamedItem.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.NamedItemUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing NamedItem object, with properties that have already been loaded and synced.
///
}
NamedItem.prototype.delete = function() {
///
/// Deletes the given name. [Api set: ExcelApi 1.4]
///
///
}
NamedItem.prototype.getRange = function() {
///
/// Returns the range object that is associated with the name. Throws an error if the named item's type is not a range. [Api set: ExcelApi 1.1]
///
///
}
NamedItem.prototype.getRangeOrNullObject = function() {
///
/// Returns the range object that is associated with the name. If the named item's type is not a range, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.4]
///
///
}
return NamedItem;
})(OfficeExtension.ClientObject);
Excel.NamedItem = NamedItem;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var NamedItemArrayValues = (function(_super) {
__extends(NamedItemArrayValues, _super);
function NamedItemArrayValues() {
/// Represents an object containing values and types of a named item. [Api set: ExcelApi 1.7]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the types for each item in the named item array [Api set: ExcelApi 1.7]
/// Represents the values of each item in the named item array. [Api set: ExcelApi 1.7]
}
NamedItemArrayValues.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
return NamedItemArrayValues;
})(OfficeExtension.ClientObject);
Excel.NamedItemArrayValues = NamedItemArrayValues;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var NamedItemCollection = (function(_super) {
__extends(NamedItemCollection, _super);
function NamedItemCollection() {
/// A collection of all the `NamedItem` objects that are part of the workbook or worksheet, depending on how it was reached. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
NamedItemCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
NamedItemCollection.prototype.add = function(name, reference, comment) {
///
/// Adds a new name to the collection of the given scope. [Api set: ExcelApi 1.4]
///
/// The name of the named item.
/// The formula or the range that the name will refer to.
/// Optional. The comment associated with the named item.
///
}
NamedItemCollection.prototype.addFormulaLocal = function(name, formula, comment) {
///
/// Adds a new name to the collection of the given scope using the user's locale for the formula. [Api set: ExcelApi 1.4]
///
/// The name of the named item.
/// The formula in the user's locale that the name will refer to.
/// Optional. The comment associated with the named item.
///
}
NamedItemCollection.prototype.getCount = function() {
///
/// Gets the number of named items in the collection. [Api set: ExcelApi 1.4]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
NamedItemCollection.prototype.getItem = function(name) {
///
/// Gets a `NamedItem` object using its name. [Api set: ExcelApi 1.1]
///
/// Nameditem name.
///
}
NamedItemCollection.prototype.getItemOrNullObject = function(name) {
///
/// Gets a `NamedItem` object using its name. If the object does not exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.4]
///
/// Nameditem name.
///
}
return NamedItemCollection;
})(OfficeExtension.ClientObject);
Excel.NamedItemCollection = NamedItemCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.4]
var NamedItemScope = {
__proto__: null,
"worksheet": "worksheet",
"workbook": "workbook",
}
Excel.NamedItemScope = NamedItemScope;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.1 for String,Integer,Double,Boolean,Range,Error; 1.7 for Array]
var NamedItemType = {
__proto__: null,
"string": "string",
"integer": "integer",
"double": "double",
"boolean": "boolean",
"range": "range",
"error": "error",
"array": "array",
}
Excel.NamedItemType = NamedItemType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var NamedSheetView = (function(_super) {
__extends(NamedSheetView, _super);
function NamedSheetView() {
/// Represents a named sheet view of a worksheet. A sheet view stores the sort and filter rules for a particular worksheet. Every sheet view (even a temporary sheet view) has a unique, worksheet-scoped name that is used to access the view. [Api set: ExcelApiOnline 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// 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. [Api set: ExcelApiOnline 1.1]
}
NamedSheetView.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
NamedSheetView.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.NamedSheetViewUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing NamedSheetView object, with properties that have already been loaded and synced.
///
}
NamedSheetView.prototype.activate = function() {
///
/// Activates this sheet view. This is equivalent to using "Switch To" in the Excel UI. [Api set: ExcelApiOnline 1.1]
///
///
}
NamedSheetView.prototype.delete = function() {
///
/// Removes the sheet view from the worksheet. [Api set: ExcelApiOnline 1.1]
///
///
}
NamedSheetView.prototype.duplicate = function(name) {
///
/// Creates a copy of this sheet view. [Api set: ExcelApiOnline 1.1]
///
/// The name of the duplicated sheet view. If no name is provided, one will be generated.
/// The new, duplicated sheet view.
}
return NamedSheetView;
})(OfficeExtension.ClientObject);
Excel.NamedSheetView = NamedSheetView;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var NamedSheetViewCollection = (function(_super) {
__extends(NamedSheetViewCollection, _super);
function NamedSheetViewCollection() {
/// Represents the collection of sheet views in the worksheet. [Api set: ExcelApiOnline 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
NamedSheetViewCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
NamedSheetViewCollection.prototype.add = function(name) {
///
/// Creates a new sheet view with the given name. [Api set: ExcelApiOnline 1.1]
///
/// 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.
/// The newly created sheet view object.
}
NamedSheetViewCollection.prototype.enterTemporary = function() {
///
/// 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 acccessed with the empty string (""), if the temporary view exists. [Api set: ExcelApiOnline 1.1]
///
/// The newly created sheet view object.
}
NamedSheetViewCollection.prototype.exit = function() {
///
/// Exits the currently active sheet view. [Api set: ExcelApiOnline 1.1]
///
///
}
NamedSheetViewCollection.prototype.getActive = function() {
///
/// Gets the worksheet's currently active sheet view. [Api set: ExcelApiOnline 1.1]
///
/// The currently active sheet view for this worksheet.
}
NamedSheetViewCollection.prototype.getCount = function() {
///
/// Gets the number of sheet views in this worksheet. Includes the temporary sheet view if it exists. [Api set: ExcelApiOnline 1.1]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
NamedSheetViewCollection.prototype.getItem = function(key) {
///
/// Gets a sheet view using its name. [Api set: ExcelApiOnline 1.1]
///
/// The case-sensitive name of the sheet view. Use the empty string ("") to get the temporary sheet view, if the temporary view exists.
/// The sheet view with the given name, or the temporary view if an empty string was provided. If there is no current temporary view and an empty string was provided, then an `ItemNotFound` error is thrown.
}
NamedSheetViewCollection.prototype.getItemAt = function(index) {
///
/// Gets a sheet view by its index in the collection. [Api set: ExcelApiOnline 1.1]
///
/// The index of the sheet view object in the collection.
/// The sheet view at the given index.
}
return NamedSheetViewCollection;
})(OfficeExtension.ClientObject);
Excel.NamedSheetViewCollection = NamedSheetViewCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents a category of number formats. [Api set: ExcelApi 1.12]
var NumberFormatCategory = {
__proto__: null,
"general": "general",
"number": "number",
"currency": "currency",
"accounting": "accounting",
"date": "date",
"time": "time",
"percentage": "percentage",
"fraction": "fraction",
"scientific": "scientific",
"text": "text",
"special": "special",
"custom": "custom",
}
Excel.NumberFormatCategory = NumberFormatCategory;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var NumberFormatInfo = (function(_super) {
__extends(NumberFormatInfo, _super);
function NumberFormatInfo() {
/// Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings. [Api set: ExcelApi 1.11]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the string used as the decimal separator for numeric values. This is based on current system settings. [Api set: ExcelApi 1.11]
/// 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. [Api set: ExcelApi 1.11]
}
NumberFormatInfo.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
return NumberFormatInfo;
})(OfficeExtension.ClientObject);
Excel.NumberFormatInfo = NumberFormatInfo;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var PageBreak = (function(_super) {
__extends(PageBreak, _super);
function PageBreak() {
/// [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies the column index for the page break. [Api set: ExcelApi 1.9]
/// Specifies the row index for the page break. [Api set: ExcelApi 1.9]
}
PageBreak.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
PageBreak.prototype.delete = function() {
///
/// Deletes a page break object. [Api set: ExcelApi 1.9]
///
///
}
PageBreak.prototype.getCellAfterBreak = function() {
///
/// Gets the first cell after the page break. [Api set: ExcelApi 1.9]
///
///
}
return PageBreak;
})(OfficeExtension.ClientObject);
Excel.PageBreak = PageBreak;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var PageBreakCollection = (function(_super) {
__extends(PageBreakCollection, _super);
function PageBreakCollection() {
/// [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
PageBreakCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
PageBreakCollection.prototype.add = function(pageBreakRange) {
///
/// Adds a page break before the top-left cell of the range specified. [Api set: ExcelApi 1.9]
///
/// The range immediately after the page break to be added.
///
}
PageBreakCollection.prototype.getCount = function() {
///
/// Gets the number of page breaks in the collection. [Api set: ExcelApi 1.9]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
PageBreakCollection.prototype.getItem = function(index) {
///
/// Gets a page break object via the index. [Api set: ExcelApi 1.9]
///
/// Index of the page break.
///
}
PageBreakCollection.prototype.removePageBreaks = function() {
///
/// Resets all manual page breaks in the collection. [Api set: ExcelApi 1.9]
///
///
}
return PageBreakCollection;
})(OfficeExtension.ClientObject);
Excel.PageBreakCollection = PageBreakCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var PageLayout = (function(_super) {
__extends(PageLayout, _super);
function PageLayout() {
/// Represents layout and print settings that are not dependent on any printer-specific implementation. These settings include margins, orientation, page numbering, title rows, and print area. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// The worksheet's black and white print option. [Api set: ExcelApi 1.9]
/// The worksheet's bottom page margin to use for printing in points. [Api set: ExcelApi 1.9]
/// The worksheet's center horizontally flag. This flag determines whether the worksheet will be centered horizontally when it's printed. [Api set: ExcelApi 1.9]
/// The worksheet's center vertically flag. This flag determines whether the worksheet will be centered vertically when it's printed. [Api set: ExcelApi 1.9]
/// The worksheet's draft mode option. If `true`, the sheet will be printed without graphics. [Api set: ExcelApi 1.9]
/// The worksheet's first page number to print. A `null` value represents "auto" page numbering. [Api set: ExcelApi 1.9]
/// The worksheet's footer margin, in points, for use when printing. [Api set: ExcelApi 1.9]
/// The worksheet's header margin, in points, for use when printing. [Api set: ExcelApi 1.9]
/// Header and footer configuration for the worksheet. [Api set: ExcelApi 1.9]
/// The worksheet's left margin, in points, for use when printing. [Api set: ExcelApi 1.9]
/// The worksheet's orientation of the page. [Api set: ExcelApi 1.9]
/// The worksheet's paper size of the page. [Api set: ExcelApi 1.9]
/// Specifies if the worksheet's comments should be displayed when printing. [Api set: ExcelApi 1.9]
/// The worksheet's print errors option. [Api set: ExcelApi 1.9]
/// Specifies if the worksheet's gridlines will be printed. [Api set: ExcelApi 1.9]
/// Specifies if the worksheet's headings will be printed. [Api set: ExcelApi 1.9]
/// The worksheet's page print order option. This specifies the order to use for processing the page number printed. [Api set: ExcelApi 1.9]
/// The worksheet's right margin, in points, for use when printing. [Api set: ExcelApi 1.9]
/// The worksheet's top margin, in points, for use when printing. [Api set: ExcelApi 1.9]
/// The worksheet's print zoom options. The `PageLayoutZoomOptions` object must be set as a JSON object (use `x.zoom = {...}` instead of `x.zoom.scale = ...`). [Api set: ExcelApi 1.9]
}
PageLayout.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
PageLayout.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.PageLayoutUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing PageLayout object, with properties that have already been loaded and synced.
///
}
PageLayout.prototype.getPrintArea = function() {
///
/// Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents the print area for the worksheet. If there is no print area, an `ItemNotFound` error will be thrown. [Api set: ExcelApi 1.9]
///
///
}
PageLayout.prototype.getPrintAreaOrNullObject = function() {
///
/// 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 function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.9]
///
///
}
PageLayout.prototype.getPrintTitleColumns = function() {
///
/// Gets the range object representing the title columns. [Api set: ExcelApi 1.9]
///
///
}
PageLayout.prototype.getPrintTitleColumnsOrNullObject = function() {
///
/// Gets the range object representing the title columns. If not set, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.9]
///
///
}
PageLayout.prototype.getPrintTitleRows = function() {
///
/// Gets the range object representing the title rows. [Api set: ExcelApi 1.9]
///
///
}
PageLayout.prototype.getPrintTitleRowsOrNullObject = function() {
///
/// Gets the range object representing the title rows. If not set, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.9]
///
///
}
PageLayout.prototype.setPrintArea = function(printArea) {
///
/// Sets the worksheet's print area. [Api set: ExcelApi 1.9]
///
/// The range or ranges of the content to print.
///
}
PageLayout.prototype.setPrintMargins = function(unit, marginOptions) {
///
/// Sets the worksheet's page margins with units. [Api set: ExcelApi 1.9]
///
/// Measurement unit for the margins provided.
/// Margin values to set. Margins not provided remain unchanged.
///
}
PageLayout.prototype.setPrintTitleColumns = function(printTitleColumns) {
///
/// Sets the columns that contain the cells to be repeated at the left of each page of the worksheet for printing. [Api set: ExcelApi 1.9]
///
/// The columns to be repeated to the left of each page. The range must span the entire column to be valid.
///
}
PageLayout.prototype.setPrintTitleRows = function(printTitleRows) {
///
/// Sets the rows that contain the cells to be repeated at the top of each page of the worksheet for printing. [Api set: ExcelApi 1.9]
///
/// The rows to be repeated at the top of each page. The range must span the entire row to be valid.
///
}
return PageLayout;
})(OfficeExtension.ClientObject);
Excel.PageLayout = PageLayout;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var PageLayoutMarginOptions = (function() {
function PageLayoutMarginOptions() {
/// Represents the options in page layout margins. [Api set: ExcelApi 1.9]
/// Specifies the page layout bottom margin in the unit specified to use for printing. [Api set: ExcelApi 1.9]
/// Specifies the page layout footer margin in the unit specified to use for printing. [Api set: ExcelApi 1.9]
/// Specifies the page layout header margin in the unit specified to use for printing. [Api set: ExcelApi 1.9]
/// Specifies the page layout left margin in the unit specified to use for printing. [Api set: ExcelApi 1.9]
/// Specifies the page layout right margin in the unit specified to use for printing. [Api set: ExcelApi 1.9]
/// Specifies the page layout top margin in the unit specified to use for printing. [Api set: ExcelApi 1.9]
}
return PageLayoutMarginOptions;
})();
Interfaces.PageLayoutMarginOptions.__proto__ = null;
Interfaces.PageLayoutMarginOptions = PageLayoutMarginOptions;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var PageLayoutZoomOptions = (function() {
function PageLayoutZoomOptions() {
/// Represents page zoom properties. [Api set: ExcelApi 1.9]
/// Number of pages to fit horizontally. This value can be `null` if percentage scale is used. [Api set: ExcelApi 1.9]
/// Print page scale value can be between 10 and 400. This value can be `null` if fit to page tall or wide is specified. [Api set: ExcelApi 1.9]
/// Number of pages to fit vertically. This value can be `null` if percentage scale is used. [Api set: ExcelApi 1.9]
}
return PageLayoutZoomOptions;
})();
Interfaces.PageLayoutZoomOptions.__proto__ = null;
Interfaces.PageLayoutZoomOptions = PageLayoutZoomOptions;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.7]
var PageOrientation = {
__proto__: null,
"portrait": "portrait",
"landscape": "landscape",
}
Excel.PageOrientation = PageOrientation;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.9]
var PaperType = {
__proto__: null,
"letter": "letter",
"letterSmall": "letterSmall",
"tabloid": "tabloid",
"ledger": "ledger",
"legal": "legal",
"statement": "statement",
"executive": "executive",
"a3": "a3",
"a4": "a4",
"a4Small": "a4Small",
"a5": "a5",
"b4": "b4",
"b5": "b5",
"folio": "folio",
"quatro": "quatro",
"paper10x14": "paper10x14",
"paper11x17": "paper11x17",
"note": "note",
"envelope9": "envelope9",
"envelope10": "envelope10",
"envelope11": "envelope11",
"envelope12": "envelope12",
"envelope14": "envelope14",
"csheet": "csheet",
"dsheet": "dsheet",
"esheet": "esheet",
"envelopeDL": "envelopeDL",
"envelopeC5": "envelopeC5",
"envelopeC3": "envelopeC3",
"envelopeC4": "envelopeC4",
"envelopeC6": "envelopeC6",
"envelopeC65": "envelopeC65",
"envelopeB4": "envelopeB4",
"envelopeB5": "envelopeB5",
"envelopeB6": "envelopeB6",
"envelopeItaly": "envelopeItaly",
"envelopeMonarch": "envelopeMonarch",
"envelopePersonal": "envelopePersonal",
"fanfoldUS": "fanfoldUS",
"fanfoldStdGerman": "fanfoldStdGerman",
"fanfoldLegalGerman": "fanfoldLegalGerman",
}
Excel.PaperType = PaperType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// The format of the image. [Api set: ExcelApi 1.9]
var PictureFormat = {
__proto__: null,
"unknown": "unknown",
"bmp": "bmp",
"jpeg": "jpeg",
"gif": "gif",
"png": "png",
"svg": "svg",
}
Excel.PictureFormat = PictureFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the axis from which to get the PivotItems. [Api set: ExcelApi 1.9]
var PivotAxis = {
__proto__: null,
"unknown": "unknown",
"row": "row",
"column": "column",
"data": "data",
"filter": "filter",
}
Excel.PivotAxis = PivotAxis;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var PivotDateFilter = (function() {
function PivotDateFilter() {
/// Configurable template for a date filter to apply to a PivotField. The `condition` defines what criteria need to be set in order for the filter to operate. [Api set: ExcelApi 1.12]
/// The comparator is the static value to which other values are compared. The type of comparison is defined by the condition. [Api set: ExcelApi 1.12]
/// Specifies the condition for the filter, which defines the necessary filtering criteria. [Api set: ExcelApi 1.12]
/// If `true`, filter *excludes* items that meet criteria. The default is `false` (filter to include items that meet criteria). [Api set: ExcelApi 1.12]
/// The lower-bound of the range for the `between` filter condition. [Api set: ExcelApi 1.12]
/// The upper-bound of the range for the `between` filter condition. [Api set: ExcelApi 1.12]
/// For `equals`, `before`, `after`, and `between` filter conditions, indicates if comparisons should be made as whole days. [Api set: ExcelApi 1.12]
}
return PivotDateFilter;
})();
Interfaces.PivotDateFilter.__proto__ = null;
Interfaces.PivotDateFilter = PivotDateFilter;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var PivotField = (function(_super) {
__extends(PivotField, _super);
function PivotField() {
/// Represents the Excel PivotField. [Api set: ExcelApi 1.8]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// ID of the PivotField. [Api set: ExcelApi 1.8]
/// Returns the PivotFields associated with the PivotField. [Api set: ExcelApi 1.8]
/// Name of the PivotField. [Api set: ExcelApi 1.8]
/// Determines whether to show all items of the PivotField. [Api set: ExcelApi 1.8]
/// Subtotals of the PivotField. [Api set: ExcelApi 1.8]
}
PivotField.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
PivotField.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.PivotFieldUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing PivotField object, with properties that have already been loaded and synced.
///
}
PivotField.prototype.applyFilter = function(filter) {
///
/// 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. [Api set: ExcelApi 1.12]
///
/// A configured specific PivotFilter, or a PivotFilters interface containing multiple configured filters.
///
}
PivotField.prototype.clearAllFilters = function() {
///
/// Clears all criteria from all of the field's filters. This removes any active filtering on the field. [Api set: ExcelApi 1.12]
///
///
}
PivotField.prototype.clearFilter = function(filterType) {
///
/// Clears all existing criteria from the field's filter of the given type (if one is currently applied). [Api set: ExcelApi 1.12]
///
/// The type of filter on the field of which to clear all criteria.
///
}
PivotField.prototype.getFilters = function() {
///
/// Gets all filters currently applied on the field. [Api set: ExcelApi 1.12]
///
/// A PivotFilters interface with all active filters.
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = {};
return result;
}
PivotField.prototype.isFiltered = function(filterType) {
///
/// Checks if there are any applied filters on the field. [Api set: ExcelApi 1.12]
///
/// The filter type to check. If no type is provided, this method will check if any filter is applied.
/// True if the field has a filter of type `filterType` applied. If `filterType` is not specified, `true` is returned if the field has any applied filters.
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = false;
return result;
}
PivotField.prototype.sortByLabels = function(sortBy) {
///
/// 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. [Api set: ExcelApi 1.8]
///
/// Specifies if the sorting is done in ascending or descending order.
///
}
PivotField.prototype.sortByValues = function(sortBy, valuesHierarchy, pivotItemScope) {
///
/// 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. [Api set: ExcelApi 1.9]
///
/// Specifies if the sorting is done in ascending or descending order.
/// Specifies the values hierarchy on the data axis to be used for sorting.
/// 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.
///
}
return PivotField;
})(OfficeExtension.ClientObject);
Excel.PivotField = PivotField;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var PivotFieldCollection = (function(_super) {
__extends(PivotFieldCollection, _super);
function PivotFieldCollection() {
/// Represents a collection of all the PivotFields that are part of a PivotTable's hierarchy. [Api set: ExcelApi 1.8]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
PivotFieldCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
PivotFieldCollection.prototype.getCount = function() {
///
/// Gets the number of pivot fields in the collection. [Api set: ExcelApi 1.8]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
PivotFieldCollection.prototype.getItem = function(name) {
///
/// Gets a PivotField by its name or ID. [Api set: ExcelApi 1.8]
///
/// Name of the PivotField to be retrieved.
///
}
PivotFieldCollection.prototype.getItemOrNullObject = function(name) {
///
/// Gets a PivotField by name. If the PivotField does not exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.8]
///
/// Name of the PivotField to be retrieved.
///
}
return PivotFieldCollection;
})(OfficeExtension.ClientObject);
Excel.PivotFieldCollection = PivotFieldCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var PivotFilters = (function() {
function PivotFilters() {
/// An interface representing all PivotFilters currently applied to a given PivotField. [Api set: ExcelApi 1.12]
/// The PivotField's currently applied date filter. This property is `null` if no value filter is applied. [Api set: ExcelApi 1.12]
/// The PivotField's currently applied label filter. This property is `null` if no value filter is applied. [Api set: ExcelApi 1.12]
/// The PivotField's currently applied manual filter. This property is `null` if no value filter is applied. [Api set: ExcelApi 1.12]
/// The PivotField's currently applied value filter. This property is `null` if no value filter is applied. [Api set: ExcelApi 1.12]
}
return PivotFilters;
})();
Interfaces.PivotFilters.__proto__ = null;
Interfaces.PivotFilters = PivotFilters;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the criteria for the top/bottom values filter. [Api set: ExcelApi 1.9]
var PivotFilterTopBottomCriterion = {
__proto__: null,
"invalid": "invalid",
"topItems": "topItems",
"topPercent": "topPercent",
"topSum": "topSum",
"bottomItems": "bottomItems",
"bottomPercent": "bottomPercent",
"bottomSum": "bottomSum",
}
Excel.PivotFilterTopBottomCriterion = PivotFilterTopBottomCriterion;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// A simple enum that represents a type of filter for a PivotField. [Api set: ExcelApi 1.12]
var PivotFilterType = {
__proto__: null,
"unknown": "unknown",
"value": "value",
"manual": "manual",
"label": "label",
"date": "date",
}
Excel.PivotFilterType = PivotFilterType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var PivotHierarchy = (function(_super) {
__extends(PivotHierarchy, _super);
function PivotHierarchy() {
/// Represents the Excel PivotHierarchy. [Api set: ExcelApi 1.8]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Returns the PivotFields associated with the PivotHierarchy. [Api set: ExcelApi 1.8]
/// ID of the PivotHierarchy. [Api set: ExcelApi 1.8]
/// Name of the PivotHierarchy. [Api set: ExcelApi 1.8]
}
PivotHierarchy.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
PivotHierarchy.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.PivotHierarchyUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing PivotHierarchy object, with properties that have already been loaded and synced.
///
}
return PivotHierarchy;
})(OfficeExtension.ClientObject);
Excel.PivotHierarchy = PivotHierarchy;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var PivotHierarchyCollection = (function(_super) {
__extends(PivotHierarchyCollection, _super);
function PivotHierarchyCollection() {
/// Represents a collection of all the PivotHierarchies that are part of the PivotTable. [Api set: ExcelApi 1.8]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
PivotHierarchyCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
PivotHierarchyCollection.prototype.getCount = function() {
///
/// Gets the number of pivot hierarchies in the collection. [Api set: ExcelApi 1.8]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
PivotHierarchyCollection.prototype.getItem = function(name) {
///
/// Gets a PivotHierarchy by its name or ID. [Api set: ExcelApi 1.8]
///
/// Name of the PivotHierarchy to be retrieved.
///
}
PivotHierarchyCollection.prototype.getItemOrNullObject = function(name) {
///
/// Gets a PivotHierarchy by name. If the PivotHierarchy does not exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.8]
///
/// Name of the PivotHierarchy to be retrieved.
///
}
return PivotHierarchyCollection;
})(OfficeExtension.ClientObject);
Excel.PivotHierarchyCollection = PivotHierarchyCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var PivotItem = (function(_super) {
__extends(PivotItem, _super);
function PivotItem() {
/// Represents the Excel PivotItem. [Api set: ExcelApi 1.8]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// ID of the PivotItem. [Api set: ExcelApi 1.8]
/// Determines whether the item is expanded to show child items or if it's collapsed and child items are hidden. [Api set: ExcelApi 1.8]
/// Name of the PivotItem. [Api set: ExcelApi 1.8]
/// Specifies if the PivotItem is visible. [Api set: ExcelApi 1.8]
}
PivotItem.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
PivotItem.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.PivotItemUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing PivotItem object, with properties that have already been loaded and synced.
///
}
return PivotItem;
})(OfficeExtension.ClientObject);
Excel.PivotItem = PivotItem;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var PivotItemCollection = (function(_super) {
__extends(PivotItemCollection, _super);
function PivotItemCollection() {
/// Represents a collection of all the PivotItems related to their parent PivotField. [Api set: ExcelApi 1.8]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
PivotItemCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
PivotItemCollection.prototype.getCount = function() {
///
/// Gets the number of PivotItems in the collection. [Api set: ExcelApi 1.8]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
PivotItemCollection.prototype.getItem = function(name) {
///
/// Gets a PivotItem by its name or ID. [Api set: ExcelApi 1.8]
///
/// Name of the PivotItem to be retrieved.
///
}
PivotItemCollection.prototype.getItemOrNullObject = function(name) {
///
/// Gets a PivotItem by name. If the PivotItem does not exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.8]
///
/// Name of the PivotItem to be retrieved.
///
}
return PivotItemCollection;
})(OfficeExtension.ClientObject);
Excel.PivotItemCollection = PivotItemCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var PivotLabelFilter = (function() {
function PivotLabelFilter() {
/// Configurable template for a label filter to apply to a PivotField. The `condition` defines what criteria need to be set in order for the filter to operate. [Api set: ExcelApi 1.12]
/// 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. [Api set: ExcelApi 1.12]
/// Specifies the condition for the filter, which defines the necessary filtering criteria. [Api set: ExcelApi 1.12]
/// If `true`, filter *excludes* items that meet criteria. The default is `false` (filter to include items that meet criteria). [Api set: ExcelApi 1.12]
/// 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. [Api set: ExcelApi 1.12]
/// The substring used for `beginsWith`, `endsWith`, and `contains` filter conditions. [Api set: ExcelApi 1.12]
/// 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. [Api set: ExcelApi 1.12]
}
return PivotLabelFilter;
})();
Interfaces.PivotLabelFilter.__proto__ = null;
Interfaces.PivotLabelFilter = PivotLabelFilter;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var PivotLayout = (function(_super) {
__extends(PivotLayout, _super);
function PivotLayout() {
/// Represents the visual layout of the PivotTable. [Api set: ExcelApi 1.8]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// 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. [Api set: ExcelApi 1.13]
/// 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. [Api set: ExcelApi 1.13]
/// Specifies if formatting will be automatically formatted when it’s refreshed or when fields are moved. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.13]
/// Specifies if the field list can be shown in the UI. [Api set: ExcelApi 1.10]
/// 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`. [Api set: ExcelApi 1.13]
/// This property indicates the PivotLayoutType of all fields on the PivotTable. If fields have different states, this will be null. [Api set: ExcelApi 1.8]
/// Specifies if formatting is preserved when the report is refreshed or recalculated by operations such as pivoting, sorting, or changing page field items. [Api set: ExcelApi 1.9]
/// Specifies if the PivotTable report shows grand totals for columns. [Api set: ExcelApi 1.8]
/// Specifies whether the PivotTable displays field headers (field captions and filter drop-downs). [Api set: ExcelApi 1.13]
/// Specifies if the PivotTable report shows grand totals for rows. [Api set: ExcelApi 1.8]
/// This property indicates the `SubtotalLocationType` of all fields on the PivotTable. If fields have different states, this will be `null`. [Api set: ExcelApi 1.8]
}
PivotLayout.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
PivotLayout.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.PivotLayoutUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing PivotLayout object, with properties that have already been loaded and synced.
///
}
PivotLayout.prototype.displayBlankLineAfterEachItem = function(display) {
///
/// 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. [Api set: ExcelApi 1.13]
///
/// True turns on the blank-line display setting. False turns it off.
///
}
PivotLayout.prototype.getColumnLabelRange = function() {
///
/// Returns the range where the PivotTable's column labels reside. [Api set: ExcelApi 1.8]
///
///
}
PivotLayout.prototype.getDataBodyRange = function() {
///
/// Returns the range where the PivotTable's data values reside. [Api set: ExcelApi 1.8]
///
///
}
PivotLayout.prototype.getDataHierarchy = function(cell) {
///
/// Gets the DataHierarchy that is used to calculate the value in a specified range within the PivotTable. [Api set: ExcelApi 1.9]
///
/// A single cell within the PivotTable data body.
/// The DataPivotHierarchy object used to calculate the value in the specified cell.
}
PivotLayout.prototype.getFilterAxisRange = function() {
///
/// Returns the range of the PivotTable's filter area. [Api set: ExcelApi 1.8]
///
///
}
PivotLayout.prototype.getPivotItems = function(axis, cell) {
///
/// Gets the PivotItems from an axis that make up the value in a specified range within the PivotTable. [Api set: ExcelApi 1.9]
///
/// The axis from which to get the PivotItems. Must be either "row" or "column."
/// A single cell within the PivotTable's data body.
/// A PivotItemCollection of the PivotItems that are used to calculate the values in the specified row.
}
PivotLayout.prototype.getRange = function() {
///
/// Returns the range the PivotTable exists on, excluding the filter area. [Api set: ExcelApi 1.8]
///
///
}
PivotLayout.prototype.getRowLabelRange = function() {
///
/// Returns the range where the PivotTable's row labels reside. [Api set: ExcelApi 1.8]
///
///
}
PivotLayout.prototype.repeatAllItemLabels = function(repeatLabels) {
///
/// Sets the "repeat all item labels" setting across all fields in the PivotTable. [Api set: ExcelApi 1.13]
///
/// True turns on the label-repetition display setting. False turns it off.
///
}
PivotLayout.prototype.setAutoSortOnCell = function(cell, sortBy) {
///
/// 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. [Api set: ExcelApi 1.9]
///
/// A single cell to use get the criteria from for applying the autosort.
/// The direction of the sort.
///
}
return PivotLayout;
})(OfficeExtension.ClientObject);
Excel.PivotLayout = PivotLayout;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.8]
var PivotLayoutType = {
__proto__: null,
"compact": "compact",
"tabular": "tabular",
"outline": "outline",
}
Excel.PivotLayoutType = PivotLayoutType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var PivotManualFilter = (function() {
function PivotManualFilter() {
/// Configurable template for a manual filter to apply to a PivotField. The `condition` defines what criteria need to be set in order for the filter to operate. [Api set: ExcelApi 1.12]
/// A list of selected items to manually filter. These must be existing and valid items from the chosen field. [Api set: ExcelApi 1.12]
}
return PivotManualFilter;
})();
Interfaces.PivotManualFilter.__proto__ = null;
Interfaces.PivotManualFilter = PivotManualFilter;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var PivotTable = (function(_super) {
__extends(PivotTable, _super);
function PivotTable() {
/// Represents an Excel PivotTable. To learn more about the PivotTable object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-pivottables | Work with PivotTables using the Excel JavaScript API}. [Api set: ExcelApi 1.3]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies if the PivotTable allows the application of multiple PivotFilters on a given PivotField in the table. [Api set: ExcelApi 1.12]
/// The Column Pivot Hierarchies of the PivotTable. [Api set: ExcelApi 1.8]
/// The Data Pivot Hierarchies of the PivotTable. [Api set: ExcelApi 1.8]
/// Specifies if the PivotTable allows values in the data body to be edited by the user. [Api set: ExcelApi 1.9]
/// The Filter Pivot Hierarchies of the PivotTable. [Api set: ExcelApi 1.8]
/// The Pivot Hierarchies of the PivotTable. [Api set: ExcelApi 1.8]
/// ID of the PivotTable. [Api set: ExcelApi 1.5]
/// The PivotLayout describing the layout and visual structure of the PivotTable. [Api set: ExcelApi 1.8]
/// Name of the PivotTable. [Api set: ExcelApi 1.3]
/// Specifies whether the PivotTable refreshes when the workbook opens. Corresponds to "Refresh on load" setting in the UI. [Api set: ExcelApi 1.13]
/// The Row Pivot Hierarchies of the PivotTable. [Api set: ExcelApi 1.8]
/// Specifies if the PivotTable uses custom lists when sorting. [Api set: ExcelApi 1.9]
/// The worksheet containing the current PivotTable. [Api set: ExcelApi 1.3]
}
PivotTable.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
PivotTable.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.PivotTableUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing PivotTable object, with properties that have already been loaded and synced.
///
}
PivotTable.prototype.delete = function() {
///
/// Deletes the PivotTable. [Api set: ExcelApi 1.8]
///
///
}
PivotTable.prototype.refresh = function() {
///
/// Refreshes the PivotTable. [Api set: ExcelApi 1.3]
///
///
}
return PivotTable;
})(OfficeExtension.ClientObject);
Excel.PivotTable = PivotTable;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var PivotTableCollection = (function(_super) {
__extends(PivotTableCollection, _super);
function PivotTableCollection() {
/// Represents a collection of all the PivotTables that are part of the workbook or worksheet. [Api set: ExcelApi 1.3]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
PivotTableCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
PivotTableCollection.prototype.add = function(name, source, destination) {
///
/// Add a PivotTable based on the specified source data and insert it at the top-left cell of the destination range. [Api set: ExcelApi 1.8]
///
/// The name of the new PivotTable.
/// The source data for the new PivotTable, this can either be a range (or string address including the worksheet name) or a table.
/// 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).
/// Returns the newly inserted PivotTable.
}
PivotTableCollection.prototype.getCount = function() {
///
/// Gets the number of pivot tables in the collection. [Api set: ExcelApi 1.4]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
PivotTableCollection.prototype.getItem = function(name) {
///
/// Gets a PivotTable by name. [Api set: ExcelApi 1.3]
///
/// Name of the PivotTable to be retrieved.
///
}
PivotTableCollection.prototype.getItemOrNullObject = function(name) {
///
/// Gets a PivotTable by name. If the PivotTable does not exist, then this function returns an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.4]
///
/// Name of the PivotTable to be retrieved.
///
}
PivotTableCollection.prototype.refreshAll = function() {
///
/// Refreshes all the pivot tables in the collection. [Api set: ExcelApi 1.3]
///
///
}
return PivotTableCollection;
})(OfficeExtension.ClientObject);
Excel.PivotTableCollection = PivotTableCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var PivotTableScopedCollection = (function(_super) {
__extends(PivotTableScopedCollection, _super);
function PivotTableScopedCollection() {
/// Represents a scoped collection of PivotTables. The PivotTables are sorted based on the location of the PivotTable's top-left corner. They are ordered top-to-bottom and then left-to-right. [Api set: ExcelApi 1.12]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
PivotTableScopedCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
PivotTableScopedCollection.prototype.getCount = function() {
///
/// Gets the number of PivotTables in the collection. [Api set: ExcelApi 1.12]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
PivotTableScopedCollection.prototype.getFirst = function() {
///
/// Gets the first PivotTable in the collection. The PivotTables in the collection are sorted top-to-bottom and left-to-right, such that top-left table is the first PivotTable in the collection. [Api set: ExcelApi 1.12]
///
///
}
PivotTableScopedCollection.prototype.getItem = function(key) {
///
/// Gets a PivotTable by name. [Api set: ExcelApi 1.12]
///
/// Name of the PivotTable to be retrieved.
///
}
PivotTableScopedCollection.prototype.getItemOrNullObject = function(name) {
///
/// Gets a PivotTable by name. If the PivotTable does not exist, then this function returns an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.12]
///
/// Name of the PivotTable to be retrieved.
///
}
return PivotTableScopedCollection;
})(OfficeExtension.ClientObject);
Excel.PivotTableScopedCollection = PivotTableScopedCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var PivotTableStyle = (function(_super) {
__extends(PivotTableStyle, _super);
function PivotTableStyle() {
/// Represents a PivotTable style, which defines style elements by PivotTable region. [Api set: ExcelApi 1.10]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the name of the PivotTable style. [Api set: ExcelApi 1.10]
/// Specifies if this `PivotTableStyle` object is read-only. [Api set: ExcelApi 1.10]
}
PivotTableStyle.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
PivotTableStyle.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.PivotTableStyleUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing PivotTableStyle object, with properties that have already been loaded and synced.
///
}
PivotTableStyle.prototype.delete = function() {
///
/// Deletes the PivotTable style. [Api set: ExcelApi 1.10]
///
///
}
PivotTableStyle.prototype.duplicate = function() {
///
/// Creates a duplicate of this PivotTable style with copies of all the style elements. [Api set: ExcelApi 1.10]
///
/// The new `PivotTableStyle` object that has been duplicated from this PivotTable style.
}
return PivotTableStyle;
})(OfficeExtension.ClientObject);
Excel.PivotTableStyle = PivotTableStyle;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var PivotTableStyleCollection = (function(_super) {
__extends(PivotTableStyleCollection, _super);
function PivotTableStyleCollection() {
/// Represents a collection of PivotTable styles. [Api set: ExcelApi 1.10]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
PivotTableStyleCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
PivotTableStyleCollection.prototype.add = function(name, makeUniqueName) {
///
/// Creates a blank `PivotTableStyle` with the specified name. [Api set: ExcelApi 1.10]
///
/// The unique name for the new PivotTable style. Will throw an `InvalidArgument` error if the name is already in use.
/// Optional. Defaults to `false`. If `true`, will append numbers to the name in order to make it unique, if needed.
/// The newly created `PivotTableStyle`.
}
PivotTableStyleCollection.prototype.getCount = function() {
///
/// Gets the number of PivotTable styles in the collection. [Api set: ExcelApi 1.10]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
PivotTableStyleCollection.prototype.getDefault = function() {
///
/// Gets the default PivotTable style for the parent object's scope. [Api set: ExcelApi 1.10]
///
/// The `PivotTableStyle` object that is the current default PivotTable style.
}
PivotTableStyleCollection.prototype.getItem = function(name) {
///
/// Gets a `PivotTableStyle` by name. [Api set: ExcelApi 1.10]
///
/// Name of the PivotTable style to be retrieved.
/// The `PivotTableStyle` object whose name matches the input.
}
PivotTableStyleCollection.prototype.getItemOrNullObject = function(name) {
///
/// Gets a `PivotTableStyle` by name. If the `PivotTableStyle` does not exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.10]
///
/// Name of the PivotTable style to be retrieved.
/// The `PivotTableStyle` object whose name matches the input.
}
PivotTableStyleCollection.prototype.setDefault = function(newDefaultStyle) {
///
/// Sets the default PivotTable style for use in the parent object's scope. [Api set: ExcelApi 1.10]
///
/// The `PivotTableStyle` object, or name of the `PivotTableStyle` object, that should be the new default.
///
}
return PivotTableStyleCollection;
})(OfficeExtension.ClientObject);
Excel.PivotTableStyleCollection = PivotTableStyleCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var PivotValueFilter = (function() {
function PivotValueFilter() {
/// Configurable template for a value filter to apply to a PivotField. The `condition` defines what criteria need to be set in order for the filter to operate. [Api set: ExcelApi 1.12]
/// 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. [Api set: ExcelApi 1.12]
/// Specifies the condition for the filter, which defines the necessary filtering criteria. [Api set: ExcelApi 1.12]
/// If `true`, filter *excludes* items that meet criteria. The default is `false` (filter to include items that meet criteria). [Api set: ExcelApi 1.12]
/// The lower-bound of the range for the `between` filter condition. [Api set: ExcelApi 1.12]
/// Specifies if the filter is for the top/bottom N items, top/bottom N percent, or top/bottom N sum. [Api set: ExcelApi 1.12]
/// The "N" threshold number of items, percent, or sum to be filtered for a top/bottom filter condition. [Api set: ExcelApi 1.12]
/// The upper-bound of the range for the `between` filter condition. [Api set: ExcelApi 1.12]
/// Name of the chosen "value" in the field by which to filter. [Api set: ExcelApi 1.12]
}
return PivotValueFilter;
})();
Interfaces.PivotValueFilter.__proto__ = null;
Interfaces.PivotValueFilter = PivotValueFilter;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Specifies the way that an object is attached to its underlying cells. [Api set: ExcelApi 1.9]
var Placement = {
__proto__: null,
"twoCell": "twoCell",
"oneCell": "oneCell",
"absolute": "absolute",
}
Excel.Placement = Placement;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var PresetCriteriaConditionalFormat = (function(_super) {
__extends(PresetCriteriaConditionalFormat, _super);
function PresetCriteriaConditionalFormat() {
/// Represents the the preset criteria conditional format such as above average, below average, unique values, contains blank, nonblank, error, and noerror. [Api set: ExcelApi 1.6]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. [Api set: ExcelApi 1.6]
/// The rule of the conditional format. [Api set: ExcelApi 1.6]
}
PresetCriteriaConditionalFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
PresetCriteriaConditionalFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.PresetCriteriaConditionalFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing PresetCriteriaConditionalFormat object, with properties that have already been loaded and synced.
///
}
return PresetCriteriaConditionalFormat;
})(OfficeExtension.ClientObject);
Excel.PresetCriteriaConditionalFormat = PresetCriteriaConditionalFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.9]
var PrintComments = {
__proto__: null,
"noComments": "noComments",
"endSheet": "endSheet",
"inPlace": "inPlace",
}
Excel.PrintComments = PrintComments;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.9]
var PrintErrorType = {
__proto__: null,
"asDisplayed": "asDisplayed",
"blank": "blank",
"dash": "dash",
"notAvailable": "notAvailable",
}
Excel.PrintErrorType = PrintErrorType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.9]
var PrintMarginUnit = {
__proto__: null,
"points": "points",
"inches": "inches",
"centimeters": "centimeters",
}
Excel.PrintMarginUnit = PrintMarginUnit;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.9]
var PrintOrder = {
__proto__: null,
"downThenOver": "downThenOver",
"overThenDown": "overThenDown",
}
Excel.PrintOrder = PrintOrder;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.7]
var ProtectionSelectionMode = {
__proto__: null,
"normal": "normal",
"unlocked": "unlocked",
"none": "none",
}
Excel.ProtectionSelectionMode = ProtectionSelectionMode;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Query = (function(_super) {
__extends(Query, _super);
function Query() {
/// Represents a PowerQuery query. [Api set: ExcelApi 1.14]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the query error message from when the query was last refreshed. [Api set: ExcelApi 1.14]
/// Gets the query loaded to object type. [Api set: ExcelApi 1.14]
/// Specifies if the query loaded to the data model. [Api set: ExcelApi 1.14]
/// Gets the name of the query. Query names cannot contain periods or quotation marks. [Api set: ExcelApi 1.14]
/// Gets the date and time when the query was last refreshed. [Api set: ExcelApi 1.14]
/// Gets the number of rows that were loaded when the query was last refreshed. If last refresh has errors the value will be -1. [Api set: ExcelApi 1.14]
}
Query.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
return Query;
})(OfficeExtension.ClientObject);
Excel.Query = Query;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var QueryCollection = (function(_super) {
__extends(QueryCollection, _super);
function QueryCollection() {
/// Represents the collection of queries in the workbook. [Api set: ExcelApi 1.14]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
QueryCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
QueryCollection.prototype.getCount = function() {
///
/// Gets the number of queries in the workbook. [Api set: ExcelApi 1.14]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
QueryCollection.prototype.getItem = function(key) {
///
/// Gets a query from the collection based on its name. [Api set: ExcelApi 1.14]
///
/// The name of the query case-insensitive.
/// The query with the given name. If there is no query by that name, then an error is thrown.
}
return QueryCollection;
})(OfficeExtension.ClientObject);
Excel.QueryCollection = QueryCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// An enum that specifies the query load error message. [Api set: ExcelApi 1.14]
var QueryError = {
__proto__: null,
"unknown": "unknown",
"none": "none",
"failedLoadToWorksheet": "failedLoadToWorksheet",
"failedLoadToDataModel": "failedLoadToDataModel",
"failedDownload": "failedDownload",
"failedToCompleteDownload": "failedToCompleteDownload",
}
Excel.QueryError = QueryError;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Range = (function(_super) {
__extends(Range, _super);
function Range() {
/// Range represents a set of one or more contiguous cells such as a cell, a row, a column, or a block of cells. To learn more about how ranges are used throughout the API, start with {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-core-concepts#ranges | Ranges in the Excel JavaScript API}. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies the range reference in A1-style. Address value contains the sheet reference (e.g., "Sheet1!A1:B4"). [Api set: ExcelApi 1.1]
/// Represents the range reference for the specified range in the language of the user. [Api set: ExcelApi 1.1]
/// 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). [Api set: ExcelApi 1.1]
/// Specifies the total number of columns in the range. [Api set: ExcelApi 1.1]
/// 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. [Api set: ExcelApi 1.2]
/// Specifies the column number of the first cell in the range. Zero-indexed. [Api set: ExcelApi 1.1]
/// The collection of `ConditionalFormats` that intersect the range. [Api set: ExcelApi 1.6]
/// Returns a data validation object. [Api set: ExcelApi 1.8]
/// Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties. [Api set: ExcelApi 1.1]
/// Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead. [Api set: ExcelApi 1.1]
/// 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. [Api set: ExcelApi 1.1]
/// Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead. [Api set: ExcelApi 1.2]
/// 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. [Api set: ExcelApi 1.12]
/// Returns the distance in points, for 100% zoom, from the top edge of the range to the bottom edge of the range. [Api set: ExcelApi 1.10]
/// 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. [Api set: ExcelApi 1.2]
/// Represents the hyperlink for the current range. [Api set: ExcelApi 1.7]
/// Represents if the current range is an entire column. [Api set: ExcelApi 1.7]
/// Represents if the current range is an entire row. [Api set: ExcelApi 1.7]
/// Returns the distance in points, for 100% zoom, from the left edge of the worksheet to the left edge of the range. [Api set: ExcelApi 1.10]
/// Represents the data type state of each cell. [Api set: ExcelApi 1.9]
/// Represents Excel's number format code for the given range. [Api set: ExcelApi 1.1]
/// Represents the category of number format of each cell. [Api set: ExcelApi 1.12]
/// 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. [Api set: ExcelApi 1.7]
/// Returns the total number of rows in the range. [Api set: ExcelApi 1.1]
/// 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. [Api set: ExcelApi 1.2]
/// Returns the row number of the first cell in the range. Zero-indexed. [Api set: ExcelApi 1.1]
/// 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. [Api set: ExcelApi 1.12]
/// Represents the range sort of the current range. [Api set: ExcelApi 1.2]
/// 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. [Api set: ExcelApi 1.7]
/// 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. [Api set: ExcelApi 1.1]
/// Returns the distance in points, for 100% zoom, from the top edge of the worksheet to the top edge of the range. [Api set: ExcelApi 1.10]
/// Specifies the type of data in each cell. [Api set: ExcelApi 1.1]
/// 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. [Api set: ExcelApi 1.1]
/// Returns the distance in points, for 100% zoom, from the left edge of the range to the right edge of the range. [Api set: ExcelApi 1.10]
/// The worksheet containing the current range. [Api set: ExcelApi 1.1]
}
Range.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Range.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.RangeUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing Range object, with properties that have already been loaded and synced.
///
}
Range.prototype.autoFill = function(destinationRange, autoFillType) {
///
/// Fills 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 either horizontally or vertically. Discontiguous ranges are not supported. For more information, read {@link https://support.office.com/article/video-use-autofill-and-flash-fill-2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}. [Api set: ExcelApi 1.9, ExcelApi Preview for null `destinationRange`]
///
/// 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).
/// The type of AutoFill. Specifies how the destination range is to be filled, based on the contents of the current range. Default is "FillDefault".
///
}
Range.prototype.calculate = function() {
///
/// Calculates a range of cells on a worksheet. [Api set: ExcelApi 1.6]
///
///
}
Range.prototype.clear = function(applyTo) {
///
/// Clear range values, format, fill, border, etc. [Api set: ExcelApi 1.1]
///
/// Optional. Determines the type of clear action. See `Excel.ClearApplyTo` for details.
///
}
Range.prototype.convertDataTypeToText = function() {
///
/// Converts the range cells with data types into text. [Api set: ExcelApi 1.9]
///
///
}
Range.prototype.convertToLinkedDataType = function(serviceID, languageCulture) {
///
/// Converts the range cells into linked data types in the worksheet. [Api set: ExcelApi 1.9]
///
/// The service ID which will be used to query the data.
/// Language culture to query the service for.
///
}
Range.prototype.copyFrom = function(sourceRange, copyType, skipBlanks, transpose) {
///
/// 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 will be expanded automatically if it is smaller than the source. [Api set: ExcelApi 1.9]
///
/// 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.
/// The type of cell data or formatting to copy over. Default is "All".
/// True if to skip blank cells in the source range. Default is false.
/// True if to transpose the cells in the destination range. Default is false.
///
}
Range.prototype.delete = function(shift) {
///
/// Deletes the cells associated with the range. [Api set: ExcelApi 1.1]
///
/// Specifies which way to shift the cells. See `Excel.DeleteShiftDirection` for details.
///
}
Range.prototype.find = function(text, criteria) {
///
/// 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. [Api set: ExcelApi 1.9]
///
/// The string to find.
/// Additional search criteria, including the search direction and whether the search needs to match the entire cell or be case-sensitive.
/// The `Range` object representing the first cell that contains a value matching the search text and criteria.
}
Range.prototype.findOrNullObject = function(text, criteria) {
///
/// 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 function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.9]
///
/// The string to find.
/// Additional search criteria, including the search direction and whether the search needs to match the entire cell or be case-sensitive.
/// The `Range` which matched the search criteria.
}
Range.prototype.flashFill = function() {
///
/// 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. [Api set: ExcelApi 1.9]
///
///
}
Range.prototype.getAbsoluteResizedRange = function(numRows, numColumns) {
///
/// Gets a `Range` object with the same top-left cell as the current `Range` object, but with the specified numbers of rows and columns. [Api set: ExcelApi 1.7]
///
/// The number of rows of the new range size.
/// The number of columns of the new range size.
///
}
Range.prototype.getBoundingRect = function(anotherRange) {
///
/// Gets the smallest range object that encompasses the given ranges. For example, the `GetBoundingRect` of "B2:C5" and "D10:E15" is "B2:E15". [Api set: ExcelApi 1.1]
///
/// The range object, address, or range name.
///
}
Range.prototype.getCell = function(row, column) {
///
/// 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. [Api set: ExcelApi 1.1]
///
/// Row number of the cell to be retrieved. Zero-indexed.
/// Column number of the cell to be retrieved. Zero-indexed.
///
}
Range.prototype.getCellProperties = function(cellPropertiesLoadOptions) {
///
/// Returns a 2D array, encapsulating the data for each cell's font, fill, borders, alignment, and other properties. [Api set: ExcelApi 1.9]
///
/// An object that represents which cell properties to load.
/// A 2D array where each item represents the requested properties of the corresponding cell.
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = [];
return result;
}
Range.prototype.getColumn = function(column) {
///
/// Gets a column contained in the range. [Api set: ExcelApi 1.1]
///
/// Column number of the range to be retrieved. Zero-indexed.
///
}
Range.prototype.getColumnProperties = function(columnPropertiesLoadOptions) {
///
/// Returns a single-dimensional array, encapsulating the data for each column's font, fill, borders, alignment, and other properties. For properties that are not consistent across each cell within a given column, null will be returned. [Api set: ExcelApi 1.9]
///
/// An object that represents which column properties to load.
/// An array where each item represents the requested properties of the corresponding column.
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = [];
return result;
}
Range.prototype.getColumnsAfter = function(count) {
///
/// Gets a certain number of columns to the right of the current `Range` object. [Api set: ExcelApi 1.2]
///
/// 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.
///
}
Range.prototype.getColumnsBefore = function(count) {
///
/// Gets a certain number of columns to the left of the current `Range` object. [Api set: ExcelApi 1.2]
///
/// 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.
///
}
Range.prototype.getDirectDependents = function() {
///
/// Returns a `WorkbookRangeAreas` object that represents the range containing all the direct dependents of a cell in the same worksheet or in multiple worksheets. [Api set: ExcelApi 1.13]
///
///
}
Range.prototype.getDirectPrecedents = function() {
///
/// Returns a `WorkbookRangeAreas` object that represents the range containing all the direct precedents of a cell in the same worksheet or in multiple worksheets. [Api set: ExcelApi 1.12]
///
///
}
Range.prototype.getEntireColumn = function() {
///
/// 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"). [Api set: ExcelApi 1.1]
///
///
}
Range.prototype.getEntireRow = function() {
///
/// 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"). [Api set: ExcelApi 1.1]
///
///
}
Range.prototype.getExtendedRange = function(direction, activeCell) {
///
/// 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. [Api set: ExcelApi 1.13]
///
/// The direction from the active cell.
/// 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.
///
}
Range.prototype.getImage = function() {
///
/// Renders the range as a base64-encoded png image. **Important**: This API is currently unsupported in Excel for Mac. Visit {@link https://github.com/OfficeDev/office-js/issues/235 | OfficeDev/office-js Issue #235} for the current status. [Api set: ExcelApi 1.7]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = '';
return result;
}
Range.prototype.getIntersection = function(anotherRange) {
///
/// Gets the range object that represents the rectangular intersection of the given ranges. [Api set: ExcelApi 1.1]
///
/// The range object or range address that will be used to determine the intersection of ranges.
///
}
Range.prototype.getIntersectionOrNullObject = function(anotherRange) {
///
/// Gets the range object that represents the rectangular intersection of the given ranges. If no intersection is found, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.4]
///
/// The range object or range address that will be used to determine the intersection of ranges.
///
}
Range.prototype.getLastCell = function() {
///
/// Gets the last cell within the range. For example, the last cell of "B2:D5" is "D5". [Api set: ExcelApi 1.1]
///
///
}
Range.prototype.getLastColumn = function() {
///
/// Gets the last column within the range. For example, the last column of "B2:D5" is "D2:D5". [Api set: ExcelApi 1.1]
///
///
}
Range.prototype.getLastRow = function() {
///
/// Gets the last row within the range. For example, the last row of "B2:D5" is "B5:D5". [Api set: ExcelApi 1.1]
///
///
}
Range.prototype.getMergedAreasOrNullObject = function() {
///
/// 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, the API will fail to return the result. If the RangeAreas does not exist, will return a null object. [Api set: ExcelApi 1.13]
///
///
}
Range.prototype.getOffsetRange = function(rowOffset, columnOffset) {
///
/// 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. [Api set: ExcelApi 1.1]
///
/// 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.
/// 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.
///
}
Range.prototype.getPivotTables = function(fullyContained) {
///
/// Gets a scoped collection of PivotTables that overlap with the range. [Api set: ExcelApi 1.12]
///
/// If `true`, returns only PivotTables that are fully contained within the range bounds. The default value is `false`.
///
}
Range.prototype.getPrecedents = function() {
///
/// Returns a `WorkbookRangeAreas` object that represents the range containing all the precedents of a cell in the same worksheet or in multiple worksheets. [Api set: ExcelApi 1.14]
///
///
}
Range.prototype.getRangeEdge = function(direction, activeCell) {
///
/// 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. [Api set: ExcelApi 1.13]
///
/// The direction from the active cell.
/// 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.
///
}
Range.prototype.getResizedRange = function(deltaRows, deltaColumns) {
///
/// 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. [Api set: ExcelApi 1.2]
///
/// 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.
/// 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.
///
}
Range.prototype.getRow = function(row) {
///
/// Gets a row contained in the range. [Api set: ExcelApi 1.1]
///
/// Row number of the range to be retrieved. Zero-indexed.
///
}
Range.prototype.getRowProperties = function(rowPropertiesLoadOptions) {
///
/// Returns a single-dimensional array, encapsulating the data for each row's font, fill, borders, alignment, and other properties. For properties that are not consistent across each cell within a given row, `null` will be returned. [Api set: ExcelApi 1.9]
///
/// An object that represents which row properties to load.
/// An array where each item represents the requested properties of the corresponding row.
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = [];
return result;
}
Range.prototype.getRowsAbove = function(count) {
///
/// Gets a certain number of rows above the current `Range` object. [Api set: ExcelApi 1.2]
///
/// 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.
///
}
Range.prototype.getRowsBelow = function(count) {
///
/// Gets a certain number of rows below the current `Range` object. [Api set: ExcelApi 1.2]
///
/// 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.
///
}
Range.prototype.getSpecialCells = function(cellType, cellValueType) {
///
/// Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents all the cells that match the specified type and value. If no special cells are found, an `ItemNotFound` error will be thrown. [Api set: ExcelApi 1.9]
///
/// The type of cells to include.
/// 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.
///
}
Range.prototype.getSpecialCellsOrNullObject = function(cellType, cellValueType) {
///
/// 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 function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.9]
///
/// The type of cells to include.
/// 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.
///
}
Range.prototype.getSpillParent = function() {
///
/// 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. [Api set: ExcelApi 1.12]
///
///
}
Range.prototype.getSpillParentOrNullObject = function() {
///
/// 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 function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.12]
///
///
}
Range.prototype.getSpillingToRange = function() {
///
/// Gets the range object containing the spill range when called on an anchor cell. Fails if applied to a range with more than one cell. [Api set: ExcelApi 1.12]
///
///
}
Range.prototype.getSpillingToRangeOrNullObject = function() {
///
/// 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 function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.12]
///
///
}
Range.prototype.getSurroundingRegion = function() {
///
/// 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. [Api set: ExcelApi 1.7]
///
///
}
Range.prototype.getTables = function(fullyContained) {
///
/// Gets a scoped collection of tables that overlap with the range. [Api set: ExcelApi 1.9]
///
/// If `true`, returns only tables that are fully contained within the range bounds. The default value is `false`.
///
}
Range.prototype.getUsedRange = function(valuesOnly) {
///
/// Returns the used range of the given range object. If there are no used cells within the range, this function will throw an `ItemNotFound` error. [Api set: ExcelApi 1.1]
///
/// Considers only cells with values as used cells. [Api set: ExcelApi 1.2]
///
}
Range.prototype.getUsedRangeOrNullObject = function(valuesOnly) {
///
/// Returns the used range of the given range object. If there are no used cells within the range, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.4]
///
/// Considers only cells with values as used cells.
///
}
Range.prototype.getVisibleView = function() {
///
/// Represents the visible rows of the current range. [Api set: ExcelApi 1.3]
///
///
}
Range.prototype.group = function(groupOption) {
///
/// Groups columns and rows for an outline. [Api set: ExcelApi 1.10]
///
/// 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").
///
}
Range.prototype.hideGroupDetails = function(groupOption) {
///
/// Hides the details of the row or column group. [Api set: ExcelApi 1.10]
///
/// Specifies whether to hide the details of grouped rows or grouped columns.
///
}
Range.prototype.insert = function(shift) {
///
/// 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. [Api set: ExcelApi 1.1]
///
/// Specifies which way to shift the cells. See `Excel.InsertShiftDirection` for details.
///
}
Range.prototype.merge = function(across) {
///
/// Merge the range cells into one region in the worksheet. [Api set: ExcelApi 1.2]
///
/// Optional. Set `true` to merge cells in each row of the specified range as separate merged cells. The default value is `false`.
///
}
Range.prototype.moveTo = function(destinationRange) {
///
/// 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. [Api set: ExcelApi 1.11]
///
/// destinationRange Specifies the range to where the information in this range will be moved.
///
}
Range.prototype.removeDuplicates = function(columns, includesHeader) {
///
/// Removes duplicate values from the range specified by the columns. [Api set: ExcelApi 1.9]
///
/// The columns inside the range that may contain duplicates. At least one column needs to be specified. Zero-indexed.
/// True if the input data contains header. Default is false.
/// The resulting object that contains the number of rows removed and the number of remaining unique rows.
}
Range.prototype.replaceAll = function(text, replacement, criteria) {
///
/// Finds and replaces the given string based on the criteria specified within the current range. [Api set: ExcelApi 1.9]
///
/// String to find.
/// The string that replaces the original string.
/// Additional replacement criteria.
/// The number of replacements performed.
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
Range.prototype.select = function() {
///
/// Selects the specified range in the Excel UI. [Api set: ExcelApi 1.1]
///
///
}
Range.prototype.setCellProperties = function(cellPropertiesData) {
///
/// Updates the range based on a 2D array of cell properties, encapsulating things like font, fill, borders, and alignment. [Api set: ExcelApi 1.9]
///
/// A 2D array that represents which properties to set in each cell.
///
}
Range.prototype.setColumnProperties = function(columnPropertiesData) {
///
/// Updates the range based on a single-dimensional array of column properties, encapsulating things like font, fill, borders, and alignment. [Api set: ExcelApi 1.9]
///
/// An array that represents which properties to set in each column.
///
}
Range.prototype.setDirty = function() {
///
/// Set a range to be recalculated when the next recalculation occurs. [Api set: ExcelApi 1.9]
///
///
}
Range.prototype.setRowProperties = function(rowPropertiesData) {
///
/// Updates the range based on a single-dimensional array of row properties, encapsulating things like font, fill, borders, and alignment. [Api set: ExcelApi 1.9]
///
/// An array that represents which properties to set in each row.
///
}
Range.prototype.showCard = function() {
///
/// Displays the card for an active cell if it has rich value content. [Api set: ExcelApi 1.7]
///
///
}
Range.prototype.showGroupDetails = function(groupOption) {
///
/// Shows the details of the row or column group. [Api set: ExcelApi 1.10]
///
/// Specifies whether to show the details of grouped rows or grouped columns.
///
}
Range.prototype.ungroup = function(groupOption) {
///
/// Ungroups columns and rows for an outline. [Api set: ExcelApi 1.10]
///
/// Specifies how the range can be ungrouped by rows or columns.
///
}
Range.prototype.unmerge = function() {
///
/// Unmerge the range cells into separate cells. [Api set: ExcelApi 1.2]
///
///
}
Range.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
Range.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return Range;
})(OfficeExtension.ClientObject);
Excel.Range = Range;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var RangeAreas = (function(_super) {
__extends(RangeAreas, _super);
function RangeAreas() {
/// `RangeAreas` represents a collection of one or more rectangular ranges in the same worksheet. To learn how to use discontiguous ranges, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-multiple-ranges | Work with multiple ranges simultaneously in Excel add-ins}. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// 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"). [Api set: ExcelApi 1.9]
/// Returns the `RangeAreas` reference in the user locale. [Api set: ExcelApi 1.9]
/// Returns the number of rectangular ranges that comprise this `RangeAreas` object. [Api set: ExcelApi 1.9]
/// Returns a collection of rectangular ranges that comprise this `RangeAreas` object. [Api set: ExcelApi 1.9]
/// 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). [Api set: ExcelApi 1.9]
/// Returns a collection of conditional formats that intersect with any cells in this `RangeAreas` object. [Api set: ExcelApi 1.9]
/// Returns a data validation object for all ranges in the `RangeAreas`. [Api set: ExcelApi 1.9]
/// Returns a `RangeFormat` object, encapsulating the the font, fill, borders, alignment, and other properties for all ranges in the `RangeAreas` object. [Api set: ExcelApi 1.9]
/// Specifies if all the ranges on this `RangeAreas` object represent entire columns (e.g., "A:C, Q:Z"). [Api set: ExcelApi 1.9]
/// Specifies if all the ranges on this `RangeAreas` object represent entire rows (e.g., "1:3, 5:7"). [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9]
/// Returns the worksheet for the current `RangeAreas`. [Api set: ExcelApi 1.9]
}
RangeAreas.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
RangeAreas.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.RangeAreasUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing RangeAreas object, with properties that have already been loaded and synced.
///
}
RangeAreas.prototype.calculate = function() {
///
/// Calculates all cells in the `RangeAreas`. [Api set: ExcelApi 1.9]
///
///
}
RangeAreas.prototype.clear = function(applyTo) {
///
/// Clears values, format, fill, border, and other properties on each of the areas that comprise this `RangeAreas` object. [Api set: ExcelApi 1.9]
///
/// Optional. Determines the type of clear action. See `Excel.ClearApplyTo` for details. Default is "All".
///
}
RangeAreas.prototype.convertDataTypeToText = function() {
///
/// Converts all cells in the `RangeAreas` with data types into text. [Api set: ExcelApi 1.9]
///
///
}
RangeAreas.prototype.convertToLinkedDataType = function(serviceID, languageCulture) {
///
/// Converts all cells in the `RangeAreas` into linked data types. [Api set: ExcelApi 1.9]
///
/// The service ID which will be used to query the data.
/// Language culture to query the service for.
///
}
RangeAreas.prototype.copyFrom = function(sourceRange, copyType, skipBlanks, transpose) {
///
/// 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. [Api set: ExcelApi 1.9]
///
/// 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.
/// The type of cell data or formatting to copy over. Default is "All".
/// True if to skip blank cells in the source range or `RangeAreas`. Default is false.
/// True if to transpose the cells in the destination `RangeAreas`. Default is false.
///
}
RangeAreas.prototype.getEntireColumn = function() {
///
/// 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"). [Api set: ExcelApi 1.9]
///
///
}
RangeAreas.prototype.getEntireRow = function() {
///
/// 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"). [Api set: ExcelApi 1.9]
///
///
}
RangeAreas.prototype.getIntersection = function(anotherRange) {
///
/// Returns the `RangeAreas` object that represents the intersection of the given ranges or `RangeAreas`. If no intersection is found, an `ItemNotFound` error will be thrown. [Api set: ExcelApi 1.9]
///
/// The range, `RangeAreas` object, or range address that will be used to determine the intersection.
///
}
RangeAreas.prototype.getIntersectionOrNullObject = function(anotherRange) {
///
/// Returns the `RangeAreas` object that represents the intersection of the given ranges or `RangeAreas`. If no intersection is found, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.9]
///
/// The range, `RangeAreas` object, or address that will be used to determine the intersection.
///
}
RangeAreas.prototype.getOffsetRangeAreas = function(rowOffset, columnOffset) {
///
/// 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. [Api set: ExcelApi 1.9]
///
/// 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.
/// 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.
///
}
RangeAreas.prototype.getSpecialCells = function(cellType, cellValueType) {
///
/// Returns a `RangeAreas` object that represents all the cells that match the specified type and value. Throws an error if no special cells are found that match the criteria. [Api set: ExcelApi 1.9]
///
/// The type of cells to include.
/// 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.
///
}
RangeAreas.prototype.getSpecialCellsOrNullObject = function(cellType, cellValueType) {
///
/// 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 function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.9]
///
/// The type of cells to include.
/// 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.
///
}
RangeAreas.prototype.getTables = function(fullyContained) {
///
/// Returns a scoped collection of tables that overlap with any range in this `RangeAreas` object. [Api set: ExcelApi 1.9]
///
/// If `true`, returns only tables that are fully contained within the range bounds. Default is `false`.
///
}
RangeAreas.prototype.getUsedRangeAreas = function(valuesOnly) {
///
/// 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`, the `ItemNotFound` error will be thrown. [Api set: ExcelApi 1.9]
///
/// Whether to only consider cells with values as used cells. Default is `false`.
///
}
RangeAreas.prototype.getUsedRangeAreasOrNullObject = function(valuesOnly) {
///
/// 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 function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.9]
///
/// Whether to only consider cells with values as used cells.
///
}
RangeAreas.prototype.setDirty = function() {
///
/// Sets the `RangeAreas` to be recalculated when the next recalculation occurs. [Api set: ExcelApi 1.9]
///
///
}
RangeAreas.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
RangeAreas.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return RangeAreas;
})(OfficeExtension.ClientObject);
Excel.RangeAreas = RangeAreas;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var RangeAreasCollection = (function(_super) {
__extends(RangeAreasCollection, _super);
function RangeAreasCollection() {
/// Contains the collection of cross-workbook level ranges. [Api set: ExcelApi 1.12]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
RangeAreasCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
RangeAreasCollection.prototype.getCount = function() {
///
/// Gets the number of `RangeAreas` objects in this collection. [Api set: ExcelApi 1.12]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
RangeAreasCollection.prototype.getItemAt = function(index) {
///
/// Returns the `RangeAreas` object based on position in the collection. [Api set: ExcelApi 1.12]
///
/// Index value of the range object to be retrieved. Zero-indexed.
///
}
return RangeAreasCollection;
})(OfficeExtension.ClientObject);
Excel.RangeAreasCollection = RangeAreasCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var RangeBorder = (function(_super) {
__extends(RangeBorder, _super);
function RangeBorder() {
/// Represents the border of an object. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// 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"). [Api set: ExcelApi 1.1]
/// Constant value that indicates the specific side of the border. See `Excel.BorderIndex` for details. [Api set: ExcelApi 1.1]
/// One of the constants of line style specifying the line style for the border. See `Excel.BorderLineStyle` for details. [Api set: ExcelApi 1.1]
/// 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. [Api set: ExcelApi 1.9]
/// Specifies the weight of the border around a range. See `Excel.BorderWeight` for details. [Api set: ExcelApi 1.1]
}
RangeBorder.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
RangeBorder.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.RangeBorderUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing RangeBorder object, with properties that have already been loaded and synced.
///
}
return RangeBorder;
})(OfficeExtension.ClientObject);
Excel.RangeBorder = RangeBorder;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var RangeBorderCollection = (function(_super) {
__extends(RangeBorderCollection, _super);
function RangeBorderCollection() {
/// Represents the border objects that make up the range border. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Number of border objects in the collection. [Api set: ExcelApi 1.1]
/// 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. [Api set: ExcelApi 1.9]
/// Gets the loaded child items in this collection.
}
RangeBorderCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
RangeBorderCollection.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.RangeBorderCollectionUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing RangeBorderCollection object, with properties that have already been loaded and synced.
///
}
RangeBorderCollection.prototype.getItem = function(index) {
///
/// Gets a border object using its name. [Api set: ExcelApi 1.1]
///
/// Index value of the border object to be retrieved. See `Excel.BorderIndex` for details.
///
}
RangeBorderCollection.prototype.getItemAt = function(index) {
///
/// Gets a border object using its index. [Api set: ExcelApi 1.1]
///
/// Index value of the object to be retrieved. Zero-indexed.
///
}
return RangeBorderCollection;
})(OfficeExtension.ClientObject);
Excel.RangeBorderCollection = RangeBorderCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var RangeCollection = (function(_super) {
__extends(RangeCollection, _super);
function RangeCollection() {
/// [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
RangeCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
RangeCollection.prototype.getCount = function() {
///
/// Returns the number of ranges in the `RangeCollection`. [Api set: ExcelApi 1.9]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
RangeCollection.prototype.getItemAt = function(index) {
///
/// Returns the range object based on its position in the `RangeCollection`. [Api set: ExcelApi 1.9]
///
/// Index value of the range object to be retrieved. Zero-indexed.
///
}
return RangeCollection;
})(OfficeExtension.ClientObject);
Excel.RangeCollection = RangeCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.9]
var RangeCopyType = {
__proto__: null,
"all": "all",
"formulas": "formulas",
"values": "values",
"formats": "formats",
}
Excel.RangeCopyType = RangeCopyType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var RangeFill = (function(_super) {
__extends(RangeFill, _super);
function RangeFill() {
/// Represents the background of a range object. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// 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") [Api set: ExcelApi 1.1]
/// The pattern of a range. See `Excel.FillPattern` for details. LinearGradient and RectangularGradient are not supported. A `null` value indicates that the entire range doesn't have a uniform pattern setting. [Api set: ExcelApi 1.9]
/// 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"). [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9]
}
RangeFill.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
RangeFill.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.RangeFillUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing RangeFill object, with properties that have already been loaded and synced.
///
}
RangeFill.prototype.clear = function() {
///
/// Resets the range background. [Api set: ExcelApi 1.1]
///
///
}
return RangeFill;
})(OfficeExtension.ClientObject);
Excel.RangeFill = RangeFill;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var RangeFont = (function(_super) {
__extends(RangeFont, _super);
function RangeFont() {
/// This object represents the font attributes (font name, font size, color, etc.) for an object. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the bold status of the font. [Api set: ExcelApi 1.1]
/// HTML color code representation of the text color (e.g., #FF0000 represents Red). [Api set: ExcelApi 1.1]
/// Specifies the italic status of the font. [Api set: ExcelApi 1.1]
/// Font name (e.g., "Calibri"). The name's length should not be greater than 31 characters. [Api set: ExcelApi 1.1]
/// Font size. [Api set: ExcelApi 1.1]
/// Specifies the strikethrough status of font. A `null` value indicates that the entire range doesn't have a uniform strikethrough setting. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9]
/// Type of underline applied to the font. See `Excel.RangeUnderlineStyle` for details. [Api set: ExcelApi 1.1]
}
RangeFont.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
RangeFont.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.RangeFontUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing RangeFont object, with properties that have already been loaded and synced.
///
}
return RangeFont;
})(OfficeExtension.ClientObject);
Excel.RangeFont = RangeFont;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var RangeFormat = (function(_super) {
__extends(RangeFormat, _super);
function RangeFormat() {
/// A format object encapsulating the range's font, fill, borders, alignment, and other properties. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies if text is automatically indented when text alignment is set to equal distribution. [Api set: ExcelApi 1.9]
/// Collection of border objects that apply to the overall range. [Api set: ExcelApi 1.1]
/// Specifies the width of all colums within the range. If the column widths are not uniform, `null` will be returned. [Api set: ExcelApi 1.2]
/// Returns the fill object defined on the overall range. [Api set: ExcelApi 1.1]
/// Returns the font object defined on the overall range. [Api set: ExcelApi 1.1]
/// Represents the horizontal alignment for the specified object. See `Excel.HorizontalAlignment` for details. [Api set: ExcelApi 1.1]
/// An integer from 0 to 250 that indicates the indent level. [Api set: ExcelApi 1.9]
/// Returns the format protection object for a range. [Api set: ExcelApi 1.2]
/// The reading order for the range. [Api set: ExcelApi 1.9]
/// The height of all rows in the range. If the row heights are not uniform, `null` will be returned. [Api set: ExcelApi 1.2]
/// Specifies if text automatically shrinks to fit in the available column width. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.7]
/// 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. Note: This property is only intended to be set to `true`. Setting it to `false` has no effect. [Api set: ExcelApi 1.7]
/// 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. Note: This property is only intended to be set to `true`. Setting it to `false` has no effect. [Api set: ExcelApi 1.7]
/// Represents the vertical alignment for the specified object. See `Excel.VerticalAlignment` for details. [Api set: ExcelApi 1.1]
/// Specifies if Excel wraps the text in the object. A `null` value indicates that the entire range doesn't have a uniform wrap setting [Api set: ExcelApi 1.1]
}
RangeFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
RangeFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.RangeFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing RangeFormat object, with properties that have already been loaded and synced.
///
}
RangeFormat.prototype.adjustIndent = function(amount) {
///
/// Adjusts the indentation of the range formatting. The indent value ranges from 0 to 250 and is measured in characters. [Api set: ExcelApi 1.11]
///
/// 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.
///
}
RangeFormat.prototype.autofitColumns = function() {
///
/// Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. [Api set: ExcelApi 1.2]
///
///
}
RangeFormat.prototype.autofitRows = function() {
///
/// Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns. [Api set: ExcelApi 1.2]
///
///
}
return RangeFormat;
})(OfficeExtension.ClientObject);
Excel.RangeFormat = RangeFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var RangeHyperlink = (function() {
function RangeHyperlink() {
/// Represents the necessary strings to get/set a hyperlink (XHL) object. [Api set: ExcelApi 1.7]
/// Represents the URL target for the hyperlink. [Api set: ExcelApi 1.7]
/// Represents the document reference target for the hyperlink. [Api set: ExcelApi 1.7]
/// Represents the string displayed when hovering over the hyperlink. [Api set: ExcelApi 1.7]
/// Represents the string that is displayed in the top left most cell in the range. [Api set: ExcelApi 1.7]
}
return RangeHyperlink;
})();
Interfaces.RangeHyperlink.__proto__ = null;
Interfaces.RangeHyperlink = RangeHyperlink;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var RangeReference = (function() {
function RangeReference() {
/// Represents a string reference of the form "SheetName!A1:B5", or a global or local named range. [Api set: ExcelApi 1.2]
/// The address of the range, for example "SheetName!A1:B5". [Api set: ExcelApi 1.2]
}
return RangeReference;
})();
Interfaces.RangeReference.__proto__ = null;
Interfaces.RangeReference = RangeReference;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var RangeSort = (function(_super) {
__extends(RangeSort, _super);
function RangeSort() {
/// Manages sorting operations on `Range` objects. [Api set: ExcelApi 1.2]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
}
RangeSort.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
RangeSort.prototype.apply = function(fields, matchCase, hasHeaders, orientation, method) {
///
/// Perform a sort operation. [Api set: ExcelApi 1.2]
///
/// The list of conditions to sort on.
/// Optional. Whether to have the casing impact string ordering.
/// Optional. Whether the range has a header.
/// Optional. Whether the operation is sorting rows or columns.
/// Optional. The ordering method used for Chinese characters.
///
}
return RangeSort;
})(OfficeExtension.ClientObject);
Excel.RangeSort = RangeSort;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.1]
var RangeUnderlineStyle = {
__proto__: null,
"none": "none",
"single": "single",
"double": "double",
"singleAccountant": "singleAccountant",
"doubleAccountant": "doubleAccountant",
}
Excel.RangeUnderlineStyle = RangeUnderlineStyle;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.1 for Unknown, Empty, String, Integer, Double, Boolean, Error. 1.7 for RichValue]
var RangeValueType = {
__proto__: null,
"unknown": "unknown",
"empty": "empty",
"string": "string",
"integer": "integer",
"double": "double",
"boolean": "boolean",
"error": "error",
"richValue": "richValue",
}
Excel.RangeValueType = RangeValueType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var RangeView = (function(_super) {
__extends(RangeView, _super);
function RangeView() {
/// RangeView represents a set of visible cells of the parent range. [Api set: ExcelApi 1.3]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the cell addresses of the `RangeView`. [Api set: ExcelApi 1.3]
/// The number of visible columns. [Api set: ExcelApi 1.3]
/// Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead. [Api set: ExcelApi 1.3]
/// 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. [Api set: ExcelApi 1.3]
/// Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead. [Api set: ExcelApi 1.3]
/// Returns a value that represents the index of the `RangeView`. [Api set: ExcelApi 1.3]
/// Represents Excel's number format code for the given cell. [Api set: ExcelApi 1.3]
/// The number of visible rows. [Api set: ExcelApi 1.3]
/// Represents a collection of range views associated with the range. [Api set: ExcelApi 1.3]
/// 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. [Api set: ExcelApi 1.3]
/// Represents the type of data of each cell. [Api set: ExcelApi 1.3]
/// 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. [Api set: ExcelApi 1.3]
}
RangeView.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
RangeView.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.RangeViewUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing RangeView object, with properties that have already been loaded and synced.
///
}
RangeView.prototype.getRange = function() {
///
/// Gets the parent range associated with the current `RangeView`. [Api set: ExcelApi 1.3]
///
///
}
return RangeView;
})(OfficeExtension.ClientObject);
Excel.RangeView = RangeView;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var RangeViewCollection = (function(_super) {
__extends(RangeViewCollection, _super);
function RangeViewCollection() {
/// Represents a collection of `RangeView` objects. [Api set: ExcelApi 1.3]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
RangeViewCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
RangeViewCollection.prototype.getCount = function() {
///
/// Gets the number of `RangeView` objects in the collection. [Api set: ExcelApi 1.4]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
RangeViewCollection.prototype.getItemAt = function(index) {
///
/// Gets a `RangeView` row via its index. Zero-indexed. [Api set: ExcelApi 1.3]
///
/// Index of the visible row.
///
}
return RangeViewCollection;
})(OfficeExtension.ClientObject);
Excel.RangeViewCollection = RangeViewCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.7]
var ReadingOrder = {
__proto__: null,
"context": "context",
"leftToRight": "leftToRight",
"rightToLeft": "rightToLeft",
}
Excel.ReadingOrder = ReadingOrder;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var RemoveDuplicatesResult = (function(_super) {
__extends(RemoveDuplicatesResult, _super);
function RemoveDuplicatesResult() {
/// Represents the results from `Range.removeDuplicates`. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Number of duplicated rows removed by the operation. [Api set: ExcelApi 1.9]
/// Number of remaining unique rows present in the resulting range. [Api set: ExcelApi 1.9]
}
RemoveDuplicatesResult.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
return RemoveDuplicatesResult;
})(OfficeExtension.ClientObject);
Excel.RemoveDuplicatesResult = RemoveDuplicatesResult;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ReplaceCriteria = (function() {
function ReplaceCriteria() {
/// Represents the replace criteria to be used. [Api set: ExcelApi 1.9]
/// 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). [Api set: ExcelApi 1.9]
/// Specifies if the match is case-sensitive. Default is `false` (case-insensitive). [Api set: ExcelApi 1.9]
}
return ReplaceCriteria;
})();
Interfaces.ReplaceCriteria.__proto__ = null;
Interfaces.ReplaceCriteria = ReplaceCriteria;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.9]
var RibbonTab = {
__proto__: null,
"others": "others",
"home": "home",
"insert": "insert",
"draw": "draw",
"pageLayout": "pageLayout",
"formulas": "formulas",
"data": "data",
"review": "review",
"view": "view",
"developer": "developer",
"addIns": "addIns",
"help": "help",
}
Excel.RibbonTab = RibbonTab;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var RowColumnPivotHierarchy = (function(_super) {
__extends(RowColumnPivotHierarchy, _super);
function RowColumnPivotHierarchy() {
/// Represents the Excel RowColumnPivotHierarchy. [Api set: ExcelApi 1.8]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Returns the PivotFields associated with the RowColumnPivotHierarchy. [Api set: ExcelApi 1.8]
/// ID of the RowColumnPivotHierarchy. [Api set: ExcelApi 1.8]
/// Name of the RowColumnPivotHierarchy. [Api set: ExcelApi 1.8]
/// Position of the RowColumnPivotHierarchy. [Api set: ExcelApi 1.8]
}
RowColumnPivotHierarchy.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
RowColumnPivotHierarchy.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.RowColumnPivotHierarchyUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing RowColumnPivotHierarchy object, with properties that have already been loaded and synced.
///
}
RowColumnPivotHierarchy.prototype.setToDefault = function() {
///
/// Reset the RowColumnPivotHierarchy back to its default values. [Api set: ExcelApi 1.8]
///
///
}
return RowColumnPivotHierarchy;
})(OfficeExtension.ClientObject);
Excel.RowColumnPivotHierarchy = RowColumnPivotHierarchy;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var RowColumnPivotHierarchyCollection = (function(_super) {
__extends(RowColumnPivotHierarchyCollection, _super);
function RowColumnPivotHierarchyCollection() {
/// Represents a collection of RowColumnPivotHierarchy items associated with the PivotTable. [Api set: ExcelApi 1.8]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
RowColumnPivotHierarchyCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
RowColumnPivotHierarchyCollection.prototype.add = function(pivotHierarchy) {
///
/// 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. [Api set: ExcelApi 1.8]
///
///
}
RowColumnPivotHierarchyCollection.prototype.getCount = function() {
///
/// Gets the number of pivot hierarchies in the collection. [Api set: ExcelApi 1.8]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
RowColumnPivotHierarchyCollection.prototype.getItem = function(name) {
///
/// Gets a RowColumnPivotHierarchy by its name or ID. [Api set: ExcelApi 1.8]
///
/// Name of the RowColumnPivotHierarchy to be retrieved.
///
}
RowColumnPivotHierarchyCollection.prototype.getItemOrNullObject = function(name) {
///
/// Gets a RowColumnPivotHierarchy by name. If the RowColumnPivotHierarchy does not exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.8]
///
/// Name of the RowColumnPivotHierarchy to be retrieved.
///
}
RowColumnPivotHierarchyCollection.prototype.remove = function(rowColumnPivotHierarchy) {
///
/// Removes the PivotHierarchy from the current axis. [Api set: ExcelApi 1.8]
///
///
}
return RowColumnPivotHierarchyCollection;
})(OfficeExtension.ClientObject);
Excel.RowColumnPivotHierarchyCollection = RowColumnPivotHierarchyCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.11]
var RowHiddenChangeType = {
__proto__: null,
"unhidden": "unhidden",
"hidden": "hidden",
}
Excel.RowHiddenChangeType = RowHiddenChangeType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Runtime = (function(_super) {
__extends(Runtime, _super);
function Runtime() {
/// Represents the Excel Runtime class. [Api set: ExcelApi 1.5]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Toggle JavaScript events in the current task pane or content add-in. [Api set: ExcelApi 1.8]
}
Runtime.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Runtime.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.RuntimeUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing Runtime object, with properties that have already been loaded and synced.
///
}
return Runtime;
})(OfficeExtension.ClientObject);
Excel.Runtime = Runtime;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Specifies the save behavior for `Workbook.save`. [Api set: ExcelApi 1.9]
var SaveBehavior = {
__proto__: null,
"save": "save",
"prompt": "prompt",
}
Excel.SaveBehavior = SaveBehavior;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var SearchCriteria = (function() {
function SearchCriteria() {
/// Represents the search criteria to be used. [Api set: ExcelApi 1.9]
/// 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). [Api set: ExcelApi 1.9]
/// Specifies if the match is case-sensitive. Default is `false` (case-insensitive). [Api set: ExcelApi 1.9]
/// Specifies the search direction. Default is forward. See `Excel.SearchDirection`. [Api set: ExcelApi 1.9]
}
return SearchCriteria;
})();
Interfaces.SearchCriteria.__proto__ = null;
Interfaces.SearchCriteria = SearchCriteria;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Specifies the search direction. [Api set: ExcelApi 1.9]
var SearchDirection = {
__proto__: null,
"forward": "forward",
"backwards": "backwards",
}
Excel.SearchDirection = SearchDirection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var SelectionChangedEventArgs = (function() {
function SelectionChangedEventArgs() {
/// Provides information about the document that raised the selection changed event. [Api set: ExcelApi 1.2]
/// Gets the workbook object that raised the selection changed event. [Api set: ExcelApi 1.2]
}
return SelectionChangedEventArgs;
})();
Interfaces.SelectionChangedEventArgs.__proto__ = null;
Interfaces.SelectionChangedEventArgs = SelectionChangedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Setting = (function(_super) {
__extends(Setting, _super);
function Setting() {
/// Setting represents a key-value pair of a setting persisted to the document (per file, per add-in). These custom key-value pair can be used to store state or lifecycle information needed by the content or task-pane add-in. Note that settings are persisted in the document and hence it is not a place to store any sensitive or protected information such as user information and password. [Api set: ExcelApi 1.4]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// The key that represents the ID of the setting. [Api set: ExcelApi 1.4]
/// Represents the value stored for this setting. [Api set: ExcelApi 1.4]
}
Setting.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Setting.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.SettingUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing Setting object, with properties that have already been loaded and synced.
///
}
Setting.prototype.delete = function() {
///
/// Deletes the setting. [Api set: ExcelApi 1.4]
///
///
}
return Setting;
})(OfficeExtension.ClientObject);
Excel.Setting = Setting;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var SettingCollection = (function(_super) {
__extends(SettingCollection, _super);
function SettingCollection() {
/// Represents a collection of key-value pair setting objects that are part of the workbook. The scope is limited to per file and add-in (task-pane or content) combination. [Api set: ExcelApi 1.4]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Occurs when the settings in the document are changed. [Api set: ExcelApi 1.4]
/// Gets the loaded child items in this collection.
}
SettingCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
SettingCollection.prototype.add = function(key, value) {
///
/// Sets or adds the specified setting to the workbook. [Api set: ExcelApi 1.4]
///
/// The key of the new setting.
/// The value for the new setting.
///
}
SettingCollection.prototype.getCount = function() {
///
/// Gets the number of settings in the collection. [Api set: ExcelApi 1.4]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
SettingCollection.prototype.getItem = function(key) {
///
/// Gets a setting entry via the key. [Api set: ExcelApi 1.4]
///
/// Key of the setting.
///
}
SettingCollection.prototype.getItemOrNullObject = function(key) {
///
/// Gets a setting entry via the key. If the setting does not exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.4]
///
/// The key of the setting.
///
}
SettingCollection.prototype.onSettingsChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the setting that raised the settings changed event
///
var eventInfo = new Excel.Interfaces.SettingsChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
return SettingCollection;
})(OfficeExtension.ClientObject);
Excel.SettingCollection = SettingCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var SettingsChangedEventArgs = (function() {
function SettingsChangedEventArgs() {
/// Provides information about the setting that raised the settings changed event [Api set: ExcelApi 1.4]
/// Gets the `Setting` object that represents the binding that raised the settings changed event [Api set: ExcelApi 1.4]
}
return SettingsChangedEventArgs;
})();
Interfaces.SettingsChangedEventArgs.__proto__ = null;
Interfaces.SettingsChangedEventArgs = SettingsChangedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Shape = (function(_super) {
__extends(Shape, _super);
function Shape() {
/// Represents a generic shape object in the worksheet. A shape could be a geometric shape, a line, a group of shapes, etc. To learn more about the shape object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-shapes | Work with shapes using the Excel JavaScript API}. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies the alternative description text for a `Shape` object. [Api set: ExcelApi 1.9]
/// Specifies the alternative title text for a `Shape` object. [Api set: ExcelApi 1.9]
/// Returns the number of connection sites on this shape. [Api set: ExcelApi 1.9]
/// Returns the fill formatting of this shape. [Api set: ExcelApi 1.9]
/// Returns the geometric shape associated with the shape. An error will be thrown if the shape type is not "GeometricShape". [Api set: ExcelApi 1.9]
/// Specifies the geometric shape type of this geometric shape. See `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape". [Api set: ExcelApi 1.9]
/// Returns the shape group associated with the shape. An error will be thrown if the shape type is not "GroupShape". [Api set: ExcelApi 1.9]
/// Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value or zero as an input. [Api set: ExcelApi 1.9]
/// Specifies the shape identifier. [Api set: ExcelApi 1.9]
/// Returns the image associated with the shape. An error will be thrown if the shape type is not "Image". [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9]
/// Returns the line associated with the shape. An error will be thrown if the shape type is not "Line". [Api set: ExcelApi 1.9]
/// Returns the line formatting of this shape. [Api set: ExcelApi 1.9]
/// Specifies if the aspect ratio of this shape is locked. [Api set: ExcelApi 1.9]
/// Specifies the name of the shape. [Api set: ExcelApi 1.9]
/// Specifies the parent group of this shape. [Api set: ExcelApi 1.9]
/// Represents how the object is attached to the cells below it. [Api set: ExcelApi 1.10]
/// Specifies the rotation, in degrees, of the shape. [Api set: ExcelApi 1.9]
/// Returns the text frame object of this shape. Read only. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9]
/// Returns the type of this shape. See `Excel.ShapeType` for details. [Api set: ExcelApi 1.9]
/// Specifies if the shape is visible. [Api set: ExcelApi 1.9]
/// Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value or zero as an input. [Api set: ExcelApi 1.9]
/// Returns the position of the specified shape in the z-order, with 0 representing the bottom of the order stack. [Api set: ExcelApi 1.9]
/// Occurs when the shape is activated. [Api set: ExcelApi 1.9]
/// Occurs when the shape is deactivated. [Api set: ExcelApi 1.9]
}
Shape.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Shape.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ShapeUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing Shape object, with properties that have already been loaded and synced.
///
}
Shape.prototype.copyTo = function(destinationSheet) {
///
/// Copies and pastes a `Shape` object. The pasted shape is copied to the same pixel location as this shape. [Api set: ExcelApi 1.10]
///
/// The sheet to which the shape object will be pasted. The default value is the copied shape's worksheet.
///
}
Shape.prototype.delete = function() {
///
/// Removes the shape from the worksheet. [Api set: ExcelApi 1.9]
///
///
}
Shape.prototype.getAsImage = function(format) {
///
/// Converts the shape to an image and returns the image as a base64-encoded string. The DPI is 96. The only supported formats are `Excel.PictureFormat.BMP`, `Excel.PictureFormat.PNG`, `Excel.PictureFormat.JPEG`, and `Excel.PictureFormat.GIF`. [Api set: ExcelApi 1.9]
///
/// Specifies the format of the image.
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = '';
return result;
}
Shape.prototype.incrementLeft = function(increment) {
///
/// Moves the shape horizontally by the specified number of points. [Api set: ExcelApi 1.9]
///
/// 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.
///
}
Shape.prototype.incrementRotation = function(increment) {
///
/// 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. [Api set: ExcelApi 1.9]
///
/// How many degrees the shape will be rotated. A positive value rotates the shape clockwise and a negative value rotates it counterclockwise.
///
}
Shape.prototype.incrementTop = function(increment) {
///
/// Moves the shape vertically by the specified number of points. [Api set: ExcelApi 1.9]
///
/// The increment, in points, the shape will be vertically moved. A positive value moves the shape down and a negative value moves it up.
///
}
Shape.prototype.scaleHeight = function(scaleFactor, scaleType, scaleFrom) {
///
/// 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. [Api set: ExcelApi 1.9]
///
/// Specifies the ratio between the height of the shape after you resize it and the current or original height.
/// Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images.
/// 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.
///
}
Shape.prototype.scaleWidth = function(scaleFactor, scaleType, scaleFrom) {
///
/// 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. [Api set: ExcelApi 1.9]
///
/// Specifies the ratio between the width of the shape after you resize it and the current or original width.
/// Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images.
/// 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.
///
}
Shape.prototype.setZOrder = function(position) {
///
/// Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes. [Api set: ExcelApi 1.9]
///
/// Where to move the shape in the z-order stack relative to the other shapes. See `Excel.ShapeZOrder` for details.
///
}
Shape.prototype.onActivated = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the shape that raised the activated event.
///
var eventInfo = new Excel.Interfaces.ShapeActivatedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
Shape.prototype.onDeactivated = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the shape that raised the deactivated event.
///
var eventInfo = new Excel.Interfaces.ShapeDeactivatedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
return Shape;
})(OfficeExtension.ClientObject);
Excel.Shape = Shape;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ShapeActivatedEventArgs = (function() {
function ShapeActivatedEventArgs() {
/// Provides information about the shape that raised the activated event. [Api set: ExcelApi 1.9]
/// Gets the ID of the activated shape. [Api set: ExcelApi 1.9]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.9]
/// Gets the ID of the worksheet in which the shape is activated. [Api set: ExcelApi 1.9]
}
return ShapeActivatedEventArgs;
})();
Interfaces.ShapeActivatedEventArgs.__proto__ = null;
Interfaces.ShapeActivatedEventArgs = ShapeActivatedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Determines the type of automatic sizing allowed. [Api set: ExcelApi 1.9]
var ShapeAutoSize = {
__proto__: null,
"autoSizeNone": "autoSizeNone",
"autoSizeTextToFitShape": "autoSizeTextToFitShape",
"autoSizeShapeToFitText": "autoSizeShapeToFitText",
"autoSizeMixed": "autoSizeMixed",
}
Excel.ShapeAutoSize = ShapeAutoSize;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ShapeCollection = (function(_super) {
__extends(ShapeCollection, _super);
function ShapeCollection() {
/// Represents a collection of all the shapes in the worksheet. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
ShapeCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ShapeCollection.prototype.addGeometricShape = function(geometricShapeType) {
///
/// Adds a geometric shape to the worksheet. Returns a `Shape` object that represents the new shape. [Api set: ExcelApi 1.9]
///
/// Represents the type of the geometric shape. See `Excel.GeometricShapeType` for details.
///
}
ShapeCollection.prototype.addGroup = function(values) {
///
/// Groups a subset of shapes in this collection's worksheet. Returns a `Shape` object that represents the new group of shapes. [Api set: ExcelApi 1.9]
///
/// An array of shape IDs or shape objects.
///
}
ShapeCollection.prototype.addImage = function(base64ImageString) {
///
/// Creates an image from a base64-encoded string and adds it to the worksheet. Returns the `Shape` object that represents the new image. [Api set: ExcelApi 1.9]
///
/// A base64-encoded string representing an image in either JPEG or PNG format.
///
}
ShapeCollection.prototype.addLine = function(startLeft, startTop, endLeft, endTop, connectorType) {
///
/// Adds a line to worksheet. Returns a `Shape` object that represents the new line. [Api set: ExcelApi 1.9]
///
/// The distance, in points, from the start of the line to the left side of the worksheet.
/// The distance, in points, from the start of the line to the top of the worksheet.
/// The distance, in points, from the end of the line to the left of the worksheet.
/// The distance, in points, from the end of the line to the top of the worksheet.
/// Represents the connector type. See `Excel.ConnectorType` for details.
///
}
ShapeCollection.prototype.addTextBox = function(text) {
///
/// Adds a text box to the worksheet with the provided text as the content. Returns a `Shape` object that represents the new text box. [Api set: ExcelApi 1.9]
///
/// Represents the text that will be shown in the created text box.
///
}
ShapeCollection.prototype.getCount = function() {
///
/// Returns the number of shapes in the worksheet. [Api set: ExcelApi 1.9]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
ShapeCollection.prototype.getItem = function(key) {
///
/// Gets a shape using its name or ID. [Api set: ExcelApi 1.9]
///
/// Name or ID of the shape to be retrieved.
///
}
ShapeCollection.prototype.getItemAt = function(index) {
///
/// Gets a shape using its position in the collection. [Api set: ExcelApi 1.9]
///
/// The zero-based index of the shape to be retrieved.
///
}
ShapeCollection.prototype.getItemOrNullObject = function(key) {
///
/// Gets a shape using its name or ID. If the shape object does not exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.14]
///
/// Name or ID of the shape to retrieved.
///
}
return ShapeCollection;
})(OfficeExtension.ClientObject);
Excel.ShapeCollection = ShapeCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ShapeDeactivatedEventArgs = (function() {
function ShapeDeactivatedEventArgs() {
/// Provides information about the shape that raised the deactivated event. [Api set: ExcelApi 1.9]
/// Gets the ID of the shape deactivated shape. [Api set: ExcelApi 1.9]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.9]
/// Gets the ID of the worksheet in which the shape is deactivated. [Api set: ExcelApi 1.9]
}
return ShapeDeactivatedEventArgs;
})();
Interfaces.ShapeDeactivatedEventArgs.__proto__ = null;
Interfaces.ShapeDeactivatedEventArgs = ShapeDeactivatedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ShapeFill = (function(_super) {
__extends(ShapeFill, _super);
function ShapeFill() {
/// Represents the fill formatting of a shape object. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// 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") [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9]
/// Returns the fill type of the shape. See `Excel.ShapeFillType` for details. [Api set: ExcelApi 1.9]
}
ShapeFill.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ShapeFill.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ShapeFillUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ShapeFill object, with properties that have already been loaded and synced.
///
}
ShapeFill.prototype.clear = function() {
///
/// Clears the fill formatting of this shape. [Api set: ExcelApi 1.9]
///
///
}
ShapeFill.prototype.setSolidColor = function(color) {
///
/// Sets the fill formatting of the shape to a uniform color. This changes the fill type to "Solid". [Api set: ExcelApi 1.9]
///
/// 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").
///
}
return ShapeFill;
})(OfficeExtension.ClientObject);
Excel.ShapeFill = ShapeFill;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Specifies a shape's fill type. [Api set: ExcelApi 1.9]
var ShapeFillType = {
__proto__: null,
"noFill": "noFill",
"solid": "solid",
"gradient": "gradient",
"pattern": "pattern",
"pictureAndTexture": "pictureAndTexture",
"mixed": "mixed",
}
Excel.ShapeFillType = ShapeFillType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ShapeFont = (function(_super) {
__extends(ShapeFont, _super);
function ShapeFont() {
/// Represents the font attributes, such as font name, font size, and color, for a shape's `TextRange` object. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments. [Api set: ExcelApi 1.9]
/// HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors. [Api set: ExcelApi 1.9]
/// Represents the italic status of font. Returns `null` if the `TextRange` includes both italic and non-italic text fragments. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9]
/// Represents font size in points (e.g., 11). Returns `null` if the `TextRange` includes text fragments with different font sizes. [Api set: ExcelApi 1.9]
/// Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See `Excel.ShapeFontUnderlineStyle` for details. [Api set: ExcelApi 1.9]
}
ShapeFont.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ShapeFont.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ShapeFontUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ShapeFont object, with properties that have already been loaded and synced.
///
}
return ShapeFont;
})(OfficeExtension.ClientObject);
Excel.ShapeFont = ShapeFont;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// The type of underline applied to a font. [Api set: ExcelApi 1.9]
var ShapeFontUnderlineStyle = {
__proto__: null,
"none": "none",
"single": "single",
"double": "double",
"heavy": "heavy",
"dotted": "dotted",
"dottedHeavy": "dottedHeavy",
"dash": "dash",
"dashHeavy": "dashHeavy",
"dashLong": "dashLong",
"dashLongHeavy": "dashLongHeavy",
"dotDash": "dotDash",
"dotDashHeavy": "dotDashHeavy",
"dotDotDash": "dotDotDash",
"dotDotDashHeavy": "dotDotDashHeavy",
"wavy": "wavy",
"wavyHeavy": "wavyHeavy",
"wavyDouble": "wavyDouble",
}
Excel.ShapeFontUnderlineStyle = ShapeFontUnderlineStyle;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ShapeGroup = (function(_super) {
__extends(ShapeGroup, _super);
function ShapeGroup() {
/// Represents a shape group inside a worksheet. To get the corresponding `Shape` object, use `ShapeGroup.shape`. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies the shape identifier. [Api set: ExcelApi 1.9]
/// Returns the `Shape` object associated with the group. [Api set: ExcelApi 1.9]
/// Returns the collection of `Shape` objects. [Api set: ExcelApi 1.9]
}
ShapeGroup.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ShapeGroup.prototype.ungroup = function() {
///
/// Ungroups any grouped shapes in the specified shape group. [Api set: ExcelApi 1.9]
///
///
}
return ShapeGroup;
})(OfficeExtension.ClientObject);
Excel.ShapeGroup = ShapeGroup;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// The dash style for a line. [Api set: ExcelApi 1.9]
var ShapeLineDashStyle = {
__proto__: null,
"dash": "dash",
"dashDot": "dashDot",
"dashDotDot": "dashDotDot",
"longDash": "longDash",
"longDashDot": "longDashDot",
"roundDot": "roundDot",
"solid": "solid",
"squareDot": "squareDot",
"longDashDotDot": "longDashDotDot",
"systemDash": "systemDash",
"systemDot": "systemDot",
"systemDashDot": "systemDashDot",
}
Excel.ShapeLineDashStyle = ShapeLineDashStyle;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var ShapeLineFormat = (function(_super) {
__extends(ShapeLineFormat, _super);
function ShapeLineFormat() {
/// Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). [Api set: ExcelApi 1.9]
/// Represents the line style of the shape. Returns `null` when the line is not visible or there are inconsistent dash styles. See `Excel.ShapeLineDashStyle` for details. [Api set: ExcelApi 1.9]
/// Represents the line style of the shape. Returns `null` when the line is not visible or there are inconsistent styles. See `Excel.ShapeLineStyle` for details. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9]
/// Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent visibilities. [Api set: ExcelApi 1.9]
/// Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights. [Api set: ExcelApi 1.9]
}
ShapeLineFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ShapeLineFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.ShapeLineFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ShapeLineFormat object, with properties that have already been loaded and synced.
///
}
return ShapeLineFormat;
})(OfficeExtension.ClientObject);
Excel.ShapeLineFormat = ShapeLineFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// The style for a line. [Api set: ExcelApi 1.9]
var ShapeLineStyle = {
__proto__: null,
"single": "single",
"thickBetweenThin": "thickBetweenThin",
"thickThin": "thickThin",
"thinThick": "thinThick",
"thinThin": "thinThin",
}
Excel.ShapeLineStyle = ShapeLineStyle;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Specifies which part of the shape retains its position when the shape is scaled. [Api set: ExcelApi 1.9]
var ShapeScaleFrom = {
__proto__: null,
"scaleFromTopLeft": "scaleFromTopLeft",
"scaleFromMiddle": "scaleFromMiddle",
"scaleFromBottomRight": "scaleFromBottomRight",
}
Excel.ShapeScaleFrom = ShapeScaleFrom;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Specifies whether the shape is scaled relative to its original or current size. [Api set: ExcelApi 1.9]
var ShapeScaleType = {
__proto__: null,
"currentSize": "currentSize",
"originalSize": "originalSize",
}
Excel.ShapeScaleType = ShapeScaleType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Specifies the horizontal alignment for the text frame in a shape. [Api set: ExcelApi 1.9]
var ShapeTextHorizontalAlignment = {
__proto__: null,
"left": "left",
"center": "center",
"right": "right",
"justify": "justify",
"justifyLow": "justifyLow",
"distributed": "distributed",
"thaiDistributed": "thaiDistributed",
}
Excel.ShapeTextHorizontalAlignment = ShapeTextHorizontalAlignment;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Specifies the horizontal overflow for the text frame in a shape. [Api set: ExcelApi 1.9]
var ShapeTextHorizontalOverflow = {
__proto__: null,
"overflow": "overflow",
"clip": "clip",
}
Excel.ShapeTextHorizontalOverflow = ShapeTextHorizontalOverflow;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Specifies the orientation for the text frame in a shape. [Api set: ExcelApi 1.9]
var ShapeTextOrientation = {
__proto__: null,
"horizontal": "horizontal",
"vertical": "vertical",
"vertical270": "vertical270",
"wordArtVertical": "wordArtVertical",
"eastAsianVertical": "eastAsianVertical",
"mongolianVertical": "mongolianVertical",
"wordArtVerticalRTL": "wordArtVerticalRTL",
}
Excel.ShapeTextOrientation = ShapeTextOrientation;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Specifies the reading order for the text frame in a shape. [Api set: ExcelApi 1.9]
var ShapeTextReadingOrder = {
__proto__: null,
"leftToRight": "leftToRight",
"rightToLeft": "rightToLeft",
}
Excel.ShapeTextReadingOrder = ShapeTextReadingOrder;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Specifies the vertical alignment for the text frame in a shape. [Api set: ExcelApi 1.9]
var ShapeTextVerticalAlignment = {
__proto__: null,
"top": "top",
"middle": "middle",
"bottom": "bottom",
"justified": "justified",
"distributed": "distributed",
}
Excel.ShapeTextVerticalAlignment = ShapeTextVerticalAlignment;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Specifies the vertical overflow for the text frame in a shape. [Api set: ExcelApi 1.9]
var ShapeTextVerticalOverflow = {
__proto__: null,
"overflow": "overflow",
"ellipsis": "ellipsis",
"clip": "clip",
}
Excel.ShapeTextVerticalOverflow = ShapeTextVerticalOverflow;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Specifies the type of a shape. [Api set: ExcelApi 1.9]
var ShapeType = {
__proto__: null,
"unsupported": "unsupported",
"image": "image",
"geometricShape": "geometricShape",
"group": "group",
"line": "line",
}
Excel.ShapeType = ShapeType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Specifies where in the z-order a shape should be moved relative to other shapes. [Api set: ExcelApi 1.9]
var ShapeZOrder = {
__proto__: null,
"bringToFront": "bringToFront",
"bringForward": "bringForward",
"sendToBack": "sendToBack",
"sendBackward": "sendBackward",
}
Excel.ShapeZOrder = ShapeZOrder;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.1]
var SheetVisibility = {
__proto__: null,
"visible": "visible",
"hidden": "hidden",
"veryHidden": "veryHidden",
}
Excel.SheetVisibility = SheetVisibility;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// The ShowAs calculation function for the DataPivotField. [Api set: ExcelApi 1.8]
var ShowAsCalculation = {
__proto__: null,
"unknown": "unknown",
"none": "none",
"percentOfGrandTotal": "percentOfGrandTotal",
"percentOfRowTotal": "percentOfRowTotal",
"percentOfColumnTotal": "percentOfColumnTotal",
"percentOfParentRowTotal": "percentOfParentRowTotal",
"percentOfParentColumnTotal": "percentOfParentColumnTotal",
"percentOfParentTotal": "percentOfParentTotal",
"percentOf": "percentOf",
"runningTotal": "runningTotal",
"percentRunningTotal": "percentRunningTotal",
"differenceFrom": "differenceFrom",
"percentDifferenceFrom": "percentDifferenceFrom",
"rankAscending": "rankAscending",
"rankDecending": "rankDecending",
"index": "index",
}
Excel.ShowAsCalculation = ShowAsCalculation;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ShowAsRule = (function() {
function ShowAsRule() {
/// [Api set: ExcelApi 1.8]
/// The PivotField to base the `ShowAs` calculation on, if applicable according to the `ShowAsCalculation` type, else `null`. [Api set: ExcelApi 1.8]
/// The item to base the `ShowAs` calculation on, if applicable according to the `ShowAsCalculation` type, else `null`. [Api set: ExcelApi 1.8]
/// The `ShowAs` calculation to use for the PivotField. See `Excel.ShowAsCalculation` for details. [Api set: ExcelApi 1.8]
}
return ShowAsRule;
})();
Interfaces.ShowAsRule.__proto__ = null;
Interfaces.ShowAsRule = ShowAsRule;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Slicer = (function(_super) {
__extends(Slicer, _super);
function Slicer() {
/// Represents a `Slicer` object in the workbook. [Api set: ExcelApi 1.10]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the caption of the slicer. [Api set: ExcelApi 1.10]
/// Represents the height, in points, of the slicer. Throws an `InvalidArgument` exception when set with a negative value or zero as an input. [Api set: ExcelApi 1.10]
/// Represents the unique ID of the slicer. [Api set: ExcelApi 1.10]
/// Value is `true` if all filters currently applied on the slicer are cleared. [Api set: ExcelApi 1.10]
/// 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. [Api set: ExcelApi 1.10]
/// Represents the name of the slicer. [Api set: ExcelApi 1.10]
/// Represents the collection of slicer items that are part of the slicer. [Api set: ExcelApi 1.10]
/// Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending". [Api set: ExcelApi 1.10]
/// 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. [Api set: ExcelApi 1.10]
/// 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. [Api set: ExcelApi 1.10]
/// Represents the width, in points, of the slicer. Throws an `InvalidArgument` error when set with a negative value or zero as an input. [Api set: ExcelApi 1.10]
/// Represents the worksheet containing the slicer. [Api set: ExcelApi 1.10]
}
Slicer.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Slicer.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.SlicerUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing Slicer object, with properties that have already been loaded and synced.
///
}
Slicer.prototype.clearFilters = function() {
///
/// Clears all the filters currently applied on the slicer. [Api set: ExcelApi 1.10]
///
///
}
Slicer.prototype.delete = function() {
///
/// Deletes the slicer. [Api set: ExcelApi 1.10]
///
///
}
Slicer.prototype.getSelectedItems = function() {
///
/// Returns an array of selected items' keys. [Api set: ExcelApi 1.10]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = [];
return result;
}
Slicer.prototype.selectItems = function(items) {
///
/// Selects slicer items based on their keys. The previous selections are cleared. All items will be selected by default if the array is empty. [Api set: ExcelApi 1.10]
///
/// Optional. The specified slicer item names to be selected.
///
}
return Slicer;
})(OfficeExtension.ClientObject);
Excel.Slicer = Slicer;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var SlicerCollection = (function(_super) {
__extends(SlicerCollection, _super);
function SlicerCollection() {
/// Represents a collection of all the slicer objects in the workbook or a worksheet. [Api set: ExcelApi 1.10]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
SlicerCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
SlicerCollection.prototype.add = function(slicerSource, sourceField, slicerDestination) {
///
/// Adds a new slicer to the workbook. [Api set: ExcelApi 1.10]
///
/// 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.
/// 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`.
/// 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.
/// The new slicer.
}
SlicerCollection.prototype.getCount = function() {
///
/// Returns the number of slicers in the collection. [Api set: ExcelApi 1.10]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
SlicerCollection.prototype.getItem = function(key) {
///
/// Gets a slicer object using its name or ID. [Api set: ExcelApi 1.10]
///
/// The name or ID of the slicer.
///
}
SlicerCollection.prototype.getItemAt = function(index) {
///
/// Gets a slicer based on its position in the collection. [Api set: ExcelApi 1.10]
///
/// Index value of the object to be retrieved. Zero-indexed.
///
}
SlicerCollection.prototype.getItemOrNullObject = function(key) {
///
/// Gets a slicer using its name or ID. If the slicer doesn't exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.10]
///
/// Name or ID of the slicer to be retrieved.
///
}
return SlicerCollection;
})(OfficeExtension.ClientObject);
Excel.SlicerCollection = SlicerCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var SlicerItem = (function(_super) {
__extends(SlicerItem, _super);
function SlicerItem() {
/// Represents a slicer item in a slicer. [Api set: ExcelApi 1.10]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Value is `true` if the slicer item has data. [Api set: ExcelApi 1.10]
/// 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. [Api set: ExcelApi 1.10]
/// Represents the unique value representing the slicer item. [Api set: ExcelApi 1.10]
/// Represents the title displayed in the Excel UI. [Api set: ExcelApi 1.10]
}
SlicerItem.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
SlicerItem.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.SlicerItemUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing SlicerItem object, with properties that have already been loaded and synced.
///
}
return SlicerItem;
})(OfficeExtension.ClientObject);
Excel.SlicerItem = SlicerItem;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var SlicerItemCollection = (function(_super) {
__extends(SlicerItemCollection, _super);
function SlicerItemCollection() {
/// Represents a collection of all the slicer item objects in the slicer. [Api set: ExcelApi 1.10]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
SlicerItemCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
SlicerItemCollection.prototype.getCount = function() {
///
/// Returns the number of slicer items in the slicer. [Api set: ExcelApi 1.10]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
SlicerItemCollection.prototype.getItem = function(key) {
///
/// Gets a slicer item object using its key or name. [Api set: ExcelApi 1.10]
///
/// The key or name of the slicer item.
///
}
SlicerItemCollection.prototype.getItemAt = function(index) {
///
/// Gets a slicer item based on its position in the collection. [Api set: ExcelApi 1.10]
///
/// Index value of the object to be retrieved. Zero-indexed.
///
}
SlicerItemCollection.prototype.getItemOrNullObject = function(key) {
///
/// Gets a slicer item using its key or name. If the slicer item doesn't exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.10]
///
/// Key or name of the slicer to be retrieved.
///
}
return SlicerItemCollection;
})(OfficeExtension.ClientObject);
Excel.SlicerItemCollection = SlicerItemCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Specifies the slicer sort behavior for `Slicer.sortBy`. [Api set: ExcelApi 1.10]
var SlicerSortType = {
__proto__: null,
"dataSourceOrder": "dataSourceOrder",
"ascending": "ascending",
"descending": "descending",
}
Excel.SlicerSortType = SlicerSortType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var SlicerStyle = (function(_super) {
__extends(SlicerStyle, _super);
function SlicerStyle() {
/// Represents a slicer style, which defines style elements by region of the slicer. [Api set: ExcelApi 1.10]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the name of the slicer style. [Api set: ExcelApi 1.10]
/// Specifies if this `SlicerStyle` object is read-only. [Api set: ExcelApi 1.10]
}
SlicerStyle.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
SlicerStyle.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.SlicerStyleUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing SlicerStyle object, with properties that have already been loaded and synced.
///
}
SlicerStyle.prototype.delete = function() {
///
/// Deletes the slicer style. [Api set: ExcelApi 1.10]
///
///
}
SlicerStyle.prototype.duplicate = function() {
///
/// Creates a duplicate of this slicer style with copies of all the style elements. [Api set: ExcelApi 1.10]
///
/// The new `SlicerStyle` object that has been duplicated from this slicer style.
}
return SlicerStyle;
})(OfficeExtension.ClientObject);
Excel.SlicerStyle = SlicerStyle;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var SlicerStyleCollection = (function(_super) {
__extends(SlicerStyleCollection, _super);
function SlicerStyleCollection() {
/// Represents a collection of `SlicerStyle` objects. [Api set: ExcelApi 1.10]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
SlicerStyleCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
SlicerStyleCollection.prototype.add = function(name, makeUniqueName) {
///
/// Creates a blank slicer style with the specified name. [Api set: ExcelApi 1.10]
///
/// The unique name for the new slicer style. Will throw an `InvalidArgument` exception if the name is already in use.
/// Optional. Defaults to `false`. If `true`, will append numbers to the name in order to make it unique, if needed.
/// The newly created `SlicerStyle`.
}
SlicerStyleCollection.prototype.getCount = function() {
///
/// Gets the number of slicer styles in the collection. [Api set: ExcelApi 1.10]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
SlicerStyleCollection.prototype.getDefault = function() {
///
/// Gets the default `SlicerStyle` for the parent object's scope. [Api set: ExcelApi 1.10]
///
/// The `SlicerStyle` object that is the current default slicer style.
}
SlicerStyleCollection.prototype.getItem = function(name) {
///
/// Gets a `SlicerStyle` by name. [Api set: ExcelApi 1.10]
///
/// Name of the slicer style to be retrieved.
/// The `SlicerStyle` object whose name matches the input.
}
SlicerStyleCollection.prototype.getItemOrNullObject = function(name) {
///
/// Gets a `SlicerStyle` by name. If the slicer style doesn't exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.10]
///
/// Name of the slicer style to be retrieved.
/// The `SlicerStyle` object whose name matches the input.
}
SlicerStyleCollection.prototype.setDefault = function(newDefaultStyle) {
///
/// Sets the default slicer style for use in the parent object's scope. [Api set: ExcelApi 1.10]
///
/// The `SlicerStyle` object, or name of the `SlicerStyle` object, that should be the new default.
///
}
return SlicerStyleCollection;
})(OfficeExtension.ClientObject);
Excel.SlicerStyleCollection = SlicerStyleCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the sort direction. [Api set: ExcelApi 1.8]
var SortBy = {
__proto__: null,
"ascending": "ascending",
"descending": "descending",
}
Excel.SortBy = SortBy;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.2]
var SortDataOption = {
__proto__: null,
"normal": "normal",
"textAsNumber": "textAsNumber",
}
Excel.SortDataOption = SortDataOption;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var SortField = (function() {
function SortField() {
/// Represents a condition in a sorting operation. [Api set: ExcelApi 1.2]
/// Specifies if the sorting is done in an ascending fashion. [Api set: ExcelApi 1.2]
/// Specifies the color that is the target of the condition if the sorting is on font or cell color. [Api set: ExcelApi 1.2]
/// Represents additional sorting options for this field. [Api set: ExcelApi 1.2]
/// Specifies the icon that is the target of the condition, if the sorting is on the cell's icon. [Api set: ExcelApi 1.2]
/// 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). [Api set: ExcelApi 1.2]
/// Specifies the type of sorting of this condition. [Api set: ExcelApi 1.2]
/// Specifies the subfield that is the target property name of a rich value to sort on. [Api set: ExcelApi 1.9]
}
return SortField;
})();
Interfaces.SortField.__proto__ = null;
Interfaces.SortField = SortField;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.2]
var SortMethod = {
__proto__: null,
"pinYin": "pinYin",
"strokeCount": "strokeCount",
}
Excel.SortMethod = SortMethod;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.2]
var SortOn = {
__proto__: null,
"value": "value",
"cellColor": "cellColor",
"fontColor": "fontColor",
"icon": "icon",
}
Excel.SortOn = SortOn;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.2]
var SortOrientation = {
__proto__: null,
"rows": "rows",
"columns": "columns",
}
Excel.SortOrientation = SortOrientation;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.9]
var SpecialCellType = {
__proto__: null,
"conditionalFormats": "conditionalFormats",
"dataValidations": "dataValidations",
"blanks": "blanks",
"constants": "constants",
"formulas": "formulas",
"sameConditionalFormat": "sameConditionalFormat",
"sameDataValidation": "sameDataValidation",
"visible": "visible",
}
Excel.SpecialCellType = SpecialCellType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.9]
var SpecialCellValueType = {
__proto__: null,
"all": "all",
"errors": "errors",
"errorsLogical": "errorsLogical",
"errorsNumbers": "errorsNumbers",
"errorsText": "errorsText",
"errorsLogicalNumber": "errorsLogicalNumber",
"errorsLogicalText": "errorsLogicalText",
"errorsNumberText": "errorsNumberText",
"logical": "logical",
"logicalNumbers": "logicalNumbers",
"logicalText": "logicalText",
"logicalNumbersText": "logicalNumbersText",
"numbers": "numbers",
"numbersText": "numbersText",
"text": "text",
}
Excel.SpecialCellValueType = SpecialCellValueType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Style = (function(_super) {
__extends(Style, _super);
function Style() {
/// An object encapsulating a style's format and other properties. [Api set: ExcelApi 1.7]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies if text is automatically indented when the text alignment in a cell is set to equal distribution. [Api set: ExcelApi 1.8]
/// A collection of four border objects that represent the style of the four borders. [Api set: ExcelApi 1.7]
/// Specifies if the style is a built-in style. [Api set: ExcelApi 1.7]
/// The fill of the style. [Api set: ExcelApi 1.7]
/// A `Font` object that represents the font of the style. [Api set: ExcelApi 1.7]
/// Specifies if the formula will be hidden when the worksheet is protected. [Api set: ExcelApi 1.7]
/// Represents the horizontal alignment for the style. See `Excel.HorizontalAlignment` for details. [Api set: ExcelApi 1.7]
/// Specifies if the style includes the auto indent, horizontal alignment, vertical alignment, wrap text, indent level, and text orientation properties. [Api set: ExcelApi 1.7]
/// Specifies if the style includes the color, color index, line style, and weight border properties. [Api set: ExcelApi 1.7]
/// Specifies if the style includes the background, bold, color, color index, font style, italic, name, size, strikethrough, subscript, superscript, and underline font properties. [Api set: ExcelApi 1.7]
/// Specifies if the style includes the number format property. [Api set: ExcelApi 1.7]
/// Specifies if the style includes the color, color index, invert if negative, pattern, pattern color, and pattern color index interior properties. [Api set: ExcelApi 1.7]
/// Specifies if the style includes the formula hidden and locked protection properties. [Api set: ExcelApi 1.7]
/// An integer from 0 to 250 that indicates the indent level for the style. [Api set: ExcelApi 1.7]
/// Specifies if the object is locked when the worksheet is protected. [Api set: ExcelApi 1.7]
/// The name of the style. [Api set: ExcelApi 1.7]
/// The format code of the number format for the style. [Api set: ExcelApi 1.7]
/// The localized format code of the number format for the style. [Api set: ExcelApi 1.7]
/// The reading order for the style. [Api set: ExcelApi 1.7]
/// Specifies if text automatically shrinks to fit in the available column width. [Api set: ExcelApi 1.7]
/// The text orientation for the style. [Api set: ExcelApi 1.8]
/// Specifies the vertical alignment for the style. See `Excel.VerticalAlignment` for details. [Api set: ExcelApi 1.7]
/// Specifies if Excel wraps the text in the object. [Api set: ExcelApi 1.7]
}
Style.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Style.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.StyleUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing Style object, with properties that have already been loaded and synced.
///
}
Style.prototype.delete = function() {
///
/// Deletes this style. [Api set: ExcelApi 1.7]
///
///
}
return Style;
})(OfficeExtension.ClientObject);
Excel.Style = Style;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var StyleCollection = (function(_super) {
__extends(StyleCollection, _super);
function StyleCollection() {
/// Represents a collection of all the styles. [Api set: ExcelApi 1.7]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
StyleCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
StyleCollection.prototype.add = function(name) {
///
/// Adds a new style to the collection. [Api set: ExcelApi 1.7]
///
/// Name of the style to be added.
///
}
StyleCollection.prototype.getCount = function() {
///
/// Gets the number of styles in the collection. [Api set: ExcelApi 1.9]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
StyleCollection.prototype.getItem = function(name) {
///
/// Gets a `Style` by name. [Api set: ExcelApi 1.7]
///
/// Name of the style to be retrieved.
///
}
StyleCollection.prototype.getItemAt = function(index) {
///
/// Gets a style based on its position in the collection. [Api set: ExcelApi 1.9]
///
/// Index value of the style object to be retrieved. Zero-indexed.
///
}
StyleCollection.prototype.getItemOrNullObject = function(name) {
///
/// Gets a style by name. If the style object does not exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.14]
///
/// Name of the style to be retrieved.
///
}
return StyleCollection;
})(OfficeExtension.ClientObject);
Excel.StyleCollection = StyleCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.8]
var SubtotalLocationType = {
__proto__: null,
"atTop": "atTop",
"atBottom": "atBottom",
"off": "off",
}
Excel.SubtotalLocationType = SubtotalLocationType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var Subtotals = (function() {
function Subtotals() {
/// Subtotals for the Pivot Field. [Api set: ExcelApi 1.8]
/// If `Automatic` is set to `true`, then all other values will be ignored when setting the `Subtotals`. [Api set: ExcelApi 1.8]
/// [Api set: ExcelApi 1.8]
/// [Api set: ExcelApi 1.8]
/// [Api set: ExcelApi 1.8]
/// [Api set: ExcelApi 1.8]
/// [Api set: ExcelApi 1.8]
/// [Api set: ExcelApi 1.8]
/// [Api set: ExcelApi 1.8]
/// [Api set: ExcelApi 1.8]
/// [Api set: ExcelApi 1.8]
/// [Api set: ExcelApi 1.8]
/// [Api set: ExcelApi 1.8]
}
return Subtotals;
})();
Interfaces.Subtotals.__proto__ = null;
Interfaces.Subtotals = Subtotals;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Table = (function(_super) {
__extends(Table, _super);
function Table() {
/// Represents an Excel table. To learn more about the table object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-tables | Work with tables using the Excel JavaScript API}. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the `AutoFilter` object of the table. [Api set: ExcelApi 1.9]
/// Represents a collection of all the columns in the table. [Api set: ExcelApi 1.1]
/// Specifies if the first column contains special formatting. [Api set: ExcelApi 1.3]
/// Specifies if the last column contains special formatting. [Api set: ExcelApi 1.3]
/// 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. [Api set: ExcelApi 1.1]
/// Returns a numeric ID. [Api set: ExcelApi 1.8]
/// Name of the table. The set name of the table must follow the guidelines specified in the {@link https://support.office.com/article/Rename-an-Excel-table-FBF49A4F-82A3-43EB-8BA2-44D21233B114 | Rename an Excel table} article. [Api set: ExcelApi 1.1]
/// Represents a collection of all the rows in the table. [Api set: ExcelApi 1.1]
/// Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier. [Api set: ExcelApi 1.3]
/// Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier. [Api set: ExcelApi 1.3]
/// 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. [Api set: ExcelApi 1.3]
/// Specifies if the header row is visible. This value can be set to show or remove the header row. [Api set: ExcelApi 1.1]
/// Specifies if the total row is visible. This value can be set to show or remove the total row. [Api set: ExcelApi 1.1]
/// Represents the sorting for the table. [Api set: ExcelApi 1.2]
/// 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. [Api set: ExcelApi 1.1]
/// The worksheet containing the current table. [Api set: ExcelApi 1.2]
/// Occurs when data in cells changes on a specific table. [Api set: ExcelApi 1.7]
/// Occurs when the selection changes on a specific table. [Api set: ExcelApi 1.7]
}
Table.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Table.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.TableUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing Table object, with properties that have already been loaded and synced.
///
}
Table.prototype.clearFilters = function() {
///
/// Clears all the filters currently applied on the table. [Api set: ExcelApi 1.2]
///
///
}
Table.prototype.convertToRange = function() {
///
/// Converts the table into a normal range of cells. All data is preserved. [Api set: ExcelApi 1.2]
///
///
}
Table.prototype.delete = function() {
///
/// Deletes the table. [Api set: ExcelApi 1.1]
///
///
}
Table.prototype.getDataBodyRange = function() {
///
/// Gets the range object associated with the data body of the table. [Api set: ExcelApi 1.1]
///
///
}
Table.prototype.getHeaderRowRange = function() {
///
/// Gets the range object associated with the header row of the table. [Api set: ExcelApi 1.1]
///
///
}
Table.prototype.getRange = function() {
///
/// Gets the range object associated with the entire table. [Api set: ExcelApi 1.1]
///
///
}
Table.prototype.getTotalRowRange = function() {
///
/// Gets the range object associated with the totals row of the table. [Api set: ExcelApi 1.1]
///
///
}
Table.prototype.reapplyFilters = function() {
///
/// Reapplies all the filters currently on the table. [Api set: ExcelApi 1.2]
///
///
}
Table.prototype.resize = function(newRange) {
///
/// 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. [Api set: ExcelApi 1.13]
///
/// The range object or range address that will be used to determine the new size of the table.
///
}
Table.prototype.onChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the table that raised the changed event.
///
var eventInfo = new Excel.Interfaces.TableChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
Table.prototype.onSelectionChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the table that raised the selection changed event.
///
var eventInfo = new Excel.Interfaces.TableSelectionChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
return Table;
})(OfficeExtension.ClientObject);
Excel.Table = Table;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var TableAddedEventArgs = (function() {
function TableAddedEventArgs() {
/// Provides information about the table that raised the added event. [Api set: ExcelApi 1.9]
/// Gets the source of the event. See `Excel.EventSource` for details. [Api set: ExcelApi 1.9]
/// Gets the ID of the table that is added. [Api set: ExcelApi 1.9]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.9]
/// Gets the ID of the worksheet in which the table is added. [Api set: ExcelApi 1.9]
}
return TableAddedEventArgs;
})();
Interfaces.TableAddedEventArgs.__proto__ = null;
Interfaces.TableAddedEventArgs = TableAddedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var TableChangedEventArgs = (function() {
function TableChangedEventArgs() {
/// Provides information about the table that raised the changed event. [Api set: ExcelApi 1.7]
/// Gets the address that represents the changed area of a table on a specific worksheet. [Api set: ExcelApi 1.7]
/// Gets the change type that represents how the changed event is triggered. See `Excel.DataChangeType` for details. [Api set: ExcelApi 1.7]
/// Gets the source of the event. See `Excel.EventSource` for details. [Api set: ExcelApi 1.7]
/// Gets the ID of the table in which the data changed. [Api set: ExcelApi 1.7]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.7]
/// Gets the ID of the worksheet in which the data changed. [Api set: ExcelApi 1.7]
/// Gets the information about the change detail. This property can be retrieved when the changed event is triggered on a single cell. If the changed event is triggered on multiple cells, this property cannot be retrieved. [Api set: ExcelApi 1.9]
}
return TableChangedEventArgs;
})();
Interfaces.TableChangedEventArgs.__proto__ = null;
Interfaces.TableChangedEventArgs = TableChangedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var TableCollection = (function(_super) {
__extends(TableCollection, _super);
function TableCollection() {
/// Represents a collection of all the tables that are part of the workbook or worksheet, depending on how it was reached. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Returns the number of tables in the workbook. [Api set: ExcelApi 1.1]
/// Occurs when a new table is added in a workbook. [Api set: ExcelApi 1.9]
/// Occurs when data changes on any table in a workbook, or a worksheet. [Api set: ExcelApi 1.7]
/// Occurs when the specified table is deleted in a workbook. [Api set: ExcelApi 1.9]
/// Gets the loaded child items in this collection.
}
TableCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
TableCollection.prototype.add = function(address, hasHeaders) {
///
/// 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. [Api set: ExcelApi 1.1]
///
/// 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. [Api set: ExcelApi 1.1 / 1.3. Prior to ExcelApi 1.3, this parameter must be a string. Starting with Excel Api 1.3, this parameter may be a Range object or a string.]
/// 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.
///
}
TableCollection.prototype.getCount = function() {
///
/// Gets the number of tables in the collection. [Api set: ExcelApi 1.4]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
TableCollection.prototype.getItem = function(key) {
///
/// Gets a table by name or ID. [Api set: ExcelApi 1.1]
///
/// Name or ID of the table to be retrieved.
///
}
TableCollection.prototype.getItemAt = function(index) {
///
/// Gets a table based on its position in the collection. [Api set: ExcelApi 1.1]
///
/// Index value of the object to be retrieved. Zero-indexed.
///
}
TableCollection.prototype.getItemOrNullObject = function(key) {
///
/// Gets a table by name or ID. If the table doesn't exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.4]
///
/// Name or ID of the table to be retrieved.
///
}
TableCollection.prototype.onAdded = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the table that raised the added event.
///
var eventInfo = new Excel.Interfaces.TableAddedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
TableCollection.prototype.onChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the table that raised the changed event.
///
var eventInfo = new Excel.Interfaces.TableChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
TableCollection.prototype.onDeleted = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the table that raised the deleted event.
///
var eventInfo = new Excel.Interfaces.TableDeletedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
return TableCollection;
})(OfficeExtension.ClientObject);
Excel.TableCollection = TableCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var TableColumn = (function(_super) {
__extends(TableColumn, _super);
function TableColumn() {
/// Represents a column in a table. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Retrieves the filter applied to the column. [Api set: ExcelApi 1.2]
/// Returns a unique key that identifies the column within the table. [Api set: ExcelApi 1.1]
/// Returns the index number of the column within the columns collection of the table. Zero-indexed. [Api set: ExcelApi 1.1]
/// Specifies the name of the table column. [Api set: ExcelApi 1.1 for getting the name; 1.4 for setting it.]
/// 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. [Api set: ExcelApi 1.1]
}
TableColumn.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
TableColumn.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.TableColumnUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing TableColumn object, with properties that have already been loaded and synced.
///
}
TableColumn.prototype.delete = function() {
///
/// Deletes the column from the table. [Api set: ExcelApi 1.1]
///
///
}
TableColumn.prototype.getDataBodyRange = function() {
///
/// Gets the range object associated with the data body of the column. [Api set: ExcelApi 1.1]
///
///
}
TableColumn.prototype.getHeaderRowRange = function() {
///
/// Gets the range object associated with the header row of the column. [Api set: ExcelApi 1.1]
///
///
}
TableColumn.prototype.getRange = function() {
///
/// Gets the range object associated with the entire column. [Api set: ExcelApi 1.1]
///
///
}
TableColumn.prototype.getTotalRowRange = function() {
///
/// Gets the range object associated with the totals row of the column. [Api set: ExcelApi 1.1]
///
///
}
return TableColumn;
})(OfficeExtension.ClientObject);
Excel.TableColumn = TableColumn;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var TableColumnCollection = (function(_super) {
__extends(TableColumnCollection, _super);
function TableColumnCollection() {
/// Represents a collection of all the columns that are part of the table. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Returns the number of columns in the table. [Api set: ExcelApi 1.1]
/// Gets the loaded child items in this collection.
}
TableColumnCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
TableColumnCollection.prototype.add = function(index, values, name) {
///
/// Adds a new column to the table. [Api set: ExcelApi 1.1 requires an index smaller than the total column count; 1.4 allows index to be optional (null or -1) and will append a column at the end; 1.4 allows name parameter at creation time.]
///
/// 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.
/// Optional. A 2D array of unformatted values of the table column.
/// Optional. Specifies the name of the new column. If `null`, the default name will be used.
///
}
TableColumnCollection.prototype.getCount = function() {
///
/// Gets the number of columns in the table. [Api set: ExcelApi 1.4]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
TableColumnCollection.prototype.getItem = function(key) {
///
/// Gets a column object by name or ID. [Api set: ExcelApi 1.1]
///
/// Column name or ID.
///
}
TableColumnCollection.prototype.getItemAt = function(index) {
///
/// Gets a column based on its position in the collection. [Api set: ExcelApi 1.1]
///
/// Index value of the object to be retrieved. Zero-indexed.
///
}
TableColumnCollection.prototype.getItemOrNullObject = function(key) {
///
/// Gets a column object by name or ID. If the column doesn't exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.4]
///
/// Column name or ID.
///
}
return TableColumnCollection;
})(OfficeExtension.ClientObject);
Excel.TableColumnCollection = TableColumnCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var TableDeletedEventArgs = (function() {
function TableDeletedEventArgs() {
/// Provides information about the table that raised the deleted event. [Api set: ExcelApi 1.9]
/// Gets the source of the event. See `Excel.EventSource` for details. [Api set: ExcelApi 1.9]
/// Gets the ID of the table that is deleted. [Api set: ExcelApi 1.9]
/// Gets the name of the table that is deleted. [Api set: ExcelApi 1.9]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.9]
/// Gets the ID of the worksheet in which the table is deleted. [Api set: ExcelApi 1.9]
}
return TableDeletedEventArgs;
})();
Interfaces.TableDeletedEventArgs.__proto__ = null;
Interfaces.TableDeletedEventArgs = TableDeletedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var TableRow = (function(_super) {
__extends(TableRow, _super);
function TableRow() {
/// Represents a row in a table. Note that unlike ranges or columns, which will adjust if new rows or columns are added before them, a `TableRow` object represents the physical location of the table row, but not the data. That is, if the data is sorted or if new rows are added, a table row will continue to point at the index for which it was created. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Returns the index number of the row within the rows collection of the table. Zero-indexed. [Api set: ExcelApi 1.1]
/// 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. [Api set: ExcelApi 1.1]
}
TableRow.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
TableRow.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.TableRowUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing TableRow object, with properties that have already been loaded and synced.
///
}
TableRow.prototype.delete = function() {
///
/// Deletes the row from the table. [Api set: ExcelApi 1.1]
///
///
}
TableRow.prototype.getRange = function() {
///
/// Returns the range object associated with the entire row. [Api set: ExcelApi 1.1]
///
///
}
return TableRow;
})(OfficeExtension.ClientObject);
Excel.TableRow = TableRow;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var TableRowCollection = (function(_super) {
__extends(TableRowCollection, _super);
function TableRowCollection() {
/// Represents a collection of all the rows that are part of the table. Note that unlike ranges or columns, which will adjust if new rows or columns are added before them, a `TableRow` object represents the physical location of the table row, but not the data. That is, if the data is sorted or if new rows are added, a table row will continue to point at the index for which it was created. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Returns the number of rows in the table. [Api set: ExcelApi 1.1]
/// Gets the loaded child items in this collection.
}
TableRowCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
TableRowCollection.prototype.add = function(index, values, alwaysInsert) {
///
/// Adds one or more rows to the table. The return object will be the top of the newly added row(s). Note that unlike ranges or columns, which will adjust if new rows or columns are added before them, a `TableRow` object represents the physical location of the table row, but not the data. That is, if the data is sorted or if new rows are added, a table row will continue to point at the index for which it was created. [Api set: ExcelApi 1.1 for adding a single row; 1.4 allows adding of multiple rows.]
///
/// 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.
/// Optional. A 2D array of unformatted values of the table row.
///
}
TableRowCollection.prototype.deleteRows = function(rows) {
///
/// Delete multiple rows from a table. These rows don't need to be sequential. This method will throw the `InvalidArgument` error if a chosen row has already been deleted or doesn't exist. This method will throw the `InsertDeleteConflict` error if the table on which the method is called has a filter applied. [Api set: ExcelApiOnline 1.1]
///
/// An array of row index numbers or row objects to delete from the table.
///
}
TableRowCollection.prototype.deleteRowsAt = function(index, count) {
///
/// Delete a specified number of rows from a table, starting at a given index. This method will throw the `InsertDeleteConflict` error if the table on which the method is called has a filter applied. [Api set: ExcelApiOnline 1.1]
///
/// The index value of the row to be deleted. Note: Row indexes update each time that a preceding row in the table is deleted, after each delete operation. Ensure that the index of the row that you want to delete hasn't changed between the time that you determined the value and the time that you run the operation.
/// Number of rows to delete. By default, a single row will be deleted.
///
}
TableRowCollection.prototype.getCount = function() {
///
/// Gets the number of rows in the table. [Api set: ExcelApi 1.4]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
TableRowCollection.prototype.getItemAt = function(index) {
///
/// Gets a row based on its position in the collection. Note that unlike ranges or columns, which will adjust if new rows or columns are added before them, a `TableRow` object represents the physical location of the table row, but not the data. That is, if the data is sorted or if new rows are added, a table row will continue to point at the index for which it was created. [Api set: ExcelApi 1.1]
///
/// Index value of the object to be retrieved. Zero-indexed.
///
}
return TableRowCollection;
})(OfficeExtension.ClientObject);
Excel.TableRowCollection = TableRowCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var TableScopedCollection = (function(_super) {
__extends(TableScopedCollection, _super);
function TableScopedCollection() {
/// Represents a scoped collection of tables. For each table its top-left corner is considered its anchor location, and the tables are sorted top-to-bottom and then left-to-right. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
TableScopedCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
TableScopedCollection.prototype.getCount = function() {
///
/// Gets the number of tables in the collection. [Api set: ExcelApi 1.9]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
TableScopedCollection.prototype.getFirst = function() {
///
/// Gets the first table in the collection. The tables in the collection are sorted top-to-bottom and left-to-right, such that top-left table is the first table in the collection. [Api set: ExcelApi 1.9]
///
///
}
TableScopedCollection.prototype.getItem = function(key) {
///
/// Gets a table by name or ID. [Api set: ExcelApi 1.9]
///
/// Name or ID of the table to be retrieved.
///
}
TableScopedCollection.prototype.getItemOrNullObject = function(key) {
///
/// Gets a table by name or ID. If the table object does not exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.14]
///
/// Name or ID of the table to be retrieved.
///
}
return TableScopedCollection;
})(OfficeExtension.ClientObject);
Excel.TableScopedCollection = TableScopedCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var TableSelectionChangedEventArgs = (function() {
function TableSelectionChangedEventArgs() {
/// Provides information about the table that raised the selection changed event. [Api set: ExcelApi 1.7]
/// Gets the range address that represents the selected area of the table on a specific worksheet. [Api set: ExcelApi 1.7]
/// Specifies if the selection is inside a table. `IsInsideTable` must be set to `true` for the address to be useful. [Api set: ExcelApi 1.7]
/// Gets the ID of the table in which the selection changed. [Api set: ExcelApi 1.7]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.7]
/// Gets the ID of the worksheet in which the selection changed. [Api set: ExcelApi 1.7]
}
return TableSelectionChangedEventArgs;
})();
Interfaces.TableSelectionChangedEventArgs.__proto__ = null;
Interfaces.TableSelectionChangedEventArgs = TableSelectionChangedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var TableSort = (function(_super) {
__extends(TableSort, _super);
function TableSort() {
/// Manages sorting operations on `Table` objects. [Api set: ExcelApi 1.2]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies the current conditions used to last sort the table. [Api set: ExcelApi 1.2]
/// Specifies if the casing impacts the last sort of the table. [Api set: ExcelApi 1.2]
/// Represents the Chinese character ordering method last used to sort the table. [Api set: ExcelApi 1.2]
}
TableSort.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
TableSort.prototype.apply = function(fields, matchCase, method) {
///
/// Perform a sort operation. [Api set: ExcelApi 1.2]
///
/// The list of conditions to sort on.
/// Optional. Whether to have the casing impact string ordering.
/// Optional. The ordering method used for Chinese characters.
///
}
TableSort.prototype.clear = function() {
///
/// 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. [Api set: ExcelApi 1.2]
///
///
}
TableSort.prototype.reapply = function() {
///
/// Reapplies the current sorting parameters to the table. [Api set: ExcelApi 1.2]
///
///
}
return TableSort;
})(OfficeExtension.ClientObject);
Excel.TableSort = TableSort;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var TableStyle = (function(_super) {
__extends(TableStyle, _super);
function TableStyle() {
/// Represents a table style, which defines the style elements by region of the table. [Api set: ExcelApi 1.10]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the name of the table style. [Api set: ExcelApi 1.10]
/// Specifies if this `TableStyle` object is read-only. [Api set: ExcelApi 1.10]
}
TableStyle.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
TableStyle.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.TableStyleUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing TableStyle object, with properties that have already been loaded and synced.
///
}
TableStyle.prototype.delete = function() {
///
/// Deletes the table style. [Api set: ExcelApi 1.10]
///
///
}
TableStyle.prototype.duplicate = function() {
///
/// Creates a duplicate of this table style with copies of all the style elements. [Api set: ExcelApi 1.10]
///
/// The new `TableStyle` object that has been duplicated from this table style.
}
return TableStyle;
})(OfficeExtension.ClientObject);
Excel.TableStyle = TableStyle;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var TableStyleCollection = (function(_super) {
__extends(TableStyleCollection, _super);
function TableStyleCollection() {
/// Represents a collection of table styles. [Api set: ExcelApi 1.10]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
TableStyleCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
TableStyleCollection.prototype.add = function(name, makeUniqueName) {
///
/// Creates a blank `TableStyle` with the specified name. [Api set: ExcelApi 1.10]
///
/// The unique name for the new table style. Will throw an `InvalidArgument` error if the name is already in use.
/// Optional. Defaults to `false`. If `true`, will append numbers to the name in order to make it unique, if needed.
/// The newly created `TableStyle`.
}
TableStyleCollection.prototype.getCount = function() {
///
/// Gets the number of table styles in the collection. [Api set: ExcelApi 1.10]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
TableStyleCollection.prototype.getDefault = function() {
///
/// Gets the default table style for the parent object's scope. [Api set: ExcelApi 1.10]
///
/// The `TableStyle` object that is the current default table style.
}
TableStyleCollection.prototype.getItem = function(name) {
///
/// Gets a `TableStyle` by name. [Api set: ExcelApi 1.10]
///
/// Name of the table style to be retrieved.
/// The `TableStyle` object whose name matches the input.
}
TableStyleCollection.prototype.getItemOrNullObject = function(name) {
///
/// Gets a `TableStyle` by name. If the table style does not exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.10]
///
/// Name of the table style to be retrieved.
/// The `TableStyle` object whose name matches the input.
}
TableStyleCollection.prototype.setDefault = function(newDefaultStyle) {
///
/// Sets the default table style for use in the parent object's scope. [Api set: ExcelApi 1.10]
///
/// The `TableStyle` object, or name of the `TableStyle` object, that should be the new default.
///
}
return TableStyleCollection;
})(OfficeExtension.ClientObject);
Excel.TableStyleCollection = TableStyleCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var TextConditionalFormat = (function(_super) {
__extends(TextConditionalFormat, _super);
function TextConditionalFormat() {
/// Represents a specific text conditional format. [Api set: ExcelApi 1.6]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Returns a format object, encapsulating the conditional format's font, fill, borders, and other properties. [Api set: ExcelApi 1.6]
/// The rule of the conditional format. [Api set: ExcelApi 1.6]
}
TextConditionalFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
TextConditionalFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.TextConditionalFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing TextConditionalFormat object, with properties that have already been loaded and synced.
///
}
return TextConditionalFormat;
})(OfficeExtension.ClientObject);
Excel.TextConditionalFormat = TextConditionalFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var TextFrame = (function(_super) {
__extends(TextFrame, _super);
function TextFrame() {
/// Represents the text frame of a shape object. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// 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. [Api set: ExcelApi 1.9]
/// Represents the bottom margin, in points, of the text frame. [Api set: ExcelApi 1.9]
/// Specifies if the text frame contains text. [Api set: ExcelApi 1.9]
/// Represents the horizontal alignment of the text frame. See `Excel.ShapeTextHorizontalAlignment` for details. [Api set: ExcelApi 1.9]
/// Represents the horizontal overflow behavior of the text frame. See `Excel.ShapeTextHorizontalOverflow` for details. [Api set: ExcelApi 1.9]
/// Represents the left margin, in points, of the text frame. [Api set: ExcelApi 1.9]
/// Represents the angle to which the text is oriented for the text frame. See `Excel.ShapeTextOrientation` for details. [Api set: ExcelApi 1.9]
/// Represents the reading order of the text frame, either left-to-right or right-to-left. See `Excel.ShapeTextReadingOrder` for details. [Api set: ExcelApi 1.9]
/// Represents the right margin, in points, of the text frame. [Api set: ExcelApi 1.9]
/// Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text. See `Excel.TextRange` for details. [Api set: ExcelApi 1.9]
/// Represents the top margin, in points, of the text frame. [Api set: ExcelApi 1.9]
/// Represents the vertical alignment of the text frame. See `Excel.ShapeTextVerticalAlignment` for details. [Api set: ExcelApi 1.9]
/// Represents the vertical overflow behavior of the text frame. See `Excel.ShapeTextVerticalOverflow` for details. [Api set: ExcelApi 1.9]
}
TextFrame.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
TextFrame.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.TextFrameUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing TextFrame object, with properties that have already been loaded and synced.
///
}
TextFrame.prototype.deleteText = function() {
///
/// Deletes all the text in the text frame. [Api set: ExcelApi 1.9]
///
///
}
return TextFrame;
})(OfficeExtension.ClientObject);
Excel.TextFrame = TextFrame;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var TextRange = (function(_super) {
__extends(TextRange, _super);
function TextRange() {
/// Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text. [Api set: ExcelApi 1.9]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Returns a `ShapeFont` object that represents the font attributes for the text range. [Api set: ExcelApi 1.9]
/// Represents the plain text content of the text range. [Api set: ExcelApi 1.9]
}
TextRange.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
TextRange.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.TextRangeUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing TextRange object, with properties that have already been loaded and synced.
///
}
TextRange.prototype.getSubstring = function(start, length) {
///
/// Returns a TextRange object for the substring in the given range. [Api set: ExcelApi 1.9]
///
/// The zero-based index of the first character to get from the text range.
/// 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.
///
}
return TextRange;
})(OfficeExtension.ClientObject);
Excel.TextRange = TextRange;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var TimelineStyle = (function(_super) {
__extends(TimelineStyle, _super);
function TimelineStyle() {
/// Represents a `TimelineStyle`, which defines style elements by region in the timeline. [Api set: ExcelApi 1.10]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the name of the timeline style. [Api set: ExcelApi 1.10]
/// Specifies if this `TimelineStyle` object is read-only. [Api set: ExcelApi 1.10]
}
TimelineStyle.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
TimelineStyle.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.TimelineStyleUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing TimelineStyle object, with properties that have already been loaded and synced.
///
}
TimelineStyle.prototype.delete = function() {
///
/// Deletes the table style. [Api set: ExcelApi 1.10]
///
///
}
TimelineStyle.prototype.duplicate = function() {
///
/// Creates a duplicate of this timeline style with copies of all the style elements. [Api set: ExcelApi 1.10]
///
/// The new `TimelineStyle` object that has been duplicated from this timeline style.
}
return TimelineStyle;
})(OfficeExtension.ClientObject);
Excel.TimelineStyle = TimelineStyle;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var TimelineStyleCollection = (function(_super) {
__extends(TimelineStyleCollection, _super);
function TimelineStyleCollection() {
/// Represents a collection of timeline styles. [Api set: ExcelApi 1.10]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
TimelineStyleCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
TimelineStyleCollection.prototype.add = function(name, makeUniqueName) {
///
/// Creates a blank `TimelineStyle` with the specified name. [Api set: ExcelApi 1.10]
///
/// The unique name for the new timeline style. Will throw an `InvalidArgument` error if the name is already in use.
/// Optional. Defaults to `false`. If `true`, will append numbers to the name in order to make it unique, if needed.
/// The newly created `TimelineStyle`.
}
TimelineStyleCollection.prototype.getCount = function() {
///
/// Gets the number of timeline styles in the collection. [Api set: ExcelApi 1.10]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
TimelineStyleCollection.prototype.getDefault = function() {
///
/// Gets the default timeline style for the parent object's scope. [Api set: ExcelApi 1.10]
///
/// The `TimelineStyle` object that is the current default timeline style.
}
TimelineStyleCollection.prototype.getItem = function(name) {
///
/// Gets a `TimelineStyle` by name. [Api set: ExcelApi 1.10]
///
/// Name of the timeline style to be retrieved.
/// The `TimelineStyle` object whose name matches the input.
}
TimelineStyleCollection.prototype.getItemOrNullObject = function(name) {
///
/// Gets a `TimelineStyle` by name. If the timeline style doesn't exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.10]
///
/// Name of the timeline style to be retrieved.
/// The `TimelineStyle` object whose name matches the input.
}
TimelineStyleCollection.prototype.setDefault = function(newDefaultStyle) {
///
/// Sets the default timeline style for use in the parent object's scope. [Api set: ExcelApi 1.10]
///
/// The `TimelineStyle` object, or name of the `TimelineStyle` object, that should be the new default.
///
}
return TimelineStyleCollection;
})(OfficeExtension.ClientObject);
Excel.TimelineStyleCollection = TimelineStyleCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var TopBottomConditionalFormat = (function(_super) {
__extends(TopBottomConditionalFormat, _super);
function TopBottomConditionalFormat() {
/// Represents a top/bottom conditional format. [Api set: ExcelApi 1.6]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Returns a format object, encapsulating the conditional format's font, fill, borders, and other properties. [Api set: ExcelApi 1.6]
/// The criteria of the top/bottom conditional format. [Api set: ExcelApi 1.6]
}
TopBottomConditionalFormat.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
TopBottomConditionalFormat.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.TopBottomConditionalFormatUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing TopBottomConditionalFormat object, with properties that have already been loaded and synced.
///
}
return TopBottomConditionalFormat;
})(OfficeExtension.ClientObject);
Excel.TopBottomConditionalFormat = TopBottomConditionalFormat;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// 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. [Api set: ExcelApi 1.12]
var TopBottomSelectionType = {
__proto__: null,
"items": "items",
"percent": "percent",
"sum": "sum",
}
Excel.TopBottomSelectionType = TopBottomSelectionType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.3]
var V1CoercionType = {
__proto__: null,
"matrix": "matrix",
"table": "table",
"text": "text",
"image": "image",
"xmlSvg": "xmlSvg",
}
Excel.V1CoercionType = V1CoercionType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.3]
var V1TableEnum = {
__proto__: null,
"all": "all",
"data": "data",
"headers": "headers",
}
Excel.V1TableEnum = V1TableEnum;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// 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. [Api set: ExcelApi 1.12]
var ValueFilterCondition = {
__proto__: null,
"unknown": "unknown",
"equals": "equals",
"greaterThan": "greaterThan",
"greaterThanOrEqualTo": "greaterThanOrEqualTo",
"lessThan": "lessThan",
"lessThanOrEqualTo": "lessThanOrEqualTo",
"between": "between",
"topN": "topN",
"bottomN": "bottomN",
}
Excel.ValueFilterCondition = ValueFilterCondition;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.1]
var VerticalAlignment = {
__proto__: null,
"top": "top",
"center": "center",
"bottom": "bottom",
"justify": "justify",
"distributed": "distributed",
}
Excel.VerticalAlignment = VerticalAlignment;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Workbook = (function(_super) {
__extends(Workbook, _super);
function Workbook() {
/// Workbook is the top level object which contains related workbook objects such as worksheets, tables, and ranges. To learn more about the workbook object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-workbooks | Work with workbooks using the Excel JavaScript API}. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the Excel application instance that contains this workbook. [Api set: ExcelApi 1.1]
/// Specifies if the workbook is in AutoSave mode. [Api set: ExcelApi 1.9]
/// Represents a collection of bindings that are part of the workbook. [Api set: ExcelApi 1.1]
/// Returns a number about the version of Excel Calculation Engine. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9]
/// Represents a collection of comments associated with the workbook. [Api set: ExcelApi 1.10]
/// Represents the collection of custom XML parts contained by this workbook. [Api set: ExcelApi 1.5]
/// Represents all data connections in the workbook. [Api set: ExcelApi 1.7]
/// Represents a collection of worksheet functions that can be used for computation. [Api set: ExcelApi 1.2]
/// 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. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApiOnline 1.1]
/// Gets the workbook name. [Api set: ExcelApi 1.7]
/// Represents a collection of workbook-scoped named items (named ranges and constants). [Api set: ExcelApi 1.1]
/// Represents a collection of PivotTableStyles associated with the workbook. [Api set: ExcelApi 1.10]
/// Represents a collection of PivotTables associated with the workbook. [Api set: ExcelApi 1.3]
/// Specifies if the workbook has ever been saved locally or online. [Api set: ExcelApi 1.9]
/// Gets the workbook properties. [Api set: ExcelApi 1.7]
/// Returns the protection object for a workbook. [Api set: ExcelApi 1.7]
/// Returns a collection of Power Query queries that are part of the workbook. [Api set: ExcelApi 1.14]
/// Returns `true` if the workbook is open in read-only mode. [Api set: ExcelApi 1.8]
/// Represents a collection of settings associated with the workbook. [Api set: ExcelApi 1.4]
/// Represents a collection of SlicerStyles associated with the workbook. [Api set: ExcelApi 1.10]
/// Represents a collection of slicers associated with the workbook. [Api set: ExcelApi 1.10]
/// Represents a collection of styles associated with the workbook. [Api set: ExcelApi 1.7]
/// Represents a collection of TableStyles associated with the workbook. [Api set: ExcelApi 1.10]
/// Represents a collection of tables associated with the workbook. [Api set: ExcelApi 1.1]
/// Represents a collection of TimelineStyles associated with the workbook. [Api set: ExcelApi 1.10]
/// 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`. [Api set: ExcelApi 1.9]
/// Represents a collection of worksheets associated with the workbook. [Api set: ExcelApi 1.1]
/// Occurs when the the workbook is activated. Note: This event will not fire when the workbook is opened. [Api set: ExcelApi 1.13]
/// Occurs when the AutoSave setting is changed on the workbook. [Api set: ExcelApi 1.9]
/// Occurs when the selection in the document is changed. [Api set: ExcelApi 1.2]
}
Workbook.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Workbook.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.WorkbookUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing Workbook object, with properties that have already been loaded and synced.
///
}
Workbook.prototype.close = function(closeBehavior) {
///
/// Close current workbook. [Api set: ExcelApi 1.11]
///
/// workbook close behavior.
///
}
Workbook.prototype.getActiveCell = function() {
///
/// Gets the currently active cell from the workbook. [Api set: ExcelApi 1.7]
///
///
}
Workbook.prototype.getActiveChart = function() {
///
/// Gets the currently active chart in the workbook. If there is no active chart, an `ItemNotFound` exception is thrown. [Api set: ExcelApi 1.9]
///
///
}
Workbook.prototype.getActiveChartOrNullObject = function() {
///
/// Gets the currently active chart in the workbook. If there is no active chart, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.9]
///
///
}
Workbook.prototype.getActiveSlicer = function() {
///
/// Gets the currently active slicer in the workbook. If there is no active slicer, an `ItemNotFound` exception is thrown. [Api set: ExcelApi 1.10]
///
///
}
Workbook.prototype.getActiveSlicerOrNullObject = function() {
///
/// Gets the currently active slicer in the workbook. If there is no active slicer, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.10]
///
///
}
Workbook.prototype.getIsActiveCollabSession = function() {
///
/// Returns `true` if the workbook is being edited by multiple users (through co-authoring). Please be aware there might be some delay between when the workbook status changes and when the changes are reflected on the result of the method. [Api set: ExcelApi 1.9]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = false;
return result;
}
Workbook.prototype.getSelectedRange = function() {
///
/// Gets the currently selected single range from the workbook. If there are multiple ranges selected, this method will throw an error. [Api set: ExcelApi 1.1]
///
///
}
Workbook.prototype.getSelectedRanges = function() {
///
/// 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. [Api set: ExcelApi 1.9]
///
///
}
Workbook.prototype.insertWorksheetsFromBase64 = function(base64File, options) {
///
/// Inserts the specified worksheets from a source workbook into the current workbook. **Note**: This API is currently only supported for Office on Windows, Mac, and the web. [Api set: ExcelApi 1.13]
///
/// Required. The base64-encoded string representing the source workbook file.
/// Optional. The options that define which worksheets to insert and where in the workbook the new worksheets will be inserted. By default, all the worksheets from the source workbook are inserted at the end of the current workbook.
/// An array of IDs corresponding to each newly inserted worksheet.
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = [];
return result;
}
Workbook.prototype.save = function(saveBehavior) {
///
/// Save current workbook. [Api set: ExcelApi 1.11]
///
/// Workbook save behavior.
///
}
Workbook.prototype.onActivated = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the workbook that raised the activated event.
///
var eventInfo = new Excel.Interfaces.WorkbookActivatedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
Workbook.prototype.onAutoSaveSettingChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the workbook's `onAutoSaveSettingChanged` event.
///
var eventInfo = new Excel.Interfaces.WorkbookAutoSaveSettingChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
Workbook.prototype.onSelectionChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the document that raised the selection changed event.
///
var eventInfo = new Excel.Interfaces.SelectionChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
return Workbook;
})(OfficeExtension.ClientObject);
Excel.Workbook = Workbook;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorkbookActivatedEventArgs = (function() {
function WorkbookActivatedEventArgs() {
/// Provides information about the workbook that raised the activated event. [Api set: ExcelApi 1.13]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.13]
}
return WorkbookActivatedEventArgs;
})();
Interfaces.WorkbookActivatedEventArgs.__proto__ = null;
Interfaces.WorkbookActivatedEventArgs = WorkbookActivatedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorkbookAutoSaveSettingChangedEventArgs = (function() {
function WorkbookAutoSaveSettingChangedEventArgs() {
/// Provides information about the workbook's `onAutoSaveSettingChanged` event. [Api set: ExcelApi 1.9]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.9]
}
return WorkbookAutoSaveSettingChangedEventArgs;
})();
Interfaces.WorkbookAutoSaveSettingChangedEventArgs.__proto__ = null;
Interfaces.WorkbookAutoSaveSettingChangedEventArgs = WorkbookAutoSaveSettingChangedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var WorkbookCreated = (function(_super) {
__extends(WorkbookCreated, _super);
function WorkbookCreated() {
/// The `WorkbookCreated` object is the top level object created by `Application.CreateWorkbook`. A `WorkbookCreated` object is a special Workbook object. [Api set: ExcelApi 1.8]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
}
WorkbookCreated.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
return WorkbookCreated;
})(OfficeExtension.ClientObject);
Excel.WorkbookCreated = WorkbookCreated;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// Represents the refresh mode of the workbook links. [Api set: ExcelApiOnline 1.1]
var WorkbookLinksRefreshMode = {
__proto__: null,
"manual": "manual",
"automatic": "automatic",
}
Excel.WorkbookLinksRefreshMode = WorkbookLinksRefreshMode;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var WorkbookProtection = (function(_super) {
__extends(WorkbookProtection, _super);
function WorkbookProtection() {
/// Represents the protection of a workbook object. [Api set: ExcelApi 1.7]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies if the workbook is protected. [Api set: ExcelApi 1.7]
}
WorkbookProtection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
WorkbookProtection.prototype.protect = function(password) {
///
/// Protects a workbook. Fails if the workbook has been protected. [Api set: ExcelApi 1.7]
///
/// Workbook protection password.
///
}
WorkbookProtection.prototype.unprotect = function(password) {
///
/// Unprotects a workbook. [Api set: ExcelApi 1.7]
///
/// Workbook protection password.
///
}
return WorkbookProtection;
})(OfficeExtension.ClientObject);
Excel.WorkbookProtection = WorkbookProtection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var WorkbookRangeAreas = (function(_super) {
__extends(WorkbookRangeAreas, _super);
function WorkbookRangeAreas() {
/// Represents a collection of one or more rectangular ranges in multiple worksheets. [Api set: ExcelApi 1.12]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// 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. [Api set: ExcelApi 1.12]
/// Returns the `RangeAreasCollection` object. Each `RangeAreas` in the collection represent one or more rectangle ranges in one worksheet. [Api set: ExcelApi 1.12]
/// Returns ranges that comprise this object in a `RangeCollection` object. [Api set: ExcelApi 1.12]
}
WorkbookRangeAreas.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
WorkbookRangeAreas.prototype.getRangeAreasBySheet = function(key) {
///
/// Returns the `RangeAreas` object based on worksheet ID or name in the collection. [Api set: ExcelApi 1.12]
///
/// The name or ID of the worksheet.
///
}
WorkbookRangeAreas.prototype.getRangeAreasOrNullObjectBySheet = function(key) {
///
/// Returns the `RangeAreas` object based on worksheet name or ID in the collection. If the worksheet does not exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.12]
///
/// The name or ID of the worksheet.
///
}
WorkbookRangeAreas.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
WorkbookRangeAreas.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return WorkbookRangeAreas;
})(OfficeExtension.ClientObject);
Excel.WorkbookRangeAreas = WorkbookRangeAreas;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Worksheet = (function(_super) {
__extends(Worksheet, _super);
function Worksheet() {
/// An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc. To learn more about the worksheet object model, read {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-worksheets | Work with worksheets using the Excel JavaScript API}. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Represents the `AutoFilter` object of the worksheet. [Api set: ExcelApi 1.9]
/// Returns a collection of charts that are part of the worksheet. [Api set: ExcelApi 1.1]
/// Returns a collection of all the Comments objects on the worksheet. [Api set: ExcelApi 1.10]
/// Gets a collection of worksheet-level custom properties. [Api set: ExcelApi 1.12]
/// 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. [Api set: ExcelApi 1.9]
/// Gets an object that can be used to manipulate frozen panes on the worksheet. [Api set: ExcelApi 1.7]
/// Gets the horizontal page break collection for the worksheet. This collection only contains manual page breaks. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.1]
/// The display name of the worksheet. [Api set: ExcelApi 1.1]
/// Returns a collection of sheet views that are present in the worksheet. [Api set: ExcelApiOnline 1.1]
/// Collection of names scoped to the current worksheet. [Api set: ExcelApi 1.4]
/// Gets the `PageLayout` object of the worksheet. [Api set: ExcelApi 1.9]
/// Collection of PivotTables that are part of the worksheet. [Api set: ExcelApi 1.3]
/// The zero-based position of the worksheet within the workbook. [Api set: ExcelApi 1.1]
/// Returns the sheet protection object for a worksheet. [Api set: ExcelApi 1.2]
/// Returns the collection of all the Shape objects on the worksheet. [Api set: ExcelApi 1.9]
/// Specifies if gridlines are visible to the user. [Api set: ExcelApi 1.8]
/// Specifies if headings are visible to the user. [Api set: ExcelApi 1.8]
/// Returns a collection of slicers that are part of the worksheet. [Api set: ExcelApi 1.10]
/// Returns the standard (default) height of all the rows in the worksheet, in points. [Api set: ExcelApi 1.7]
/// 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. [Api set: ExcelApi 1.7]
/// 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. [Api set: ExcelApi 1.7]
/// Returns a value representing this worksheet that can be read by Open Office XML. This is integer value, which is different from `worksheet.id` (GUID), `worksheet.name` (eg: "Sheet1"). [Api set: ExcelApi 1.14]
/// Collection of tables that are part of the worksheet. [Api set: ExcelApi 1.1]
/// Gets the vertical page break collection for the worksheet. This collection only contains manual page breaks. [Api set: ExcelApi 1.9]
/// The visibility of the worksheet. [Api set: ExcelApi 1.1 for reading visibility; 1.2 for setting it.]
/// Occurs when the worksheet is activated. [Api set: ExcelApi 1.7]
/// Occurs when the worksheet is calculated. [Api set: ExcelApi 1.8]
/// Occurs when data changes in a specific worksheet. [Api set: ExcelApi 1.7]
/// Occurs when one or more columns have been sorted. This happens as the result of a left to right sort operation. [Api set: ExcelApi 1.10]
/// Occurs when the worksheet is deactivated. [Api set: ExcelApi 1.7]
/// Occurs when format changed on a specific worksheet. [Api set: ExcelApi 1.9]
/// Occurs when one or more formulas are changed in this worksheet. This event is for when the formula itself changes, not the data value resulting from the formula's calculation. [Api set: ExcelApi 1.13]
/// Occurs when the worksheet name is changed. [Api set: ExcelApiOnline 1.1]
/// Occurs when the worksheet protection state is changed. [Api set: ExcelApi 1.14]
/// Occurs when the hidden state of one or more rows has changed on a specific worksheet. [Api set: ExcelApi 1.11]
/// Occurs when one or more rows have been sorted. This happens as the result of a top-to-bottom sort operation. [Api set: ExcelApi 1.10]
/// Occurs when the selection changes on a specific worksheet. [Api set: ExcelApi 1.7]
/// Occurs when a left-clicked/tapped action happens in the worksheet. This event will not be fired when clicking in the following cases: - The user drags the mouse for multi-selection. - The user selects a cell in the mode when cell arguments are selected for formula references. [Api set: ExcelApi 1.10]
/// Occurs when the worksheet visibility is changed. [Api set: ExcelApiOnline 1.1]
}
Worksheet.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Worksheet.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.WorksheetUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing Worksheet object, with properties that have already been loaded and synced.
///
}
Worksheet.prototype.activate = function() {
///
/// Activate the worksheet in the Excel UI. [Api set: ExcelApi 1.1]
///
///
}
Worksheet.prototype.calculate = function(markAllDirty) {
///
/// Calculates all cells on a worksheet. [Api set: ExcelApi 1.6]
///
/// True, to mark all as dirty.
///
}
Worksheet.prototype.copy = function(positionType, relativeTo) {
///
/// Copies a worksheet and places it at the specified position. [Api set: ExcelApi 1.7]
///
/// 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.
/// The existing worksheet which determines the newly created worksheet's position. This is only needed if `positionType` is "Before" or "After".
/// The newly created worksheet.
}
Worksheet.prototype.delete = function() {
///
/// 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. [Api set: ExcelApi 1.1]
///
///
}
Worksheet.prototype.findAll = function(text, criteria) {
///
/// 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. [Api set: ExcelApi 1.9]
///
/// The string to find.
/// Additional search criteria, including whether the search needs to match the entire cell or be case-sensitive.
/// A `RangeAreas` object, comprising one or more rectangular ranges, that matches the search criteria. If no cells meet this criteria, an `ItemNotFound` error will be thrown.
}
Worksheet.prototype.findAllOrNullObject = function(text, criteria) {
///
/// 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. [Api set: ExcelApi 1.9]
///
/// The string to find.
/// Additional search criteria, including whether the search needs to match the entire cell or be case-sensitive.
/// A `RangeAreas` object, comprising one or more rectangular ranges, that matches the search criteria. If there are no matches, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
}
Worksheet.prototype.getCell = function(row, column) {
///
/// 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. [Api set: ExcelApi 1.1]
///
/// The row number of the cell to be retrieved. Zero-indexed.
/// The column number of the cell to be retrieved. Zero-indexed.
///
}
Worksheet.prototype.getNext = function(visibleOnly) {
///
/// Gets the worksheet that follows this one. If there are no worksheets following this one, this method will throw an error. [Api set: ExcelApi 1.5]
///
/// Optional. If `true`, considers only visible worksheets, skipping over any hidden ones.
///
}
Worksheet.prototype.getNextOrNullObject = function(visibleOnly) {
///
/// Gets the worksheet that follows this one. If there are no worksheets following this one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.5]
///
/// Optional. If `true`, considers only visible worksheets, skipping over any hidden ones.
///
}
Worksheet.prototype.getPrevious = function(visibleOnly) {
///
/// Gets the worksheet that precedes this one. If there are no previous worksheets, this method will throw an error. [Api set: ExcelApi 1.5]
///
/// Optional. If `true`, considers only visible worksheets, skipping over any hidden ones.
///
}
Worksheet.prototype.getPreviousOrNullObject = function(visibleOnly) {
///
/// Gets the worksheet that precedes this one. If there are no previous worksheets, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.5]
///
/// Optional. If `true`, considers only visible worksheets, skipping over any hidden ones.
///
}
Worksheet.prototype.getRange = function(address) {
///
/// Gets the `Range` object, representing a single rectangular block of cells, specified by the address or name. [Api set: ExcelApi 1.1]
///
/// Optional. The string representing the address or name of the range. For example, "A1:B2". If not specified, the entire worksheet range is returned.
///
}
Worksheet.prototype.getRangeByIndexes = function(startRow, startColumn, rowCount, columnCount) {
///
/// Gets the `Range` object beginning at a particular row index and column index, and spanning a certain number of rows and columns. [Api set: ExcelApi 1.7]
///
/// Start row (zero-indexed).
/// Start column (zero-indexed).
/// Number of rows to include in the range.
/// Number of columns to include in the range.
///
}
Worksheet.prototype.getRanges = function(address) {
///
/// Gets the `RangeAreas` object, representing one or more blocks of rectangular ranges, specified by the address or name. [Api set: ExcelApi 1.9]
///
/// Optional. A string containing the comma-separated addresses or names of the individual ranges. For example, "A1:B2, A5:B5". If not specified, an RangeArea object for the entire worksheet is returned.
///
}
Worksheet.prototype.getUsedRange = function(valuesOnly) {
///
/// The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. If the entire worksheet is blank, this function will return the top left cell (i.e. it will *not* throw an error). [Api set: ExcelApi 1.1]
///
/// Optional. If `true`, considers only cells with values as used cells (ignoring formatting). [Api set: ExcelApi 1.2]
///
}
Worksheet.prototype.getUsedRangeOrNullObject = function(valuesOnly) {
///
/// The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. If the entire worksheet is blank, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.4]
///
/// Optional. Considers only cells with values as used cells.
///
}
Worksheet.prototype.replaceAll = function(text, replacement, criteria) {
///
/// Finds and replaces the given string based on the criteria specified within the current worksheet. [Api set: ExcelApi 1.9]
///
/// String to find.
/// The string that replaces the original string.
/// Additional replacement criteria.
/// The number of replacements performed.
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
Worksheet.prototype.showOutlineLevels = function(rowLevels, columnLevels) {
///
/// 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. [Api set: ExcelApi 1.10]
///
/// The number of row levels of an outline to display.
/// The number of column levels of an outline to display.
///
}
Worksheet.prototype.onActivated = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet that raised the activated event.
///
var eventInfo = new Excel.Interfaces.WorksheetActivatedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
Worksheet.prototype.onCalculated = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet that raised the calculated event.
///
var eventInfo = new Excel.Interfaces.WorksheetCalculatedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
Worksheet.prototype.onChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet that raised the changed event.
///
var eventInfo = new Excel.Interfaces.WorksheetChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
Worksheet.prototype.onColumnSorted = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the column-sorted event and its related worksheet.
///
var eventInfo = new Excel.Interfaces.WorksheetColumnSortedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
Worksheet.prototype.onDeactivated = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet that raised the deactivated event.
///
var eventInfo = new Excel.Interfaces.WorksheetDeactivatedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
Worksheet.prototype.onFormatChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet format change event.
///
var eventInfo = new Excel.Interfaces.WorksheetFormatChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
Worksheet.prototype.onFormulaChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet and formulas that raised the formula changed event.
///
var eventInfo = new Excel.Interfaces.WorksheetFormulaChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
Worksheet.prototype.onNameChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet whose name has changed.
///
var eventInfo = new Excel.Interfaces.WorksheetNameChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
Worksheet.prototype.onProtectionChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet that raised the protection status changed event, which fires when the protection status is updated in a worksheet.
///
var eventInfo = new Excel.Interfaces.WorksheetProtectionChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
Worksheet.prototype.onRowHiddenChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet's row hidden change event.
///
var eventInfo = new Excel.Interfaces.WorksheetRowHiddenChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
Worksheet.prototype.onRowSorted = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the row-sorted event and its related worksheet.
///
var eventInfo = new Excel.Interfaces.WorksheetRowSortedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
Worksheet.prototype.onSelectionChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet that raised the selection changed event.
///
var eventInfo = new Excel.Interfaces.WorksheetSelectionChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
Worksheet.prototype.onSingleClicked = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the left-clicked/tapped event and its related worksheet.
///
var eventInfo = new Excel.Interfaces.WorksheetSingleClickedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
Worksheet.prototype.onVisibilityChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet whose visibility has changed.
///
var eventInfo = new Excel.Interfaces.WorksheetVisibilityChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
return Worksheet;
})(OfficeExtension.ClientObject);
Excel.Worksheet = Worksheet;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorksheetActivatedEventArgs = (function() {
function WorksheetActivatedEventArgs() {
/// Provides information about the worksheet that raised the activated event. [Api set: ExcelApi 1.7]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.7]
/// Gets the ID of the worksheet that is activated. [Api set: ExcelApi 1.7]
}
return WorksheetActivatedEventArgs;
})();
Interfaces.WorksheetActivatedEventArgs.__proto__ = null;
Interfaces.WorksheetActivatedEventArgs = WorksheetActivatedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorksheetAddedEventArgs = (function() {
function WorksheetAddedEventArgs() {
/// Provides information about the worksheet that raised the added event. [Api set: ExcelApi 1.7]
/// Gets the source of the event. See `Excel.EventSource` for details. [Api set: ExcelApi 1.7]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.7]
/// Gets the ID of the worksheet that is added to the workbook. [Api set: ExcelApi 1.7]
}
return WorksheetAddedEventArgs;
})();
Interfaces.WorksheetAddedEventArgs.__proto__ = null;
Interfaces.WorksheetAddedEventArgs = WorksheetAddedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorksheetCalculatedEventArgs = (function() {
function WorksheetCalculatedEventArgs() {
/// Provides information about the worksheet that raised the calculated event. [Api set: ExcelApi 1.8]
/// The address of the range that completed calculation. If multiple ranges completed calculation, the string is a comma-separated list of those range addresses. [Api set: ExcelApi 1.11]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.8]
/// Gets the ID of the worksheet in which the calculation occurred. [Api set: ExcelApi 1.8]
}
return WorksheetCalculatedEventArgs;
})();
Interfaces.WorksheetCalculatedEventArgs.__proto__ = null;
Interfaces.WorksheetCalculatedEventArgs = WorksheetCalculatedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorksheetChangedEventArgs = (function() {
function WorksheetChangedEventArgs() {
/// Provides information about the worksheet that raised the changed event. [Api set: ExcelApi 1.7]
/// Gets the range address that represents the changed area of a specific worksheet. [Api set: ExcelApi 1.7]
/// Gets the change type that represents how the changed event is triggered. See `Excel.DataChangeType` for details. [Api set: ExcelApi 1.7]
/// Represents the information about the change detail. This property can be retrieved when the changed event is triggered on a single cell. If the changed event is triggered on multiple cells, this property cannot be retrieved. [Api set: ExcelApi 1.9]
/// Gets the source of the event. See `Excel.EventSource` for details. [Api set: ExcelApi 1.7]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.7]
/// Gets the ID of the worksheet in which the data changed. [Api set: ExcelApi 1.7]
/// Represents a change to the direction that the cells in a worksheet will shift when a cell or cells are deleted or inserted. This includes the following two scenarios. 1. The direction (such as down or to the right) that existing cells will shift when a new cell or cells are inserted into a worksheet. 2. The direction (such as up or to the left) that the remaining cells will shift when a cell or cells are deleted from a worksheet. [Api set: ExcelApi 1.14]
/// Represents the trigger source of the event. For example, identifies whether this local add-in triggers the event. [Api set: ExcelApi 1.14]
}
return WorksheetChangedEventArgs;
})();
Interfaces.WorksheetChangedEventArgs.__proto__ = null;
Interfaces.WorksheetChangedEventArgs = WorksheetChangedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var WorksheetCollection = (function(_super) {
__extends(WorksheetCollection, _super);
function WorksheetCollection() {
/// Represents a collection of worksheet objects that are part of the workbook. [Api set: ExcelApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Occurs when any worksheet in the workbook is activated. [Api set: ExcelApi 1.7]
/// Occurs when a new worksheet is added to the workbook. [Api set: ExcelApi 1.7]
/// Occurs when any worksheet in the workbook is calculated. [Api set: ExcelApi 1.8]
/// Occurs when any worksheet in the workbook is changed. [Api set: ExcelApi 1.9]
/// Occurs when one or more columns have been sorted. This happens as the result of a left-to-right sort operation. [Api set: ExcelApi 1.10]
/// Occurs when any worksheet in the workbook is deactivated. [Api set: ExcelApi 1.7]
/// Occurs when a worksheet is deleted from the workbook. [Api set: ExcelApi 1.7]
/// Occurs when any worksheet in the workbook has a format changed. [Api set: ExcelApi 1.9]
/// Occurs when one or more formulas are changed in any worksheet of this collection. This event is for when the formula itself changes, not the data value resulting from the formula's calculation. [Api set: ExcelApi 1.13]
/// Occurs when a worksheet is moved by a user within a workbook. [Api set: ExcelApiOnline 1.1]
/// Occurs when the worksheet name is changed in the worksheet collection. [Api set: ExcelApiOnline 1.1]
/// Occurs when the worksheet protection state is changed. [Api set: ExcelApi 1.14]
/// Occurs when the hidden state of one or more rows has changed on a specific worksheet. [Api set: ExcelApi 1.11]
/// Occurs when one or more rows have been sorted. This happens as the result of a top-to-bottom sort operation. [Api set: ExcelApi 1.10]
/// Occurs when the selection changes on any worksheet. [Api set: ExcelApi 1.9]
/// Occurs when left-clicked/tapped operation happens in the worksheet collection. This event will not be fired when clicking in the following cases: - The user drags the mouse for multi-selection. - The user selects a cell in the mode when cell arguments are selected for formula references. [Api set: ExcelApi 1.10]
/// Occurs when the worksheet visibility is changed in the worksheet collection. [Api set: ExcelApiOnline 1.1]
/// Gets the loaded child items in this collection.
}
WorksheetCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
WorksheetCollection.prototype.add = function(name) {
///
/// 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. [Api set: ExcelApi 1.1]
///
/// 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.
///
}
WorksheetCollection.prototype.getActiveWorksheet = function() {
///
/// Gets the currently active worksheet in the workbook. [Api set: ExcelApi 1.1]
///
///
}
WorksheetCollection.prototype.getCount = function(visibleOnly) {
///
/// Gets the number of worksheets in the collection. [Api set: ExcelApi 1.4]
///
/// Optional. If `true`, considers only visible worksheets, skipping over any hidden ones.
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
WorksheetCollection.prototype.getFirst = function(visibleOnly) {
///
/// Gets the first worksheet in the collection. [Api set: ExcelApi 1.5]
///
/// Optional. If `true`, considers only visible worksheets, skipping over any hidden ones.
///
}
WorksheetCollection.prototype.getItem = function(key) {
///
/// Gets a worksheet object using its name or ID. [Api set: ExcelApi 1.1]
///
/// The name or ID of the worksheet.
///
}
WorksheetCollection.prototype.getItemOrNullObject = function(key) {
///
/// Gets a worksheet object using its name or ID. If the worksheet does not exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.4]
///
/// The name or ID of the worksheet.
///
}
WorksheetCollection.prototype.getLast = function(visibleOnly) {
///
/// Gets the last worksheet in the collection. [Api set: ExcelApi 1.5]
///
/// Optional. If `true`, considers only visible worksheets, skipping over any hidden ones.
///
}
WorksheetCollection.prototype.onActivated = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet that raised the activated event.
///
var eventInfo = new Excel.Interfaces.WorksheetActivatedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
WorksheetCollection.prototype.onAdded = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet that raised the added event.
///
var eventInfo = new Excel.Interfaces.WorksheetAddedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
WorksheetCollection.prototype.onCalculated = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet that raised the calculated event.
///
var eventInfo = new Excel.Interfaces.WorksheetCalculatedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
WorksheetCollection.prototype.onChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet that raised the changed event.
///
var eventInfo = new Excel.Interfaces.WorksheetChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
WorksheetCollection.prototype.onColumnSorted = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the column-sorted event and its related worksheet.
///
var eventInfo = new Excel.Interfaces.WorksheetColumnSortedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
WorksheetCollection.prototype.onDeactivated = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet that raised the deactivated event.
///
var eventInfo = new Excel.Interfaces.WorksheetDeactivatedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
WorksheetCollection.prototype.onDeleted = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet that raised the deleted event.
///
var eventInfo = new Excel.Interfaces.WorksheetDeletedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
WorksheetCollection.prototype.onFormatChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet format change event.
///
var eventInfo = new Excel.Interfaces.WorksheetFormatChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
WorksheetCollection.prototype.onFormulaChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet and formulas that raised the formula changed event.
///
var eventInfo = new Excel.Interfaces.WorksheetFormulaChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
WorksheetCollection.prototype.onMoved = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Notifies when a worksheet is moved within a workbook. If a worksheet is moved from one position within the workbook to another via the Excel UI, then this API will trigger an event. Note that if the position of a worksheet changes as a result of moving a different worksheet, then this event won't trigger for both position changes. This event only triggers for the primary worksheet move, and not any worksheet position changes that occur as a result of that primary move.
///
var eventInfo = new Excel.Interfaces.WorksheetMovedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
WorksheetCollection.prototype.onNameChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet whose name has changed.
///
var eventInfo = new Excel.Interfaces.WorksheetNameChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
WorksheetCollection.prototype.onProtectionChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet that raised the protection status changed event, which fires when the protection status is updated in a worksheet.
///
var eventInfo = new Excel.Interfaces.WorksheetProtectionChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
WorksheetCollection.prototype.onRowHiddenChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet's row hidden change event.
///
var eventInfo = new Excel.Interfaces.WorksheetRowHiddenChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
WorksheetCollection.prototype.onRowSorted = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the row-sorted event and its related worksheet.
///
var eventInfo = new Excel.Interfaces.WorksheetRowSortedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
WorksheetCollection.prototype.onSelectionChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet that raised the selection changed event.
///
var eventInfo = new Excel.Interfaces.WorksheetSelectionChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
WorksheetCollection.prototype.onSingleClicked = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the left-clicked/tapped event and its related worksheet.
///
var eventInfo = new Excel.Interfaces.WorksheetSingleClickedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
WorksheetCollection.prototype.onVisibilityChanged = {
__proto__: null,
add: function (handler) {
/// Handler for the event. EventArgs: Provides information about the worksheet whose visibility has changed.
///
var eventInfo = new Excel.Interfaces.WorksheetVisibilityChangedEventArgs();
eventInfo.__proto__ = null;
handler(eventInfo);
},
remove: function (handler) {
/// Handler for the event.
return;
}
};
return WorksheetCollection;
})(OfficeExtension.ClientObject);
Excel.WorksheetCollection = WorksheetCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorksheetColumnSortedEventArgs = (function() {
function WorksheetColumnSortedEventArgs() {
/// Provides information about the column-sorted event and its related worksheet. [Api set: ExcelApi 1.10]
/// Gets the range address that represents the sorted areas of a specific worksheet. Only columns changed as a result of the sort operation are returned. [Api set: ExcelApi 1.10]
/// Gets the source of the event. See `Excel.EventSource` for details. [Api set: ExcelApi 1.10]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.10]
/// Gets the ID of the worksheet where the sorting happened. [Api set: ExcelApi 1.10]
}
return WorksheetColumnSortedEventArgs;
})();
Interfaces.WorksheetColumnSortedEventArgs.__proto__ = null;
Interfaces.WorksheetColumnSortedEventArgs = WorksheetColumnSortedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var WorksheetCustomProperty = (function(_super) {
__extends(WorksheetCustomProperty, _super);
function WorksheetCustomProperty() {
/// Represents a worksheet-level custom property. [Api set: ExcelApi 1.12]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// 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.) [Api set: ExcelApi 1.12]
/// Gets or sets the value of the custom property. [Api set: ExcelApi 1.12]
}
WorksheetCustomProperty.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
WorksheetCustomProperty.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Excel.Interfaces.WorksheetCustomPropertyUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing WorksheetCustomProperty object, with properties that have already been loaded and synced.
///
}
WorksheetCustomProperty.prototype.delete = function() {
///
/// Deletes the custom property. [Api set: ExcelApi 1.12]
///
///
}
return WorksheetCustomProperty;
})(OfficeExtension.ClientObject);
Excel.WorksheetCustomProperty = WorksheetCustomProperty;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var WorksheetCustomPropertyCollection = (function(_super) {
__extends(WorksheetCustomPropertyCollection, _super);
function WorksheetCustomPropertyCollection() {
/// Contains the collection of worksheet-level custom property. [Api set: ExcelApi 1.12]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
WorksheetCustomPropertyCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
WorksheetCustomPropertyCollection.prototype.add = function(key, value) {
///
/// Adds a new custom property that maps to the provided key. This overwrites existing custom properties with that key. [Api set: ExcelApi 1.12]
///
/// 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.)
/// The value of this custom property.
///
}
WorksheetCustomPropertyCollection.prototype.getCount = function() {
///
/// Gets the number of custom properties on this worksheet. [Api set: ExcelApi 1.12]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
WorksheetCustomPropertyCollection.prototype.getItem = function(key) {
///
/// Gets a custom property object by its key, which is case-insensitive. Throws an error if the custom property does not exist. [Api set: ExcelApi 1.12]
///
/// The key that identifies the custom property object. It is case-insensitive.
///
}
WorksheetCustomPropertyCollection.prototype.getItemOrNullObject = function(key) {
///
/// Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.12]
///
/// The key that identifies the custom property object. It is case-insensitive.
///
}
return WorksheetCustomPropertyCollection;
})(OfficeExtension.ClientObject);
Excel.WorksheetCustomPropertyCollection = WorksheetCustomPropertyCollection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorksheetDeactivatedEventArgs = (function() {
function WorksheetDeactivatedEventArgs() {
/// Provides information about the worksheet that raised the deactivated event. [Api set: ExcelApi 1.7]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.7]
/// Gets the ID of the worksheet that is deactivated. [Api set: ExcelApi 1.7]
}
return WorksheetDeactivatedEventArgs;
})();
Interfaces.WorksheetDeactivatedEventArgs.__proto__ = null;
Interfaces.WorksheetDeactivatedEventArgs = WorksheetDeactivatedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorksheetDeletedEventArgs = (function() {
function WorksheetDeletedEventArgs() {
/// Provides information about the worksheet that raised the deleted event. [Api set: ExcelApi 1.7]
/// Gets the source of the event. See `Excel.EventSource` for details. [Api set: ExcelApi 1.7]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.7]
/// Gets the ID of the worksheet that is deleted from the workbook. [Api set: ExcelApi 1.7]
}
return WorksheetDeletedEventArgs;
})();
Interfaces.WorksheetDeletedEventArgs.__proto__ = null;
Interfaces.WorksheetDeletedEventArgs = WorksheetDeletedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorksheetFormatChangedEventArgs = (function() {
function WorksheetFormatChangedEventArgs() {
/// Provides information about the worksheet format change event. [Api set: ExcelApi 1.9]
/// Gets the range address that represents the changed area of a specific worksheet. [Api set: ExcelApi 1.9]
/// Gets the source of the event. See `Excel.EventSource` for details. [Api set: ExcelApi 1.9]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.9]
/// Gets the ID of the worksheet in which the data changed. [Api set: ExcelApi 1.9]
}
return WorksheetFormatChangedEventArgs;
})();
Interfaces.WorksheetFormatChangedEventArgs.__proto__ = null;
Interfaces.WorksheetFormatChangedEventArgs = WorksheetFormatChangedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorksheetFormulaChangedEventArgs = (function() {
function WorksheetFormulaChangedEventArgs() {
/// Provides information about the worksheet and formulas that raised the formula changed event. [Api set: ExcelApi 1.13]
/// Gets an array of `FormulaChangedEventDetail` objects, which contain the details about the all of the changed formulas. [Api set: ExcelApi 1.13]
/// The source of the event. It can be local or remote (through co-authoring). [Api set: ExcelApi 1.13]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.13]
/// Gets the ID of the worksheet in which the formula changed. [Api set: ExcelApi 1.13]
}
return WorksheetFormulaChangedEventArgs;
})();
Interfaces.WorksheetFormulaChangedEventArgs.__proto__ = null;
Interfaces.WorksheetFormulaChangedEventArgs = WorksheetFormulaChangedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var WorksheetFreezePanes = (function(_super) {
__extends(WorksheetFreezePanes, _super);
function WorksheetFreezePanes() {
/// [Api set: ExcelApi 1.7]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
}
WorksheetFreezePanes.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
WorksheetFreezePanes.prototype.freezeAt = function(frozenRange) {
///
/// 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. [Api set: ExcelApi 1.7]
///
/// A range that represents the cells to be frozen, or `null` to remove all frozen panes.
///
}
WorksheetFreezePanes.prototype.freezeColumns = function(count) {
///
/// Freeze the first column or columns of the worksheet in place. [Api set: ExcelApi 1.7]
///
/// Optional number of columns to freeze, or zero to unfreeze all columns
///
}
WorksheetFreezePanes.prototype.freezeRows = function(count) {
///
/// Freeze the top row or rows of the worksheet in place. [Api set: ExcelApi 1.7]
///
/// Optional number of rows to freeze, or zero to unfreeze all rows
///
}
WorksheetFreezePanes.prototype.getLocation = function() {
///
/// 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. [Api set: ExcelApi 1.7]
///
///
}
WorksheetFreezePanes.prototype.getLocationOrNullObject = function() {
///
/// 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 function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. [Api set: ExcelApi 1.7]
///
///
}
WorksheetFreezePanes.prototype.unfreeze = function() {
///
/// Removes all frozen panes in the worksheet. [Api set: ExcelApi 1.7]
///
///
}
return WorksheetFreezePanes;
})(OfficeExtension.ClientObject);
Excel.WorksheetFreezePanes = WorksheetFreezePanes;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorksheetMovedEventArgs = (function() {
function WorksheetMovedEventArgs() {
/// Notifies when a worksheet is moved within a workbook. If a worksheet is moved from one position within the workbook to another via the Excel UI, then this API will trigger an event. Note that if the position of a worksheet changes as a result of moving a different worksheet, then this event won't trigger for both position changes. This event only triggers for the primary worksheet move, and not any worksheet position changes that occur as a result of that primary move. [Api set: ExcelApiOnline 1.1]
/// Gets the new position of the worksheet, after the move. [Api set: ExcelApiOnline 1.1]
/// Gets the previous position of the worksheet, prior to the move. [Api set: ExcelApiOnline 1.1]
/// The source of the event. It can be local or remote (through co-authoring). [Api set: ExcelApiOnline 1.1]
/// Gets the type of the event. [Api set: ExcelApiOnline 1.1]
/// Gets the ID of the worksheet that was moved. [Api set: ExcelApiOnline 1.1]
}
return WorksheetMovedEventArgs;
})();
Interfaces.WorksheetMovedEventArgs.__proto__ = null;
Interfaces.WorksheetMovedEventArgs = WorksheetMovedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorksheetNameChangedEventArgs = (function() {
function WorksheetNameChangedEventArgs() {
/// Provides information about the worksheet whose name has changed. [Api set: ExcelApiOnline 1.1]
/// Gets the new name of the worksheet, after the name change. [Api set: ExcelApiOnline 1.1]
/// Gets the previous name of the worksheet, before the name changed. [Api set: ExcelApiOnline 1.1]
/// The source of the event. It can be local or remote (through co-authoring). [Api set: ExcelApiOnline 1.1]
/// Gets the type of the event. [Api set: ExcelApiOnline 1.1]
/// Gets the ID of the worksheet with the new name. [Api set: ExcelApiOnline 1.1]
}
return WorksheetNameChangedEventArgs;
})();
Interfaces.WorksheetNameChangedEventArgs.__proto__ = null;
Interfaces.WorksheetNameChangedEventArgs = WorksheetNameChangedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
/// [Api set: ExcelApi 1.7]
var WorksheetPositionType = {
__proto__: null,
"none": "none",
"before": "before",
"after": "after",
"beginning": "beginning",
"end": "end",
}
Excel.WorksheetPositionType = WorksheetPositionType;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var WorksheetProtection = (function(_super) {
__extends(WorksheetProtection, _super);
function WorksheetProtection() {
/// Represents the protection of a sheet object. [Api set: ExcelApi 1.2]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Specifies the protection options for the worksheet. [Api set: ExcelApi 1.2]
/// Specifies if the worksheet is protected. [Api set: ExcelApi 1.2]
}
WorksheetProtection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
WorksheetProtection.prototype.protect = function(options, password) {
///
/// Protects a worksheet. Fails if the worksheet has already been protected. [Api set: ExcelApi 1.2 for options; 1.7 for password]
///
/// Optional. Sheet protection options.
/// Optional. Sheet protection password.
///
}
WorksheetProtection.prototype.unprotect = function(password) {
///
/// Unprotects a worksheet. [Api set: ExcelApi 1.7 for password]
///
/// Sheet protection password.
///
}
return WorksheetProtection;
})(OfficeExtension.ClientObject);
Excel.WorksheetProtection = WorksheetProtection;
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorksheetProtectionChangedEventArgs = (function() {
function WorksheetProtectionChangedEventArgs() {
/// Provides information about the worksheet that raised the protection status changed event, which fires when the protection status is updated in a worksheet. [Api set: ExcelApi 1.14]
/// Gets the current protection status of the worksheet. [Api set: ExcelApi 1.14]
/// The source of the event. It can be local or remote (through co-authoring). [Api set: ExcelApi 1.14]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.14]
/// Gets the ID of the worksheet in which the protection status is changed. [Api set: ExcelApi 1.14]
}
return WorksheetProtectionChangedEventArgs;
})();
Interfaces.WorksheetProtectionChangedEventArgs.__proto__ = null;
Interfaces.WorksheetProtectionChangedEventArgs = WorksheetProtectionChangedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorksheetProtectionOptions = (function() {
function WorksheetProtectionOptions() {
/// Represents the options in sheet protection. [Api set: ExcelApi 1.2]
/// Represents the worksheet protection option allowing use of the AutoFilter feature. [Api set: ExcelApi 1.2]
/// Represents the worksheet protection option allowing deleting of columns. [Api set: ExcelApi 1.2]
/// Represents the worksheet protection option allowing deleting of rows. [Api set: ExcelApi 1.2]
/// Represents the worksheet protection option allowing editing of objects. [Api set: ExcelApi 1.7]
/// Represents the worksheet protection option allowing editing of scenarios. [Api set: ExcelApi 1.7]
/// Represents the worksheet protection option allowing formatting of cells. [Api set: ExcelApi 1.2]
/// Represents the worksheet protection option allowing formatting of columns. [Api set: ExcelApi 1.2]
/// Represents the worksheet protection option allowing formatting of rows. [Api set: ExcelApi 1.2]
/// Represents the worksheet protection option allowing inserting of columns. [Api set: ExcelApi 1.2]
/// Represents the worksheet protection option allowing inserting of hyperlinks. [Api set: ExcelApi 1.2]
/// Represents the worksheet protection option allowing inserting of rows. [Api set: ExcelApi 1.2]
/// Represents the worksheet protection option allowing use of the PivotTable feature. [Api set: ExcelApi 1.2]
/// Represents the worksheet protection option allowing use of the sort feature. [Api set: ExcelApi 1.2]
/// Represents the worksheet protection option of selection mode. [Api set: ExcelApi 1.7]
}
return WorksheetProtectionOptions;
})();
Interfaces.WorksheetProtectionOptions.__proto__ = null;
Interfaces.WorksheetProtectionOptions = WorksheetProtectionOptions;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorksheetRowHiddenChangedEventArgs = (function() {
function WorksheetRowHiddenChangedEventArgs() {
/// Provides information about the worksheet's row hidden change event. [Api set: ExcelApi 1.11]
/// Gets the range address that represents the changed area of a specific worksheet. [Api set: ExcelApi 1.11]
/// Gets the type of change that represents how the event was triggered. See `Excel.RowHiddenChangeType` for details. [Api set: ExcelApi 1.11]
/// Gets the source of the event. See `Excel.EventSource` for details. [Api set: ExcelApi 1.11]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.11]
/// Gets the ID of the worksheet in which the data changed. [Api set: ExcelApi 1.11]
}
return WorksheetRowHiddenChangedEventArgs;
})();
Interfaces.WorksheetRowHiddenChangedEventArgs.__proto__ = null;
Interfaces.WorksheetRowHiddenChangedEventArgs = WorksheetRowHiddenChangedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorksheetRowSortedEventArgs = (function() {
function WorksheetRowSortedEventArgs() {
/// Provides information about the row-sorted event and its related worksheet. [Api set: ExcelApi 1.10]
/// Gets the range address that represents the sorted areas of a specific worksheet. Only rows changed as a result of the sort operation are returned. [Api set: ExcelApi 1.10]
/// Gets the source of the event. See `Excel.EventSource` for details. [Api set: ExcelApi 1.10]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.10]
/// Gets the ID of the worksheet where the sorting happened. [Api set: ExcelApi 1.10]
}
return WorksheetRowSortedEventArgs;
})();
Interfaces.WorksheetRowSortedEventArgs.__proto__ = null;
Interfaces.WorksheetRowSortedEventArgs = WorksheetRowSortedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorksheetSearchCriteria = (function() {
function WorksheetSearchCriteria() {
/// Represents the worksheet search criteria to be used. [Api set: ExcelApi 1.9]
/// 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). [Api set: ExcelApi 1.9]
/// Specifies if the match is case-sensitive. Default is `false` (case-insensitive). [Api set: ExcelApi 1.9]
}
return WorksheetSearchCriteria;
})();
Interfaces.WorksheetSearchCriteria.__proto__ = null;
Interfaces.WorksheetSearchCriteria = WorksheetSearchCriteria;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorksheetSelectionChangedEventArgs = (function() {
function WorksheetSelectionChangedEventArgs() {
/// Provides information about the worksheet that raised the selection changed event. [Api set: ExcelApi 1.7]
/// Gets the range address that represents the selected area of a specific worksheet. [Api set: ExcelApi 1.7]
/// Gets the type of the event. See `Excel.EventType` for details. [Api set: ExcelApi 1.7]
/// Gets the ID of the worksheet in which the selection changed. [Api set: ExcelApi 1.7]
}
return WorksheetSelectionChangedEventArgs;
})();
Interfaces.WorksheetSelectionChangedEventArgs.__proto__ = null;
Interfaces.WorksheetSelectionChangedEventArgs = WorksheetSelectionChangedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorksheetSingleClickedEventArgs = (function() {
function WorksheetSingleClickedEventArgs() {
/// Provides information about the left-clicked/tapped event and its related worksheet. [Api set: ExcelApi 1.10]
/// Gets the address that represents the cell which was left-clicked/tapped for a specific worksheet. [Api set: ExcelApi 1.10]
/// The distance, in points, from the left-clicked/tapped point to the left (or right for right-to-left languages) gridline edge of the left-clicked/tapped cell. [Api set: ExcelApi 1.10]
/// The distance, in points, from the left-clicked/tapped point to the top gridline edge of the left-clicked/tapped cell. [Api set: ExcelApi 1.10]
/// Gets the type of the event. [Api set: ExcelApi 1.10]
/// Gets the ID of the worksheet in which the cell was left-clicked/tapped. [Api set: ExcelApi 1.10]
}
return WorksheetSingleClickedEventArgs;
})();
Interfaces.WorksheetSingleClickedEventArgs.__proto__ = null;
Interfaces.WorksheetSingleClickedEventArgs = WorksheetSingleClickedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorksheetVisibilityChangedEventArgs = (function() {
function WorksheetVisibilityChangedEventArgs() {
/// Provides information about the worksheet whose visibility has changed. [Api set: ExcelApiOnline 1.1]
/// The source of the event. It can be local or remote (through co-authoring). [Api set: ExcelApiOnline 1.1]
/// Gets the type of the event. [Api set: ExcelApiOnline 1.1]
/// Gets the new visibility setting of the worksheet, after the visibility change.n [Api set: ExcelApiOnline 1.1]
/// Gets the previous visibility setting of the worksheet, before the visibility change. [Api set: ExcelApiOnline 1.1]
/// Gets the ID of the worksheet whose visibility has changed. [Api set: ExcelApiOnline 1.1]
}
return WorksheetVisibilityChangedEventArgs;
})();
Interfaces.WorksheetVisibilityChangedEventArgs.__proto__ = null;
Interfaces.WorksheetVisibilityChangedEventArgs = WorksheetVisibilityChangedEventArgs;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var LinkedWorkbookCollectionUpdateData = (function() {
function LinkedWorkbookCollectionUpdateData() {
/// An interface for updating data on the LinkedWorkbookCollection object, for use in "linkedWorkbookCollection.set({ ... })".
/// Represents the update mode of the workbook links. The mode is same for all of the workbook links present in the workbook. [Api set: ExcelApiOnline 1.1];
}
return LinkedWorkbookCollectionUpdateData;
})();
Interfaces.LinkedWorkbookCollectionUpdateData.__proto__ = null;
Interfaces.LinkedWorkbookCollectionUpdateData = LinkedWorkbookCollectionUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var RuntimeUpdateData = (function() {
function RuntimeUpdateData() {
/// An interface for updating data on the Runtime object, for use in "runtime.set({ ... })".
/// Toggle JavaScript events in the current task pane or content add-in. [Api set: ExcelApi 1.8];
}
return RuntimeUpdateData;
})();
Interfaces.RuntimeUpdateData.__proto__ = null;
Interfaces.RuntimeUpdateData = RuntimeUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ApplicationUpdateData = (function() {
function ApplicationUpdateData() {
/// An interface for updating data on the Application object, for use in "application.set({ ... })".
/// 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. [Api set: ExcelApi 1.9]
/// Gets the ribbon of the application. [Api set: ExcelApi 1.9]
/// Returns the calculation mode used in the workbook, as defined by the constants in `Excel.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. [Api set: ExcelApi 1.1 for get, 1.8 for set];
}
return ApplicationUpdateData;
})();
Interfaces.ApplicationUpdateData.__proto__ = null;
Interfaces.ApplicationUpdateData = ApplicationUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var IterativeCalculationUpdateData = (function() {
function IterativeCalculationUpdateData() {
/// An interface for updating data on the IterativeCalculation object, for use in "iterativeCalculation.set({ ... })".
/// True if Excel will use iteration to resolve circular references. [Api set: ExcelApi 1.9];
/// Specifies the maximum amount of change between each iteration as Excel resolves circular references. [Api set: ExcelApi 1.9];
/// Specifies the maximum number of iterations that Excel can use to resolve a circular reference. [Api set: ExcelApi 1.9];
}
return IterativeCalculationUpdateData;
})();
Interfaces.IterativeCalculationUpdateData.__proto__ = null;
Interfaces.IterativeCalculationUpdateData = IterativeCalculationUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorkbookUpdateData = (function() {
function WorkbookUpdateData() {
/// An interface for updating data on the Workbook object, for use in "workbook.set({ ... })".
/// Gets the workbook properties. [Api set: ExcelApi 1.7]
/// 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. [Api set: ExcelApi 1.9];
/// 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. [Api set: ExcelApi 1.9];
/// 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`. [Api set: ExcelApi 1.9];
}
return WorkbookUpdateData;
})();
Interfaces.WorkbookUpdateData.__proto__ = null;
Interfaces.WorkbookUpdateData = WorkbookUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorksheetUpdateData = (function() {
function WorksheetUpdateData() {
/// An interface for updating data on the Worksheet object, for use in "worksheet.set({ ... })".
/// Gets the `PageLayout` object of the worksheet. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9];
/// The display name of the worksheet. [Api set: ExcelApi 1.1];
/// The zero-based position of the worksheet within the workbook. [Api set: ExcelApi 1.1];
/// Specifies if gridlines are visible to the user. [Api set: ExcelApi 1.8];
/// Specifies if headings are visible to the user. [Api set: ExcelApi 1.8];
/// 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. [Api set: ExcelApi 1.7];
/// 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. [Api set: ExcelApi 1.7];
/// The visibility of the worksheet. [Api set: ExcelApi 1.1 for reading visibility; 1.2 for setting it.];
}
return WorksheetUpdateData;
})();
Interfaces.WorksheetUpdateData.__proto__ = null;
Interfaces.WorksheetUpdateData = WorksheetUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var RangeUpdateData = (function() {
function RangeUpdateData() {
/// An interface for updating data on the Range object, for use in "range.set({ ... })".
/// Returns a data validation object. [Api set: ExcelApi 1.8]
/// Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties. [Api set: ExcelApi 1.1]
/// 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. [Api set: ExcelApi 1.2];
/// Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead. [Api set: ExcelApi 1.1];
/// 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. [Api set: ExcelApi 1.1];
/// Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead. [Api set: ExcelApi 1.2];
/// Represents the hyperlink for the current range. [Api set: ExcelApi 1.7];
/// Represents Excel's number format code for the given range. [Api set: ExcelApi 1.1];
/// 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. [Api set: ExcelApi 1.7];
/// 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. [Api set: ExcelApi 1.2];
/// 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. [Api set: ExcelApi 1.7];
/// 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. [Api set: ExcelApi 1.1];
}
return RangeUpdateData;
})();
Interfaces.RangeUpdateData.__proto__ = null;
Interfaces.RangeUpdateData = RangeUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var RangeAreasUpdateData = (function() {
function RangeAreasUpdateData() {
/// An interface for updating data on the RangeAreas object, for use in "rangeAreas.set({ ... })".
/// Returns a data validation object for all ranges in the `RangeAreas`. [Api set: ExcelApi 1.9]
/// Returns a `RangeFormat` object, encapsulating the the font, fill, borders, alignment, and other properties for all ranges in the `RangeAreas` object. [Api set: ExcelApi 1.9]
/// 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. [Api set: ExcelApi 1.9];
}
return RangeAreasUpdateData;
})();
Interfaces.RangeAreasUpdateData.__proto__ = null;
Interfaces.RangeAreasUpdateData = RangeAreasUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var RangeViewUpdateData = (function() {
function RangeViewUpdateData() {
/// An interface for updating data on the RangeView object, for use in "rangeView.set({ ... })".
/// Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead. [Api set: ExcelApi 1.3];
/// 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. [Api set: ExcelApi 1.3];
/// Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead. [Api set: ExcelApi 1.3];
/// Represents Excel's number format code for the given cell. [Api set: ExcelApi 1.3];
/// 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. [Api set: ExcelApi 1.3];
}
return RangeViewUpdateData;
})();
Interfaces.RangeViewUpdateData.__proto__ = null;
Interfaces.RangeViewUpdateData = RangeViewUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var SettingUpdateData = (function() {
function SettingUpdateData() {
/// An interface for updating data on the Setting object, for use in "setting.set({ ... })".
/// Represents the value stored for this setting. [Api set: ExcelApi 1.4];
}
return SettingUpdateData;
})();
Interfaces.SettingUpdateData.__proto__ = null;
Interfaces.SettingUpdateData = SettingUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var NamedItemUpdateData = (function() {
function NamedItemUpdateData() {
/// An interface for updating data on the NamedItem object, for use in "namedItem.set({ ... })".
/// Specifies the comment associated with this name. [Api set: ExcelApi 1.4];
/// The formula of the named item. Formulas always start with an equal sign ("="). [Api set: ExcelApi 1.7];
/// Specifies if the object is visible. [Api set: ExcelApi 1.1];
}
return NamedItemUpdateData;
})();
Interfaces.NamedItemUpdateData.__proto__ = null;
Interfaces.NamedItemUpdateData = NamedItemUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var TableUpdateData = (function() {
function TableUpdateData() {
/// An interface for updating data on the Table object, for use in "table.set({ ... })".
/// Specifies if the first column contains special formatting. [Api set: ExcelApi 1.3];
/// Specifies if the last column contains special formatting. [Api set: ExcelApi 1.3];
/// Name of the table. The set name of the table must follow the guidelines specified in the {@link https://support.office.com/article/Rename-an-Excel-table-FBF49A4F-82A3-43EB-8BA2-44D21233B114 | Rename an Excel table} article. [Api set: ExcelApi 1.1];
/// Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier. [Api set: ExcelApi 1.3];
/// Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier. [Api set: ExcelApi 1.3];
/// 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. [Api set: ExcelApi 1.3];
/// Specifies if the header row is visible. This value can be set to show or remove the header row. [Api set: ExcelApi 1.1];
/// Specifies if the total row is visible. This value can be set to show or remove the total row. [Api set: ExcelApi 1.1];
/// 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. [Api set: ExcelApi 1.1];
}
return TableUpdateData;
})();
Interfaces.TableUpdateData.__proto__ = null;
Interfaces.TableUpdateData = TableUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var TableColumnUpdateData = (function() {
function TableColumnUpdateData() {
/// An interface for updating data on the TableColumn object, for use in "tableColumn.set({ ... })".
/// Specifies the name of the table column. [Api set: ExcelApi 1.1 for getting the name; 1.4 for setting it.];
/// 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. [Api set: ExcelApi 1.1];
}
return TableColumnUpdateData;
})();
Interfaces.TableColumnUpdateData.__proto__ = null;
Interfaces.TableColumnUpdateData = TableColumnUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var TableRowUpdateData = (function() {
function TableRowUpdateData() {
/// An interface for updating data on the TableRow object, for use in "tableRow.set({ ... })".
/// 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. [Api set: ExcelApi 1.1];
}
return TableRowUpdateData;
})();
Interfaces.TableRowUpdateData.__proto__ = null;
Interfaces.TableRowUpdateData = TableRowUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var DataValidationUpdateData = (function() {
function DataValidationUpdateData() {
/// An interface for updating data on the DataValidation object, for use in "dataValidation.set({ ... })".
/// Error alert when user enters invalid data. [Api set: ExcelApi 1.8];
/// Specifies if data validation will be performed on blank cells. Default is `true`. [Api set: ExcelApi 1.8];
/// Prompt when users select a cell. [Api set: ExcelApi 1.8];
/// Data validation rule that contains different type of data validation criteria. [Api set: ExcelApi 1.8];
}
return DataValidationUpdateData;
})();
Interfaces.DataValidationUpdateData.__proto__ = null;
Interfaces.DataValidationUpdateData = DataValidationUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var RangeFormatUpdateData = (function() {
function RangeFormatUpdateData() {
/// An interface for updating data on the RangeFormat object, for use in "rangeFormat.set({ ... })".
/// Collection of border objects that apply to the overall range. [Api set: ExcelApi 1.1]
/// Returns the fill object defined on the overall range. [Api set: ExcelApi 1.1]
/// Returns the font object defined on the overall range. [Api set: ExcelApi 1.1]
/// Returns the format protection object for a range. [Api set: ExcelApi 1.2]
/// Specifies if text is automatically indented when text alignment is set to equal distribution. [Api set: ExcelApi 1.9];
/// Specifies the width of all colums within the range. If the column widths are not uniform, `null` will be returned. [Api set: ExcelApi 1.2];
/// Represents the horizontal alignment for the specified object. See `Excel.HorizontalAlignment` for details. [Api set: ExcelApi 1.1];
/// An integer from 0 to 250 that indicates the indent level. [Api set: ExcelApi 1.9];
/// The reading order for the range. [Api set: ExcelApi 1.9];
/// The height of all rows in the range. If the row heights are not uniform, `null` will be returned. [Api set: ExcelApi 1.2];
/// Specifies if text automatically shrinks to fit in the available column width. [Api set: ExcelApi 1.9];
/// 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. [Api set: ExcelApi 1.7];
/// 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. Note: This property is only intended to be set to `true`. Setting it to `false` has no effect. [Api set: ExcelApi 1.7];
/// 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. Note: This property is only intended to be set to `true`. Setting it to `false` has no effect. [Api set: ExcelApi 1.7];
/// Represents the vertical alignment for the specified object. See `Excel.VerticalAlignment` for details. [Api set: ExcelApi 1.1];
/// Specifies if Excel wraps the text in the object. A `null` value indicates that the entire range doesn't have a uniform wrap setting [Api set: ExcelApi 1.1];
}
return RangeFormatUpdateData;
})();
Interfaces.RangeFormatUpdateData.__proto__ = null;
Interfaces.RangeFormatUpdateData = RangeFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var FormatProtectionUpdateData = (function() {
function FormatProtectionUpdateData() {
/// An interface for updating data on the FormatProtection object, for use in "formatProtection.set({ ... })".
/// 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. [Api set: ExcelApi 1.2];
/// Specifies if Excel locks the cells in the object. A `null` value indicates that the entire range doesn't have a uniform lock setting. [Api set: ExcelApi 1.2];
}
return FormatProtectionUpdateData;
})();
Interfaces.FormatProtectionUpdateData.__proto__ = null;
Interfaces.FormatProtectionUpdateData = FormatProtectionUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var RangeFillUpdateData = (function() {
function RangeFillUpdateData() {
/// An interface for updating data on the RangeFill object, for use in "rangeFill.set({ ... })".
/// 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") [Api set: ExcelApi 1.1];
/// The pattern of a range. See `Excel.FillPattern` for details. LinearGradient and RectangularGradient are not supported. A `null` value indicates that the entire range doesn't have a uniform pattern setting. [Api set: ExcelApi 1.9];
/// 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"). [Api set: ExcelApi 1.9];
/// 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. [Api set: ExcelApi 1.9];
/// 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. [Api set: ExcelApi 1.9];
}
return RangeFillUpdateData;
})();
Interfaces.RangeFillUpdateData.__proto__ = null;
Interfaces.RangeFillUpdateData = RangeFillUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var RangeBorderUpdateData = (function() {
function RangeBorderUpdateData() {
/// An interface for updating data on the RangeBorder object, for use in "rangeBorder.set({ ... })".
/// 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"). [Api set: ExcelApi 1.1];
/// One of the constants of line style specifying the line style for the border. See `Excel.BorderLineStyle` for details. [Api set: ExcelApi 1.1];
/// 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. [Api set: ExcelApi 1.9];
/// Specifies the weight of the border around a range. See `Excel.BorderWeight` for details. [Api set: ExcelApi 1.1];
}
return RangeBorderUpdateData;
})();
Interfaces.RangeBorderUpdateData.__proto__ = null;
Interfaces.RangeBorderUpdateData = RangeBorderUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var RangeBorderCollectionUpdateData = (function() {
function RangeBorderCollectionUpdateData() {
/// An interface for updating data on the RangeBorderCollection object, for use in "rangeBorderCollection.set({ ... })".
/// 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. [Api set: ExcelApi 1.9];
}
return RangeBorderCollectionUpdateData;
})();
Interfaces.RangeBorderCollectionUpdateData.__proto__ = null;
Interfaces.RangeBorderCollectionUpdateData = RangeBorderCollectionUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var RangeFontUpdateData = (function() {
function RangeFontUpdateData() {
/// An interface for updating data on the RangeFont object, for use in "rangeFont.set({ ... })".
/// Represents the bold status of the font. [Api set: ExcelApi 1.1];
/// HTML color code representation of the text color (e.g., #FF0000 represents Red). [Api set: ExcelApi 1.1];
/// Specifies the italic status of the font. [Api set: ExcelApi 1.1];
/// Font name (e.g., "Calibri"). The name's length should not be greater than 31 characters. [Api set: ExcelApi 1.1];
/// Font size. [Api set: ExcelApi 1.1];
/// Specifies the strikethrough status of font. A `null` value indicates that the entire range doesn't have a uniform strikethrough setting. [Api set: ExcelApi 1.9];
/// 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. [Api set: ExcelApi 1.9];
/// 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. [Api set: ExcelApi 1.9];
/// 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. [Api set: ExcelApi 1.9];
/// Type of underline applied to the font. See `Excel.RangeUnderlineStyle` for details. [Api set: ExcelApi 1.1];
}
return RangeFontUpdateData;
})();
Interfaces.RangeFontUpdateData.__proto__ = null;
Interfaces.RangeFontUpdateData = RangeFontUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartUpdateData = (function() {
function ChartUpdateData() {
/// An interface for updating data on the Chart object, for use in "chart.set({ ... })".
/// Represents chart axes. [Api set: ExcelApi 1.1]
/// Represents the data labels on the chart. [Api set: ExcelApi 1.1]
/// Encapsulates the format properties for the chart area. [Api set: ExcelApi 1.1]
/// Represents the legend for the chart. [Api set: ExcelApi 1.1]
/// Encapsulates the options for a pivot chart. [Api set: ExcelApi 1.9]
/// Represents the plot area for the chart. [Api set: ExcelApi 1.8]
/// Represents the title of the specified chart, including the text, visibility, position, and formatting of the title. [Api set: ExcelApi 1.1]
/// Specifies a chart category label level enumeration constant, referring to the level of the source category labels. [Api set: ExcelApi 1.8];
/// Specifies the type of the chart. See `Excel.ChartType` for details. [Api set: ExcelApi 1.7];
/// Specifies the way that blank cells are plotted on a chart. [Api set: ExcelApi 1.8];
/// Specifies the height, in points, of the chart object. [Api set: ExcelApi 1.1];
/// The distance, in points, from the left side of the chart to the worksheet origin. [Api set: ExcelApi 1.1];
/// Specifies the name of a chart object. [Api set: ExcelApi 1.1];
/// Specifies the way columns or rows are used as data series on the chart. [Api set: ExcelApi 1.8];
/// True if only visible cells are plotted. False if both visible and hidden cells are plotted. [Api set: ExcelApi 1.8];
/// Specifies a chart series name level enumeration constant, referring to the level of the source series names. [Api set: ExcelApi 1.8];
/// Specifies whether to display all field buttons on a PivotChart. [Api set: ExcelApi 1.7];
/// 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. [Api set: ExcelApi 1.8];
/// Specifies the chart style for the chart. [Api set: ExcelApi 1.8];
/// 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). [Api set: ExcelApi 1.1];
/// Specifies the width, in points, of the chart object. [Api set: ExcelApi 1.1];
}
return ChartUpdateData;
})();
Interfaces.ChartUpdateData.__proto__ = null;
Interfaces.ChartUpdateData = ChartUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartPivotOptionsUpdateData = (function() {
function ChartPivotOptionsUpdateData() {
/// An interface for updating data on the ChartPivotOptions object, for use in "chartPivotOptions.set({ ... })".
/// 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. [Api set: ExcelApi 1.9];
/// Specifies whether to display the legend field buttons on a PivotChart. [Api set: ExcelApi 1.9];
/// Specifies whether to display the report filter field buttons on a PivotChart. [Api set: ExcelApi 1.9];
/// Specifies whether to display the show value field buttons on a PivotChart. [Api set: ExcelApi 1.9];
}
return ChartPivotOptionsUpdateData;
})();
Interfaces.ChartPivotOptionsUpdateData.__proto__ = null;
Interfaces.ChartPivotOptionsUpdateData = ChartPivotOptionsUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartAreaFormatUpdateData = (function() {
function ChartAreaFormatUpdateData() {
/// An interface for updating data on the ChartAreaFormat object, for use in "chartAreaFormat.set({ ... })".
/// Represents the border format of chart area, which includes color, linestyle, and weight. [Api set: ExcelApi 1.7]
/// Represents the font attributes (font name, font size, color, etc.) for the current object. [Api set: ExcelApi 1.1]
/// Specifies the color scheme of the chart. [Api set: ExcelApi 1.9];
/// Specifies if the chart area of the chart has rounded corners. [Api set: ExcelApi 1.9];
}
return ChartAreaFormatUpdateData;
})();
Interfaces.ChartAreaFormatUpdateData.__proto__ = null;
Interfaces.ChartAreaFormatUpdateData = ChartAreaFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartSeriesUpdateData = (function() {
function ChartSeriesUpdateData() {
/// An interface for updating data on the ChartSeries object, for use in "chartSeries.set({ ... })".
/// Encapsulates the bin options for histogram charts and pareto charts. [Api set: ExcelApi 1.9]
/// Encapsulates the options for the box and whisker charts. [Api set: ExcelApi 1.9]
/// Represents a collection of all data labels in the series. [Api set: ExcelApi 1.8]
/// Represents the formatting of a chart series, which includes fill and line formatting. [Api set: ExcelApi 1.1]
/// Encapsulates the options for a region map chart. [Api set: ExcelApi 1.9]
/// Represents the error bar object of a chart series. [Api set: ExcelApi 1.9]
/// Represents the error bar object of a chart series. [Api set: ExcelApi 1.9]
/// Specifies the group for the specified series. [Api set: ExcelApi 1.8];
/// 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. [Api set: ExcelApi 1.9];
/// Represents the chart type of a series. See `Excel.ChartType` for details. [Api set: ExcelApi 1.7];
/// Represents the doughnut hole size of a chart series. Only valid on doughnut and doughnut exploded charts. Throws an `InvalidArgument` error on invalid charts. [Api set: ExcelApi 1.7];
/// 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). [Api set: ExcelApi 1.8];
/// Specifies if the series is filtered. Not applicable for surface charts. [Api set: ExcelApi 1.7];
/// 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. [Api set: ExcelApi 1.8];
/// 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. [Api set: ExcelApi 1.7];
/// Specifies the color for maximum value of a region map chart series. [Api set: ExcelApi 1.9];
/// Specifies the type for maximum value of a region map chart series. [Api set: ExcelApi 1.9];
/// Specifies the maximum value of a region map chart series. [Api set: ExcelApi 1.9];
/// Specifies the color for the midpoint value of a region map chart series. [Api set: ExcelApi 1.9];
/// Specifies the type for the midpoint value of a region map chart series. [Api set: ExcelApi 1.9];
/// Specifies the midpoint value of a region map chart series. [Api set: ExcelApi 1.9];
/// Specifies the color for the minimum value of a region map chart series. [Api set: ExcelApi 1.9];
/// Specifies the type for the minimum value of a region map chart series. [Api set: ExcelApi 1.9];
/// Specifies the minimum value of a region map chart series. [Api set: ExcelApi 1.9];
/// Specifies the series gradient style of a region map chart. [Api set: ExcelApi 1.9];
/// Specifies if the series has data labels. [Api set: ExcelApi 1.7];
/// Specifies the fill color for negative data points in a series. [Api set: ExcelApi 1.9];
/// True if Excel inverts the pattern in the item when it corresponds to a negative number. [Api set: ExcelApi 1.8];
/// Specifies the marker background color of a chart series. [Api set: ExcelApi 1.7];
/// Specifies the marker foreground color of a chart series. [Api set: ExcelApi 1.7];
/// Specifies the marker size of a chart series. [Api set: ExcelApi 1.7];
/// Specifies the marker style of a chart series. See `Excel.ChartMarkerStyle` for details. [Api set: ExcelApi 1.7];
/// Specifies the name of a series in a chart. The name's length should not be greater than 255 characters. [Api set: ExcelApi 1.1];
/// 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. [Api set: ExcelApi 1.8];
/// Specifies the series parent label strategy area for a treemap chart. [Api set: ExcelApi 1.9];
/// Specifies the plot order of a chart series within the chart group. [Api set: ExcelApi 1.7];
/// 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. [Api set: ExcelApi 1.8];
/// Specifies whether connector lines are shown in waterfall charts. [Api set: ExcelApi 1.9];
/// Specifies whether leader lines are displayed for each data label in the series. [Api set: ExcelApi 1.9];
/// Specifies if the series has a shadow. [Api set: ExcelApi 1.7];
/// Specifies if the series is smooth. Only applicable to line and scatter charts. [Api set: ExcelApi 1.7];
/// Specifies the way the two sections of either a pie-of-pie chart or a bar-of-pie chart are split. [Api set: ExcelApi 1.8];
/// Specifies the threshold value that separates two sections of either a pie-of-pie chart or a bar-of-pie chart. [Api set: ExcelApi 1.9];
/// True if Excel assigns a different color or pattern to each data marker. The chart must contain only one series. [Api set: ExcelApi 1.8];
}
return ChartSeriesUpdateData;
})();
Interfaces.ChartSeriesUpdateData.__proto__ = null;
Interfaces.ChartSeriesUpdateData = ChartSeriesUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartSeriesFormatUpdateData = (function() {
function ChartSeriesFormatUpdateData() {
/// An interface for updating data on the ChartSeriesFormat object, for use in "chartSeriesFormat.set({ ... })".
/// Represents line formatting. [Api set: ExcelApi 1.1]
}
return ChartSeriesFormatUpdateData;
})();
Interfaces.ChartSeriesFormatUpdateData.__proto__ = null;
Interfaces.ChartSeriesFormatUpdateData = ChartSeriesFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartPointUpdateData = (function() {
function ChartPointUpdateData() {
/// An interface for updating data on the ChartPoint object, for use in "chartPoint.set({ ... })".
/// Returns the data label of a chart point. [Api set: ExcelApi 1.7]
/// Encapsulates the format properties chart point. [Api set: ExcelApi 1.1]
/// Represents whether a data point has a data label. Not applicable for surface charts. [Api set: ExcelApi 1.7];
/// HTML color code representation of the marker background color of a data point (e.g., #FF0000 represents Red). [Api set: ExcelApi 1.7];
/// HTML color code representation of the marker foreground color of a data point (e.g., #FF0000 represents Red). [Api set: ExcelApi 1.7];
/// Represents marker size of a data point. [Api set: ExcelApi 1.7];
/// Represents marker style of a chart data point. See `Excel.ChartMarkerStyle` for details. [Api set: ExcelApi 1.7];
}
return ChartPointUpdateData;
})();
Interfaces.ChartPointUpdateData.__proto__ = null;
Interfaces.ChartPointUpdateData = ChartPointUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartPointFormatUpdateData = (function() {
function ChartPointFormatUpdateData() {
/// An interface for updating data on the ChartPointFormat object, for use in "chartPointFormat.set({ ... })".
/// Represents the border format of a chart data point, which includes color, style, and weight information. [Api set: ExcelApi 1.7]
}
return ChartPointFormatUpdateData;
})();
Interfaces.ChartPointFormatUpdateData.__proto__ = null;
Interfaces.ChartPointFormatUpdateData = ChartPointFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartAxesUpdateData = (function() {
function ChartAxesUpdateData() {
/// An interface for updating data on the ChartAxes object, for use in "chartAxes.set({ ... })".
/// Represents the category axis in a chart. [Api set: ExcelApi 1.1]
/// Represents the series axis of a 3-D chart. [Api set: ExcelApi 1.1]
/// Represents the value axis in an axis. [Api set: ExcelApi 1.1]
}
return ChartAxesUpdateData;
})();
Interfaces.ChartAxesUpdateData.__proto__ = null;
Interfaces.ChartAxesUpdateData = ChartAxesUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartAxisUpdateData = (function() {
function ChartAxisUpdateData() {
/// An interface for updating data on the ChartAxis object, for use in "chartAxis.set({ ... })".
/// Represents the formatting of a chart object, which includes line and font formatting. [Api set: ExcelApi 1.1]
/// Returns an object that represents the major gridlines for the specified axis. [Api set: ExcelApi 1.1]
/// Returns an object that represents the minor gridlines for the specified axis. [Api set: ExcelApi 1.1]
/// Represents the axis title. [Api set: ExcelApi 1.1]
/// Specifies the alignment for the specified axis tick label. See `Excel.ChartTextHorizontalAlignment` for detail. [Api set: ExcelApi 1.8];
/// Specifies the base unit for the specified category axis. [Api set: ExcelApi 1.7];
/// Specifies the category axis type. [Api set: ExcelApi 1.7];
/// Specifies the specified axis where the other axis crosses. See `Excel.ChartAxisPosition` for details. [Api set: ExcelApi 1.7];
/// Represents the axis display unit. See `Excel.ChartAxisDisplayUnit` for details. [Api set: ExcelApi 1.7];
/// Specifies if the value axis crosses the category axis between categories. [Api set: ExcelApi 1.8];
/// 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. [Api set: ExcelApi 1.9];
/// Specifies the base of the logarithm when using logarithmic scales. [Api set: ExcelApi 1.7];
/// Specifies the type of major tick mark for the specified axis. See `Excel.ChartAxisTickMark` for details. [Api set: ExcelApi 1.7];
/// Specifies the major unit scale value for the category axis when the `categoryType` property is set to `dateAxis`. [Api set: ExcelApi 1.7];
/// Represents the interval between two major tick marks. Can be set to a numeric value or an empty string. The returned value is always a number. [Api set: ExcelApi 1.1];
/// Represents the maximum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. [Api set: ExcelApi 1.1];
/// Represents the minimum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. [Api set: ExcelApi 1.1];
/// Specifies the type of minor tick mark for the specified axis. See `Excel.ChartAxisTickMark` for details. [Api set: ExcelApi 1.7];
/// Specifies the minor unit scale value for the category axis when the `categoryType` property is set to `dateAxis`. [Api set: ExcelApi 1.7];
/// Represents the interval between two minor tick marks. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. [Api set: ExcelApi 1.1];
/// Specifies if an axis is multilevel. [Api set: ExcelApi 1.8];
/// Specifies the format code for the axis tick label. [Api set: ExcelApi 1.8];
/// 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. [Api set: ExcelApi 1.8];
/// Specifies the specified axis position where the other axis crosses. See `Excel.ChartAxisPosition` for details. [Api set: ExcelApi 1.8];
/// Specifies if Excel plots data points from last to first. [Api set: ExcelApi 1.7];
/// Specifies the value axis scale type. See `Excel.ChartAxisScaleType` for details. [Api set: ExcelApi 1.7];
/// Specifies if the axis display unit label is visible. [Api set: ExcelApi 1.7];
/// 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. [Api set: ExcelApi 1.8];
/// Specifies the position of tick-mark labels on the specified axis. See `Excel.ChartAxisTickLabelPosition` for details. [Api set: ExcelApi 1.7];
/// Specifies the number of categories or series between tick-mark labels. Can be a value from 1 through 31999 or an empty string for automatic setting. The returned value is always a number. [Api set: ExcelApi 1.7];
/// Specifies the number of categories or series between tick marks. [Api set: ExcelApi 1.7];
/// Specifies if the axis is visible. [Api set: ExcelApi 1.7];
}
return ChartAxisUpdateData;
})();
Interfaces.ChartAxisUpdateData.__proto__ = null;
Interfaces.ChartAxisUpdateData = ChartAxisUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartAxisFormatUpdateData = (function() {
function ChartAxisFormatUpdateData() {
/// An interface for updating data on the ChartAxisFormat object, for use in "chartAxisFormat.set({ ... })".
/// Specifies the font attributes (font name, font size, color, etc.) for a chart axis element. [Api set: ExcelApi 1.1]
/// Specifies chart line formatting. [Api set: ExcelApi 1.1]
}
return ChartAxisFormatUpdateData;
})();
Interfaces.ChartAxisFormatUpdateData.__proto__ = null;
Interfaces.ChartAxisFormatUpdateData = ChartAxisFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartAxisTitleUpdateData = (function() {
function ChartAxisTitleUpdateData() {
/// An interface for updating data on the ChartAxisTitle object, for use in "chartAxisTitle.set({ ... })".
/// Specifies the formatting of the chart axis title. [Api set: ExcelApi 1.1]
/// Specifies the axis title. [Api set: ExcelApi 1.1];
/// 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. [Api set: ExcelApi 1.12];
/// Specifies if the axis title is visibile. [Api set: ExcelApi 1.1];
}
return ChartAxisTitleUpdateData;
})();
Interfaces.ChartAxisTitleUpdateData.__proto__ = null;
Interfaces.ChartAxisTitleUpdateData = ChartAxisTitleUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartAxisTitleFormatUpdateData = (function() {
function ChartAxisTitleFormatUpdateData() {
/// An interface for updating data on the ChartAxisTitleFormat object, for use in "chartAxisTitleFormat.set({ ... })".
/// Specifies the chart axis title's border format, which includes color, linestyle, and weight. [Api set: ExcelApi 1.8]
/// Specifies the chart axis title's font attributes, such as font name, font size, or color, of the chart axis title object. [Api set: ExcelApi 1.1]
}
return ChartAxisTitleFormatUpdateData;
})();
Interfaces.ChartAxisTitleFormatUpdateData.__proto__ = null;
Interfaces.ChartAxisTitleFormatUpdateData = ChartAxisTitleFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartDataLabelsUpdateData = (function() {
function ChartDataLabelsUpdateData() {
/// An interface for updating data on the ChartDataLabels object, for use in "chartDataLabels.set({ ... })".
/// Specifies the format of chart data labels, which includes fill and font formatting. [Api set: ExcelApi 1.1]
/// Specifies if data labels automatically generate appropriate text based on context. [Api set: ExcelApi 1.8];
/// Specifies the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details. This property is valid only when the `TextOrientation` of data label is 0. [Api set: ExcelApi 1.8];
/// 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. [Api set: ExcelApi 1.9];
/// Specifies the format code for data labels. [Api set: ExcelApi 1.8];
/// Value that represents the position of the data label. See `Excel.ChartDataLabelPosition` for details. [Api set: ExcelApi 1.1];
/// String representing the separator used for the data labels on a chart. [Api set: ExcelApi 1.1];
/// Specifies if the data label bubble size is visible. [Api set: ExcelApi 1.1];
/// Specifies if the data label category name is visible. [Api set: ExcelApi 1.1];
/// Specifies if the data label legend key is visible. [Api set: ExcelApi 1.1];
/// Specifies if the data label percentage is visible. [Api set: ExcelApi 1.1];
/// Specifies if the data label series name is visible. [Api set: ExcelApi 1.1];
/// Specifies if the data label value is visible. [Api set: ExcelApi 1.1];
/// 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. [Api set: ExcelApi 1.8];
/// Represents the vertical alignment of chart data label. See `Excel.ChartTextVerticalAlignment` for details. This property is valid only when `TextOrientation` of the data label is -90, 90, or 180. [Api set: ExcelApi 1.8];
}
return ChartDataLabelsUpdateData;
})();
Interfaces.ChartDataLabelsUpdateData.__proto__ = null;
Interfaces.ChartDataLabelsUpdateData = ChartDataLabelsUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartDataLabelUpdateData = (function() {
function ChartDataLabelUpdateData() {
/// An interface for updating data on the ChartDataLabel object, for use in "chartDataLabel.set({ ... })".
/// Represents the format of chart data label. [Api set: ExcelApi 1.8]
/// Specifies if the data label automatically generates appropriate text based on context. [Api set: ExcelApi 1.8];
/// String value that represents the formula of chart data label using A1-style notation. [Api set: ExcelApi 1.8];
/// Represents the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details. This property is valid only when `TextOrientation` of data label is -90, 90, or 180. [Api set: ExcelApi 1.8];
/// 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. [Api set: ExcelApi 1.8];
/// 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). [Api set: ExcelApi 1.9];
/// String value that represents the format code for data label. [Api set: ExcelApi 1.8];
/// Value that represents the position of the data label. See `Excel.ChartDataLabelPosition` for details. [Api set: ExcelApi 1.7];
/// String representing the separator used for the data label on a chart. [Api set: ExcelApi 1.7];
/// Specifies if the data label bubble size is visible. [Api set: ExcelApi 1.7];
/// Specifies if the data label category name is visible. [Api set: ExcelApi 1.7];
/// Specifies if the data label legend key is visible. [Api set: ExcelApi 1.7];
/// Specifies if the data label percentage is visible. [Api set: ExcelApi 1.7];
/// Specifies if the data label series name is visible. [Api set: ExcelApi 1.7];
/// Specifies if the data label value is visible. [Api set: ExcelApi 1.7];
/// String representing the text of the data label on a chart. [Api set: ExcelApi 1.8];
/// 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. [Api set: ExcelApi 1.8];
/// 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. [Api set: ExcelApi 1.8];
/// Represents the vertical alignment of chart data label. See `Excel.ChartTextVerticalAlignment` for details. This property is valid only when `TextOrientation` of data label is 0. [Api set: ExcelApi 1.8];
}
return ChartDataLabelUpdateData;
})();
Interfaces.ChartDataLabelUpdateData.__proto__ = null;
Interfaces.ChartDataLabelUpdateData = ChartDataLabelUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartDataLabelFormatUpdateData = (function() {
function ChartDataLabelFormatUpdateData() {
/// An interface for updating data on the ChartDataLabelFormat object, for use in "chartDataLabelFormat.set({ ... })".
/// Represents the border format, which includes color, linestyle, and weight. [Api set: ExcelApi 1.8]
/// Represents the font attributes (such as font name, font size, and color) for a chart data label. [Api set: ExcelApi 1.1]
}
return ChartDataLabelFormatUpdateData;
})();
Interfaces.ChartDataLabelFormatUpdateData.__proto__ = null;
Interfaces.ChartDataLabelFormatUpdateData = ChartDataLabelFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartDataTableUpdateData = (function() {
function ChartDataTableUpdateData() {
/// An interface for updating data on the ChartDataTable object, for use in "chartDataTable.set({ ... })".
/// Represents the format of a chart data table, which includes fill, font, and border format. [Api set: ExcelApi 1.14]
/// Specifies whether to display the horizontal border of the data table. [Api set: ExcelApi 1.14];
/// Specifies whether to show the legend key of the data table. [Api set: ExcelApi 1.14];
/// Specifies whether to display the outline border of the data table. [Api set: ExcelApi 1.14];
/// Specifies whether to display the vertical border of the data table. [Api set: ExcelApi 1.14];
/// Specifies whether to show the data table of the chart. [Api set: ExcelApi 1.14];
}
return ChartDataTableUpdateData;
})();
Interfaces.ChartDataTableUpdateData.__proto__ = null;
Interfaces.ChartDataTableUpdateData = ChartDataTableUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartDataTableFormatUpdateData = (function() {
function ChartDataTableFormatUpdateData() {
/// An interface for updating data on the ChartDataTableFormat object, for use in "chartDataTableFormat.set({ ... })".
/// Represents the border format of chart data table, which includes color, line style, and weight. [Api set: ExcelApi 1.14]
/// Represents the font attributes (such as font name, font size, and color) for the current object. [Api set: ExcelApi 1.14]
}
return ChartDataTableFormatUpdateData;
})();
Interfaces.ChartDataTableFormatUpdateData.__proto__ = null;
Interfaces.ChartDataTableFormatUpdateData = ChartDataTableFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartErrorBarsUpdateData = (function() {
function ChartErrorBarsUpdateData() {
/// An interface for updating data on the ChartErrorBars object, for use in "chartErrorBars.set({ ... })".
/// Specifies the formatting type of the error bars. [Api set: ExcelApi 1.9]
/// Specifies if error bars have an end style cap. [Api set: ExcelApi 1.9];
/// Specifies which parts of the error bars to include. [Api set: ExcelApi 1.9];
/// The type of range marked by the error bars. [Api set: ExcelApi 1.9];
/// Specifies whether the error bars are displayed. [Api set: ExcelApi 1.9];
}
return ChartErrorBarsUpdateData;
})();
Interfaces.ChartErrorBarsUpdateData.__proto__ = null;
Interfaces.ChartErrorBarsUpdateData = ChartErrorBarsUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartErrorBarsFormatUpdateData = (function() {
function ChartErrorBarsFormatUpdateData() {
/// An interface for updating data on the ChartErrorBarsFormat object, for use in "chartErrorBarsFormat.set({ ... })".
/// Represents the chart line formatting. [Api set: ExcelApi 1.9]
}
return ChartErrorBarsFormatUpdateData;
})();
Interfaces.ChartErrorBarsFormatUpdateData.__proto__ = null;
Interfaces.ChartErrorBarsFormatUpdateData = ChartErrorBarsFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartGridlinesUpdateData = (function() {
function ChartGridlinesUpdateData() {
/// An interface for updating data on the ChartGridlines object, for use in "chartGridlines.set({ ... })".
/// Represents the formatting of chart gridlines. [Api set: ExcelApi 1.1]
/// Specifies if the axis gridlines are visible. [Api set: ExcelApi 1.1];
}
return ChartGridlinesUpdateData;
})();
Interfaces.ChartGridlinesUpdateData.__proto__ = null;
Interfaces.ChartGridlinesUpdateData = ChartGridlinesUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartGridlinesFormatUpdateData = (function() {
function ChartGridlinesFormatUpdateData() {
/// An interface for updating data on the ChartGridlinesFormat object, for use in "chartGridlinesFormat.set({ ... })".
/// Represents chart line formatting. [Api set: ExcelApi 1.1]
}
return ChartGridlinesFormatUpdateData;
})();
Interfaces.ChartGridlinesFormatUpdateData.__proto__ = null;
Interfaces.ChartGridlinesFormatUpdateData = ChartGridlinesFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartLegendUpdateData = (function() {
function ChartLegendUpdateData() {
/// An interface for updating data on the ChartLegend object, for use in "chartLegend.set({ ... })".
/// Represents the formatting of a chart legend, which includes fill and font formatting. [Api set: ExcelApi 1.1]
/// Specifies the height, in points, of the legend on the chart. Value is `null` if the legend is not visible. [Api set: ExcelApi 1.7];
/// Specifies the left value, in points, of the legend on the chart. Value is `null` if the legend is not visible. [Api set: ExcelApi 1.7];
/// Specifies if the chart legend should overlap with the main body of the chart. [Api set: ExcelApi 1.1];
/// Specifies the position of the legend on the chart. See `Excel.ChartLegendPosition` for details. [Api set: ExcelApi 1.1];
/// Specifies if the legend has a shadow on the chart. [Api set: ExcelApi 1.7];
/// Specifies the top of a chart legend. [Api set: ExcelApi 1.7];
/// Specifies if the chart legend is visible. [Api set: ExcelApi 1.1];
/// Specifies the width, in points, of the legend on the chart. Value is `null` if the legend is not visible. [Api set: ExcelApi 1.7];
}
return ChartLegendUpdateData;
})();
Interfaces.ChartLegendUpdateData.__proto__ = null;
Interfaces.ChartLegendUpdateData = ChartLegendUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartLegendEntryUpdateData = (function() {
function ChartLegendEntryUpdateData() {
/// An interface for updating data on the ChartLegendEntry object, for use in "chartLegendEntry.set({ ... })".
/// Represents the visibility of a chart legend entry. [Api set: ExcelApi 1.7];
}
return ChartLegendEntryUpdateData;
})();
Interfaces.ChartLegendEntryUpdateData.__proto__ = null;
Interfaces.ChartLegendEntryUpdateData = ChartLegendEntryUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartLegendFormatUpdateData = (function() {
function ChartLegendFormatUpdateData() {
/// An interface for updating data on the ChartLegendFormat object, for use in "chartLegendFormat.set({ ... })".
/// Represents the border format, which includes color, linestyle, and weight. [Api set: ExcelApi 1.8]
/// Represents the font attributes such as font name, font size, and color of a chart legend. [Api set: ExcelApi 1.1]
}
return ChartLegendFormatUpdateData;
})();
Interfaces.ChartLegendFormatUpdateData.__proto__ = null;
Interfaces.ChartLegendFormatUpdateData = ChartLegendFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartMapOptionsUpdateData = (function() {
function ChartMapOptionsUpdateData() {
/// An interface for updating data on the ChartMapOptions object, for use in "chartMapOptions.set({ ... })".
/// Specifies the series map labels strategy of a region map chart. [Api set: ExcelApi 1.9];
/// Specifies the series mapping level of a region map chart. [Api set: ExcelApi 1.9];
/// Specifies the series projection type of a region map chart. [Api set: ExcelApi 1.9];
}
return ChartMapOptionsUpdateData;
})();
Interfaces.ChartMapOptionsUpdateData.__proto__ = null;
Interfaces.ChartMapOptionsUpdateData = ChartMapOptionsUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartTitleUpdateData = (function() {
function ChartTitleUpdateData() {
/// An interface for updating data on the ChartTitle object, for use in "chartTitle.set({ ... })".
/// Represents the formatting of a chart title, which includes fill and font formatting. [Api set: ExcelApi 1.1]
/// Specifies the horizontal alignment for chart title. [Api set: ExcelApi 1.7];
/// 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. [Api set: ExcelApi 1.7];
/// Specifies if the chart title will overlay the chart. [Api set: ExcelApi 1.1];
/// Represents the position of chart title. See `Excel.ChartTitlePosition` for details. [Api set: ExcelApi 1.7];
/// Represents a boolean value that determines if the chart title has a shadow. [Api set: ExcelApi 1.7];
/// Specifies the chart's title text. [Api set: ExcelApi 1.1];
/// 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. [Api set: ExcelApi 1.7];
/// 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. [Api set: ExcelApi 1.7];
/// Specifies the vertical alignment of chart title. See `Excel.ChartTextVerticalAlignment` for details. [Api set: ExcelApi 1.7];
/// Specifies if the chart title is visibile. [Api set: ExcelApi 1.1];
}
return ChartTitleUpdateData;
})();
Interfaces.ChartTitleUpdateData.__proto__ = null;
Interfaces.ChartTitleUpdateData = ChartTitleUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartFormatStringUpdateData = (function() {
function ChartFormatStringUpdateData() {
/// An interface for updating data on the ChartFormatString object, for use in "chartFormatString.set({ ... })".
/// Represents the font attributes, such as font name, font size, and color of a chart characters object. [Api set: ExcelApi 1.7]
}
return ChartFormatStringUpdateData;
})();
Interfaces.ChartFormatStringUpdateData.__proto__ = null;
Interfaces.ChartFormatStringUpdateData = ChartFormatStringUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartTitleFormatUpdateData = (function() {
function ChartTitleFormatUpdateData() {
/// An interface for updating data on the ChartTitleFormat object, for use in "chartTitleFormat.set({ ... })".
/// Represents the border format of chart title, which includes color, linestyle, and weight. [Api set: ExcelApi 1.7]
/// Represents the font attributes (such as font name, font size, and color) for an object. [Api set: ExcelApi 1.1]
}
return ChartTitleFormatUpdateData;
})();
Interfaces.ChartTitleFormatUpdateData.__proto__ = null;
Interfaces.ChartTitleFormatUpdateData = ChartTitleFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartBorderUpdateData = (function() {
function ChartBorderUpdateData() {
/// An interface for updating data on the ChartBorder object, for use in "chartBorder.set({ ... })".
/// HTML color code representing the color of borders in the chart. [Api set: ExcelApi 1.7];
/// Represents the line style of the border. See `Excel.ChartLineStyle` for details. [Api set: ExcelApi 1.7];
/// Represents weight of the border, in points. [Api set: ExcelApi 1.7];
}
return ChartBorderUpdateData;
})();
Interfaces.ChartBorderUpdateData.__proto__ = null;
Interfaces.ChartBorderUpdateData = ChartBorderUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartBinOptionsUpdateData = (function() {
function ChartBinOptionsUpdateData() {
/// An interface for updating data on the ChartBinOptions object, for use in "chartBinOptions.set({ ... })".
/// Specifies if bin overflow is enabled in a histogram chart or pareto chart. [Api set: ExcelApi 1.9];
/// Specifies if bin underflow is enabled in a histogram chart or pareto chart. [Api set: ExcelApi 1.9];
/// Specifies the bin count of a histogram chart or pareto chart. [Api set: ExcelApi 1.9];
/// Specifies the bin overflow value of a histogram chart or pareto chart. [Api set: ExcelApi 1.9];
/// Specifies the bin's type for a histogram chart or pareto chart. [Api set: ExcelApi 1.9];
/// Specifies the bin underflow value of a histogram chart or pareto chart. [Api set: ExcelApi 1.9];
/// Specifies the bin width value of a histogram chart or pareto chart. [Api set: ExcelApi 1.9];
}
return ChartBinOptionsUpdateData;
})();
Interfaces.ChartBinOptionsUpdateData.__proto__ = null;
Interfaces.ChartBinOptionsUpdateData = ChartBinOptionsUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartBoxwhiskerOptionsUpdateData = (function() {
function ChartBoxwhiskerOptionsUpdateData() {
/// An interface for updating data on the ChartBoxwhiskerOptions object, for use in "chartBoxwhiskerOptions.set({ ... })".
/// Specifies if the quartile calculation type of a box and whisker chart. [Api set: ExcelApi 1.9];
/// Specifies if inner points are shown in a box and whisker chart. [Api set: ExcelApi 1.9];
/// Specifies if the mean line is shown in a box and whisker chart. [Api set: ExcelApi 1.9];
/// Specifies if the mean marker is shown in a box and whisker chart. [Api set: ExcelApi 1.9];
/// Specifies if outlier points are shown in a box and whisker chart. [Api set: ExcelApi 1.9];
}
return ChartBoxwhiskerOptionsUpdateData;
})();
Interfaces.ChartBoxwhiskerOptionsUpdateData.__proto__ = null;
Interfaces.ChartBoxwhiskerOptionsUpdateData = ChartBoxwhiskerOptionsUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartLineFormatUpdateData = (function() {
function ChartLineFormatUpdateData() {
/// An interface for updating data on the ChartLineFormat object, for use in "chartLineFormat.set({ ... })".
/// HTML color code representing the color of lines in the chart. [Api set: ExcelApi 1.1];
/// Represents the line style. See `Excel.ChartLineStyle` for details. [Api set: ExcelApi 1.7];
/// Represents weight of the line, in points. [Api set: ExcelApi 1.7];
}
return ChartLineFormatUpdateData;
})();
Interfaces.ChartLineFormatUpdateData.__proto__ = null;
Interfaces.ChartLineFormatUpdateData = ChartLineFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartFontUpdateData = (function() {
function ChartFontUpdateData() {
/// An interface for updating data on the ChartFont object, for use in "chartFont.set({ ... })".
/// Represents the bold status of font. [Api set: ExcelApi 1.1];
/// HTML color code representation of the text color (e.g., #FF0000 represents Red). [Api set: ExcelApi 1.1];
/// Represents the italic status of the font. [Api set: ExcelApi 1.1];
/// Font name (e.g., "Calibri") [Api set: ExcelApi 1.1];
/// Size of the font (e.g., 11) [Api set: ExcelApi 1.1];
/// Type of underline applied to the font. See `Excel.ChartUnderlineStyle` for details. [Api set: ExcelApi 1.1];
}
return ChartFontUpdateData;
})();
Interfaces.ChartFontUpdateData.__proto__ = null;
Interfaces.ChartFontUpdateData = ChartFontUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartTrendlineUpdateData = (function() {
function ChartTrendlineUpdateData() {
/// An interface for updating data on the ChartTrendline object, for use in "chartTrendline.set({ ... })".
/// Represents the formatting of a chart trendline. [Api set: ExcelApi 1.7]
/// Represents the label of a chart trendline. [Api set: ExcelApi 1.8]
/// Represents the number of periods that the trendline extends backward. [Api set: ExcelApi 1.8];
/// Represents the number of periods that the trendline extends forward. [Api set: ExcelApi 1.8];
/// Represents the intercept value of the trendline. Can be set to a numeric value or an empty string (for automatic values). The returned value is always a number. [Api set: ExcelApi 1.7];
/// Represents the period of a chart trendline. Only applicable to trendlines with the type `MovingAverage`. [Api set: ExcelApi 1.7];
/// 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 [Api set: ExcelApi 1.7];
/// Represents the order of a chart trendline. Only applicable to trendlines with the type `Polynomial`. [Api set: ExcelApi 1.7];
/// True if the equation for the trendline is displayed on the chart. [Api set: ExcelApi 1.8];
/// True if the r-squared value for the trendline is displayed on the chart. [Api set: ExcelApi 1.8];
/// Represents the type of a chart trendline. [Api set: ExcelApi 1.7];
}
return ChartTrendlineUpdateData;
})();
Interfaces.ChartTrendlineUpdateData.__proto__ = null;
Interfaces.ChartTrendlineUpdateData = ChartTrendlineUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartTrendlineFormatUpdateData = (function() {
function ChartTrendlineFormatUpdateData() {
/// An interface for updating data on the ChartTrendlineFormat object, for use in "chartTrendlineFormat.set({ ... })".
/// Represents chart line formatting. [Api set: ExcelApi 1.7]
}
return ChartTrendlineFormatUpdateData;
})();
Interfaces.ChartTrendlineFormatUpdateData.__proto__ = null;
Interfaces.ChartTrendlineFormatUpdateData = ChartTrendlineFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartTrendlineLabelUpdateData = (function() {
function ChartTrendlineLabelUpdateData() {
/// An interface for updating data on the ChartTrendlineLabel object, for use in "chartTrendlineLabel.set({ ... })".
/// The format of the chart trendline label. [Api set: ExcelApi 1.8]
/// Specifies if the trendline label automatically generates appropriate text based on context. [Api set: ExcelApi 1.8];
/// String value that represents the formula of the chart trendline label using A1-style notation. [Api set: ExcelApi 1.8];
/// Represents the horizontal alignment of the chart trendline label. See `Excel.ChartTextHorizontalAlignment` for details. This property is valid only when `TextOrientation` of a trendline label is -90, 90, or 180. [Api set: ExcelApi 1.8];
/// 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. [Api set: ExcelApi 1.8];
/// 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). [Api set: ExcelApi 1.9];
/// String value that represents the format code for the trendline label. [Api set: ExcelApi 1.8];
/// String representing the text of the trendline label on a chart. [Api set: ExcelApi 1.8];
/// 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. [Api set: ExcelApi 1.8];
/// 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. [Api set: ExcelApi 1.8];
/// Represents the vertical alignment of the chart trendline label. See `Excel.ChartTextVerticalAlignment` for details. This property is valid only when `TextOrientation` of a trendline label is 0. [Api set: ExcelApi 1.8];
}
return ChartTrendlineLabelUpdateData;
})();
Interfaces.ChartTrendlineLabelUpdateData.__proto__ = null;
Interfaces.ChartTrendlineLabelUpdateData = ChartTrendlineLabelUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartTrendlineLabelFormatUpdateData = (function() {
function ChartTrendlineLabelFormatUpdateData() {
/// An interface for updating data on the ChartTrendlineLabelFormat object, for use in "chartTrendlineLabelFormat.set({ ... })".
/// Specifies the border format, which includes color, linestyle, and weight. [Api set: ExcelApi 1.8]
/// Specifies the font attributes (such as font name, font size, and color) for a chart trendline label. [Api set: ExcelApi 1.8]
}
return ChartTrendlineLabelFormatUpdateData;
})();
Interfaces.ChartTrendlineLabelFormatUpdateData.__proto__ = null;
Interfaces.ChartTrendlineLabelFormatUpdateData = ChartTrendlineLabelFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartPlotAreaUpdateData = (function() {
function ChartPlotAreaUpdateData() {
/// An interface for updating data on the ChartPlotArea object, for use in "chartPlotArea.set({ ... })".
/// Specifies the formatting of a chart plot area. [Api set: ExcelApi 1.8]
/// Specifies the height value of a plot area. [Api set: ExcelApi 1.8];
/// Specifies the inside height value of a plot area. [Api set: ExcelApi 1.8];
/// Specifies the inside left value of a plot area. [Api set: ExcelApi 1.8];
/// Specifies the inside top value of a plot area. [Api set: ExcelApi 1.8];
/// Specifies the inside width value of a plot area. [Api set: ExcelApi 1.8];
/// Specifies the left value of a plot area. [Api set: ExcelApi 1.8];
/// Specifies the position of a plot area. [Api set: ExcelApi 1.8];
/// Specifies the top value of a plot area. [Api set: ExcelApi 1.8];
/// Specifies the width value of a plot area. [Api set: ExcelApi 1.8];
}
return ChartPlotAreaUpdateData;
})();
Interfaces.ChartPlotAreaUpdateData.__proto__ = null;
Interfaces.ChartPlotAreaUpdateData = ChartPlotAreaUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ChartPlotAreaFormatUpdateData = (function() {
function ChartPlotAreaFormatUpdateData() {
/// An interface for updating data on the ChartPlotAreaFormat object, for use in "chartPlotAreaFormat.set({ ... })".
/// Specifies the border attributes of a chart plot area. [Api set: ExcelApi 1.8]
}
return ChartPlotAreaFormatUpdateData;
})();
Interfaces.ChartPlotAreaFormatUpdateData.__proto__ = null;
Interfaces.ChartPlotAreaFormatUpdateData = ChartPlotAreaFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var PivotTableUpdateData = (function() {
function PivotTableUpdateData() {
/// An interface for updating data on the PivotTable object, for use in "pivotTable.set({ ... })".
/// Specifies if the PivotTable allows the application of multiple PivotFilters on a given PivotField in the table. [Api set: ExcelApi 1.12];
/// Specifies if the PivotTable allows values in the data body to be edited by the user. [Api set: ExcelApi 1.9];
/// Name of the PivotTable. [Api set: ExcelApi 1.3];
/// Specifies whether the PivotTable refreshes when the workbook opens. Corresponds to "Refresh on load" setting in the UI. [Api set: ExcelApi 1.13];
/// Specifies if the PivotTable uses custom lists when sorting. [Api set: ExcelApi 1.9];
}
return PivotTableUpdateData;
})();
Interfaces.PivotTableUpdateData.__proto__ = null;
Interfaces.PivotTableUpdateData = PivotTableUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var PivotLayoutUpdateData = (function() {
function PivotLayoutUpdateData() {
/// An interface for updating data on the PivotLayout object, for use in "pivotLayout.set({ ... })".
/// 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. [Api set: ExcelApi 1.13];
/// 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. [Api set: ExcelApi 1.13];
/// Specifies if formatting will be automatically formatted when it’s refreshed or when fields are moved. [Api set: ExcelApi 1.9];
/// 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. [Api set: ExcelApi 1.13];
/// Specifies if the field list can be shown in the UI. [Api set: ExcelApi 1.10];
/// 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`. [Api set: ExcelApi 1.13];
/// This property indicates the PivotLayoutType of all fields on the PivotTable. If fields have different states, this will be null. [Api set: ExcelApi 1.8];
/// Specifies if formatting is preserved when the report is refreshed or recalculated by operations such as pivoting, sorting, or changing page field items. [Api set: ExcelApi 1.9];
/// Specifies if the PivotTable report shows grand totals for columns. [Api set: ExcelApi 1.8];
/// Specifies whether the PivotTable displays field headers (field captions and filter drop-downs). [Api set: ExcelApi 1.13];
/// Specifies if the PivotTable report shows grand totals for rows. [Api set: ExcelApi 1.8];
/// This property indicates the `SubtotalLocationType` of all fields on the PivotTable. If fields have different states, this will be `null`. [Api set: ExcelApi 1.8];
}
return PivotLayoutUpdateData;
})();
Interfaces.PivotLayoutUpdateData.__proto__ = null;
Interfaces.PivotLayoutUpdateData = PivotLayoutUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var PivotHierarchyUpdateData = (function() {
function PivotHierarchyUpdateData() {
/// An interface for updating data on the PivotHierarchy object, for use in "pivotHierarchy.set({ ... })".
/// Name of the PivotHierarchy. [Api set: ExcelApi 1.8];
}
return PivotHierarchyUpdateData;
})();
Interfaces.PivotHierarchyUpdateData.__proto__ = null;
Interfaces.PivotHierarchyUpdateData = PivotHierarchyUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var RowColumnPivotHierarchyUpdateData = (function() {
function RowColumnPivotHierarchyUpdateData() {
/// An interface for updating data on the RowColumnPivotHierarchy object, for use in "rowColumnPivotHierarchy.set({ ... })".
/// Name of the RowColumnPivotHierarchy. [Api set: ExcelApi 1.8];
/// Position of the RowColumnPivotHierarchy. [Api set: ExcelApi 1.8];
}
return RowColumnPivotHierarchyUpdateData;
})();
Interfaces.RowColumnPivotHierarchyUpdateData.__proto__ = null;
Interfaces.RowColumnPivotHierarchyUpdateData = RowColumnPivotHierarchyUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var FilterPivotHierarchyUpdateData = (function() {
function FilterPivotHierarchyUpdateData() {
/// An interface for updating data on the FilterPivotHierarchy object, for use in "filterPivotHierarchy.set({ ... })".
/// Determines whether to allow multiple filter items. [Api set: ExcelApi 1.8];
/// Name of the FilterPivotHierarchy. [Api set: ExcelApi 1.8];
/// Position of the FilterPivotHierarchy. [Api set: ExcelApi 1.8];
}
return FilterPivotHierarchyUpdateData;
})();
Interfaces.FilterPivotHierarchyUpdateData.__proto__ = null;
Interfaces.FilterPivotHierarchyUpdateData = FilterPivotHierarchyUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var DataPivotHierarchyUpdateData = (function() {
function DataPivotHierarchyUpdateData() {
/// An interface for updating data on the DataPivotHierarchy object, for use in "dataPivotHierarchy.set({ ... })".
/// Returns the PivotFields associated with the DataPivotHierarchy. [Api set: ExcelApi 1.8]
/// Name of the DataPivotHierarchy. [Api set: ExcelApi 1.8];
/// Number format of the DataPivotHierarchy. [Api set: ExcelApi 1.8];
/// Position of the DataPivotHierarchy. [Api set: ExcelApi 1.8];
/// Specifies if the data should be shown as a specific summary calculation. [Api set: ExcelApi 1.8];
/// Specifies if all items of the DataPivotHierarchy are shown. [Api set: ExcelApi 1.8];
}
return DataPivotHierarchyUpdateData;
})();
Interfaces.DataPivotHierarchyUpdateData.__proto__ = null;
Interfaces.DataPivotHierarchyUpdateData = DataPivotHierarchyUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var PivotFieldUpdateData = (function() {
function PivotFieldUpdateData() {
/// An interface for updating data on the PivotField object, for use in "pivotField.set({ ... })".
/// Name of the PivotField. [Api set: ExcelApi 1.8];
/// Determines whether to show all items of the PivotField. [Api set: ExcelApi 1.8];
/// Subtotals of the PivotField. [Api set: ExcelApi 1.8];
}
return PivotFieldUpdateData;
})();
Interfaces.PivotFieldUpdateData.__proto__ = null;
Interfaces.PivotFieldUpdateData = PivotFieldUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var PivotItemUpdateData = (function() {
function PivotItemUpdateData() {
/// An interface for updating data on the PivotItem object, for use in "pivotItem.set({ ... })".
/// Determines whether the item is expanded to show child items or if it's collapsed and child items are hidden. [Api set: ExcelApi 1.8];
/// Name of the PivotItem. [Api set: ExcelApi 1.8];
/// Specifies if the PivotItem is visible. [Api set: ExcelApi 1.8];
}
return PivotItemUpdateData;
})();
Interfaces.PivotItemUpdateData.__proto__ = null;
Interfaces.PivotItemUpdateData = PivotItemUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var WorksheetCustomPropertyUpdateData = (function() {
function WorksheetCustomPropertyUpdateData() {
/// An interface for updating data on the WorksheetCustomProperty object, for use in "worksheetCustomProperty.set({ ... })".
/// Gets or sets the value of the custom property. [Api set: ExcelApi 1.12];
}
return WorksheetCustomPropertyUpdateData;
})();
Interfaces.WorksheetCustomPropertyUpdateData.__proto__ = null;
Interfaces.WorksheetCustomPropertyUpdateData = WorksheetCustomPropertyUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var DocumentPropertiesUpdateData = (function() {
function DocumentPropertiesUpdateData() {
/// An interface for updating data on the DocumentProperties object, for use in "documentProperties.set({ ... })".
/// The author of the workbook. [Api set: ExcelApi 1.7];
/// The category of the workbook. [Api set: ExcelApi 1.7];
/// The comments of the workbook. [Api set: ExcelApi 1.7];
/// The company of the workbook. [Api set: ExcelApi 1.7];
/// The keywords of the workbook. [Api set: ExcelApi 1.7];
/// The manager of the workbook. [Api set: ExcelApi 1.7];
/// Gets the revision number of the workbook. Read only. [Api set: ExcelApi 1.7];
/// The subject of the workbook. [Api set: ExcelApi 1.7];
/// The title of the workbook. [Api set: ExcelApi 1.7];
}
return DocumentPropertiesUpdateData;
})();
Interfaces.DocumentPropertiesUpdateData.__proto__ = null;
Interfaces.DocumentPropertiesUpdateData = DocumentPropertiesUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var CustomPropertyUpdateData = (function() {
function CustomPropertyUpdateData() {
/// An interface for updating data on the CustomProperty object, for use in "customProperty.set({ ... })".
/// 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). [Api set: ExcelApi 1.7];
}
return CustomPropertyUpdateData;
})();
Interfaces.CustomPropertyUpdateData.__proto__ = null;
Interfaces.CustomPropertyUpdateData = CustomPropertyUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ConditionalFormatUpdateData = (function() {
function ConditionalFormatUpdateData() {
/// An interface for updating data on the ConditionalFormat object, for use in "conditionalFormat.set({ ... })".
/// Returns the cell value conditional format properties if the current conditional format is a `CellValue` type. [Api set: ExcelApi 1.6]
/// Returns the cell value conditional format properties if the current conditional format is a `CellValue` type. [Api set: ExcelApi 1.6]
/// Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type. [Api set: ExcelApi 1.6]
/// Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type. [Api set: ExcelApi 1.6]
/// Returns the custom conditional format properties if the current conditional format is a custom type. [Api set: ExcelApi 1.6]
/// Returns the custom conditional format properties if the current conditional format is a custom type. [Api set: ExcelApi 1.6]
/// Returns the data bar properties if the current conditional format is a data bar. [Api set: ExcelApi 1.6]
/// Returns the data bar properties if the current conditional format is a data bar. [Api set: ExcelApi 1.6]
/// Returns the icon set conditional format properties if the current conditional format is an `IconSet` type. [Api set: ExcelApi 1.6]
/// Returns the icon set conditional format properties if the current conditional format is an `IconSet` type. [Api set: ExcelApi 1.6]
/// Returns the preset criteria conditional format. See `Excel.PresetCriteriaConditionalFormat` for more details. [Api set: ExcelApi 1.6]
/// Returns the preset criteria conditional format. See `Excel.PresetCriteriaConditionalFormat` for more details. [Api set: ExcelApi 1.6]
/// 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". [Api set: ExcelApi 1.6]
/// 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". [Api set: ExcelApi 1.6]
/// 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. [Api set: ExcelApi 1.6]
/// 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. [Api set: ExcelApi 1.6]
/// 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. [Api set: ExcelApi 1.6];
/// 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. [Api set: ExcelApi 1.6];
}
return ConditionalFormatUpdateData;
})();
Interfaces.ConditionalFormatUpdateData.__proto__ = null;
Interfaces.ConditionalFormatUpdateData = ConditionalFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var DataBarConditionalFormatUpdateData = (function() {
function DataBarConditionalFormatUpdateData() {
/// An interface for updating data on the DataBarConditionalFormat object, for use in "dataBarConditionalFormat.set({ ... })".
/// Representation of all values to the left of the axis in an Excel data bar. [Api set: ExcelApi 1.6]
/// Representation of all values to the right of the axis in an Excel data bar. [Api set: ExcelApi 1.6]
/// 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. [Api set: ExcelApi 1.6];
/// Representation of how the axis is determined for an Excel data bar. [Api set: ExcelApi 1.6];
/// Specifies the direction that the data bar graphic should be based on. [Api set: ExcelApi 1.6];
/// The rule for what consistutes 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 = ...`). [Api set: ExcelApi 1.6];
/// If `true`, hides the values from the cells where the data bar is applied. [Api set: ExcelApi 1.6];
/// 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 = ...`). [Api set: ExcelApi 1.6];
}
return DataBarConditionalFormatUpdateData;
})();
Interfaces.DataBarConditionalFormatUpdateData.__proto__ = null;
Interfaces.DataBarConditionalFormatUpdateData = DataBarConditionalFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ConditionalDataBarPositiveFormatUpdateData = (function() {
function ConditionalDataBarPositiveFormatUpdateData() {
/// An interface for updating data on the ConditionalDataBarPositiveFormat object, for use in "conditionalDataBarPositiveFormat.set({ ... })".
/// 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. [Api set: ExcelApi 1.6];
/// HTML color code representing the fill color, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). [Api set: ExcelApi 1.6];
/// Specifies if the data bar has a gradient. [Api set: ExcelApi 1.6];
}
return ConditionalDataBarPositiveFormatUpdateData;
})();
Interfaces.ConditionalDataBarPositiveFormatUpdateData.__proto__ = null;
Interfaces.ConditionalDataBarPositiveFormatUpdateData = ConditionalDataBarPositiveFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ConditionalDataBarNegativeFormatUpdateData = (function() {
function ConditionalDataBarNegativeFormatUpdateData() {
/// An interface for updating data on the ConditionalDataBarNegativeFormat object, for use in "conditionalDataBarNegativeFormat.set({ ... })".
/// 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. [Api set: ExcelApi 1.6];
/// HTML color code representing the fill color, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). [Api set: ExcelApi 1.6];
/// Specifies if the negative data bar has the same border color as the positive data bar. [Api set: ExcelApi 1.6];
/// Specifies if the negative data bar has the same fill color as the positive data bar. [Api set: ExcelApi 1.6];
}
return ConditionalDataBarNegativeFormatUpdateData;
})();
Interfaces.ConditionalDataBarNegativeFormatUpdateData.__proto__ = null;
Interfaces.ConditionalDataBarNegativeFormatUpdateData = ConditionalDataBarNegativeFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var CustomConditionalFormatUpdateData = (function() {
function CustomConditionalFormatUpdateData() {
/// An interface for updating data on the CustomConditionalFormat object, for use in "customConditionalFormat.set({ ... })".
/// Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. [Api set: ExcelApi 1.6]
/// Specifies the `Rule` object on this conditional format. [Api set: ExcelApi 1.6]
}
return CustomConditionalFormatUpdateData;
})();
Interfaces.CustomConditionalFormatUpdateData.__proto__ = null;
Interfaces.CustomConditionalFormatUpdateData = CustomConditionalFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ConditionalFormatRuleUpdateData = (function() {
function ConditionalFormatRuleUpdateData() {
/// An interface for updating data on the ConditionalFormatRule object, for use in "conditionalFormatRule.set({ ... })".
/// The formula, if required, on which to evaluate the conditional format rule. [Api set: ExcelApi 1.6];
/// The formula, if required, on which to evaluate the conditional format rule in the user's language. [Api set: ExcelApi 1.6];
/// The formula, if required, on which to evaluate the conditional format rule in R1C1-style notation. [Api set: ExcelApi 1.6];
}
return ConditionalFormatRuleUpdateData;
})();
Interfaces.ConditionalFormatRuleUpdateData.__proto__ = null;
Interfaces.ConditionalFormatRuleUpdateData = ConditionalFormatRuleUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var IconSetConditionalFormatUpdateData = (function() {
function IconSetConditionalFormatUpdateData() {
/// An interface for updating data on the IconSetConditionalFormat object, for use in "iconSetConditionalFormat.set({ ... })".
/// 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. [Api set: ExcelApi 1.6];
/// If `true`, reverses the icon orders for the icon set. Note that this cannot be set if custom icons are used. [Api set: ExcelApi 1.6];
/// If `true`, hides the values and only shows icons. [Api set: ExcelApi 1.6];
/// If set, displays the icon set option for the conditional format. [Api set: ExcelApi 1.6];
}
return IconSetConditionalFormatUpdateData;
})();
Interfaces.IconSetConditionalFormatUpdateData.__proto__ = null;
Interfaces.IconSetConditionalFormatUpdateData = IconSetConditionalFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ColorScaleConditionalFormatUpdateData = (function() {
function ColorScaleConditionalFormatUpdateData() {
/// An interface for updating data on the ColorScaleConditionalFormat object, for use in "colorScaleConditionalFormat.set({ ... })".
/// The criteria of the color scale. Midpoint is optional when using a two point color scale. [Api set: ExcelApi 1.6];
}
return ColorScaleConditionalFormatUpdateData;
})();
Interfaces.ColorScaleConditionalFormatUpdateData.__proto__ = null;
Interfaces.ColorScaleConditionalFormatUpdateData = ColorScaleConditionalFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var TopBottomConditionalFormatUpdateData = (function() {
function TopBottomConditionalFormatUpdateData() {
/// An interface for updating data on the TopBottomConditionalFormat object, for use in "topBottomConditionalFormat.set({ ... })".
/// Returns a format object, encapsulating the conditional format's font, fill, borders, and other properties. [Api set: ExcelApi 1.6]
/// The criteria of the top/bottom conditional format. [Api set: ExcelApi 1.6];
}
return TopBottomConditionalFormatUpdateData;
})();
Interfaces.TopBottomConditionalFormatUpdateData.__proto__ = null;
Interfaces.TopBottomConditionalFormatUpdateData = TopBottomConditionalFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var PresetCriteriaConditionalFormatUpdateData = (function() {
function PresetCriteriaConditionalFormatUpdateData() {
/// An interface for updating data on the PresetCriteriaConditionalFormat object, for use in "presetCriteriaConditionalFormat.set({ ... })".
/// Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. [Api set: ExcelApi 1.6]
/// The rule of the conditional format. [Api set: ExcelApi 1.6];
}
return PresetCriteriaConditionalFormatUpdateData;
})();
Interfaces.PresetCriteriaConditionalFormatUpdateData.__proto__ = null;
Interfaces.PresetCriteriaConditionalFormatUpdateData = PresetCriteriaConditionalFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var TextConditionalFormatUpdateData = (function() {
function TextConditionalFormatUpdateData() {
/// An interface for updating data on the TextConditionalFormat object, for use in "textConditionalFormat.set({ ... })".
/// Returns a format object, encapsulating the conditional format's font, fill, borders, and other properties. [Api set: ExcelApi 1.6]
/// The rule of the conditional format. [Api set: ExcelApi 1.6];
}
return TextConditionalFormatUpdateData;
})();
Interfaces.TextConditionalFormatUpdateData.__proto__ = null;
Interfaces.TextConditionalFormatUpdateData = TextConditionalFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var CellValueConditionalFormatUpdateData = (function() {
function CellValueConditionalFormatUpdateData() {
/// An interface for updating data on the CellValueConditionalFormat object, for use in "cellValueConditionalFormat.set({ ... })".
/// Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. [Api set: ExcelApi 1.6]
/// Specifies the rule object on this conditional format. [Api set: ExcelApi 1.6];
}
return CellValueConditionalFormatUpdateData;
})();
Interfaces.CellValueConditionalFormatUpdateData.__proto__ = null;
Interfaces.CellValueConditionalFormatUpdateData = CellValueConditionalFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ConditionalRangeFormatUpdateData = (function() {
function ConditionalRangeFormatUpdateData() {
/// An interface for updating data on the ConditionalRangeFormat object, for use in "conditionalRangeFormat.set({ ... })".
/// Collection of border objects that apply to the overall conditional format range. [Api set: ExcelApi 1.6]
/// Returns the fill object defined on the overall conditional format range. [Api set: ExcelApi 1.6]
/// Returns the font object defined on the overall conditional format range. [Api set: ExcelApi 1.6]
/// Represents Excel's number format code for the given range. Cleared if `null` is passed in. [Api set: ExcelApi 1.6];
}
return ConditionalRangeFormatUpdateData;
})();
Interfaces.ConditionalRangeFormatUpdateData.__proto__ = null;
Interfaces.ConditionalRangeFormatUpdateData = ConditionalRangeFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ConditionalRangeFontUpdateData = (function() {
function ConditionalRangeFontUpdateData() {
/// An interface for updating data on the ConditionalRangeFont object, for use in "conditionalRangeFont.set({ ... })".
/// Specifies if the font is bold. [Api set: ExcelApi 1.6];
/// HTML color code representation of the text color (e.g., #FF0000 represents Red). [Api set: ExcelApi 1.6];
/// Specifies if the font is italic. [Api set: ExcelApi 1.6];
/// Specifies the strikethrough status of the font. [Api set: ExcelApi 1.6];
/// The type of underline applied to the font. See `Excel.ConditionalRangeFontUnderlineStyle` for details. [Api set: ExcelApi 1.6];
}
return ConditionalRangeFontUpdateData;
})();
Interfaces.ConditionalRangeFontUpdateData.__proto__ = null;
Interfaces.ConditionalRangeFontUpdateData = ConditionalRangeFontUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ConditionalRangeFillUpdateData = (function() {
function ConditionalRangeFillUpdateData() {
/// An interface for updating data on the ConditionalRangeFill object, for use in "conditionalRangeFill.set({ ... })".
/// 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"). [Api set: ExcelApi 1.6];
}
return ConditionalRangeFillUpdateData;
})();
Interfaces.ConditionalRangeFillUpdateData.__proto__ = null;
Interfaces.ConditionalRangeFillUpdateData = ConditionalRangeFillUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ConditionalRangeBorderUpdateData = (function() {
function ConditionalRangeBorderUpdateData() {
/// An interface for updating data on the ConditionalRangeBorder object, for use in "conditionalRangeBorder.set({ ... })".
/// 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"). [Api set: ExcelApi 1.6];
/// One of the constants of line style specifying the line style for the border. See `Excel.BorderLineStyle` for details. [Api set: ExcelApi 1.6];
}
return ConditionalRangeBorderUpdateData;
})();
Interfaces.ConditionalRangeBorderUpdateData.__proto__ = null;
Interfaces.ConditionalRangeBorderUpdateData = ConditionalRangeBorderUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ConditionalRangeBorderCollectionUpdateData = (function() {
function ConditionalRangeBorderCollectionUpdateData() {
/// An interface for updating data on the ConditionalRangeBorderCollection object, for use in "conditionalRangeBorderCollection.set({ ... })".
/// Gets the bottom border. [Api set: ExcelApi 1.6]
/// Gets the left border. [Api set: ExcelApi 1.6]
/// Gets the right border. [Api set: ExcelApi 1.6]
/// Gets the top border. [Api set: ExcelApi 1.6]
}
return ConditionalRangeBorderCollectionUpdateData;
})();
Interfaces.ConditionalRangeBorderCollectionUpdateData.__proto__ = null;
Interfaces.ConditionalRangeBorderCollectionUpdateData = ConditionalRangeBorderCollectionUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var StyleUpdateData = (function() {
function StyleUpdateData() {
/// An interface for updating data on the Style object, for use in "style.set({ ... })".
/// A collection of four border objects that represent the style of the four borders. [Api set: ExcelApi 1.7]
/// The fill of the style. [Api set: ExcelApi 1.7]
/// A `Font` object that represents the font of the style. [Api set: ExcelApi 1.7]
/// Specifies if text is automatically indented when the text alignment in a cell is set to equal distribution. [Api set: ExcelApi 1.8];
/// Specifies if the formula will be hidden when the worksheet is protected. [Api set: ExcelApi 1.7];
/// Represents the horizontal alignment for the style. See `Excel.HorizontalAlignment` for details. [Api set: ExcelApi 1.7];
/// Specifies if the style includes the auto indent, horizontal alignment, vertical alignment, wrap text, indent level, and text orientation properties. [Api set: ExcelApi 1.7];
/// Specifies if the style includes the color, color index, line style, and weight border properties. [Api set: ExcelApi 1.7];
/// Specifies if the style includes the background, bold, color, color index, font style, italic, name, size, strikethrough, subscript, superscript, and underline font properties. [Api set: ExcelApi 1.7];
/// Specifies if the style includes the number format property. [Api set: ExcelApi 1.7];
/// Specifies if the style includes the color, color index, invert if negative, pattern, pattern color, and pattern color index interior properties. [Api set: ExcelApi 1.7];
/// Specifies if the style includes the formula hidden and locked protection properties. [Api set: ExcelApi 1.7];
/// An integer from 0 to 250 that indicates the indent level for the style. [Api set: ExcelApi 1.7];
/// Specifies if the object is locked when the worksheet is protected. [Api set: ExcelApi 1.7];
/// The format code of the number format for the style. [Api set: ExcelApi 1.7];
/// The localized format code of the number format for the style. [Api set: ExcelApi 1.7];
/// The reading order for the style. [Api set: ExcelApi 1.7];
/// Specifies if text automatically shrinks to fit in the available column width. [Api set: ExcelApi 1.7];
/// The text orientation for the style. [Api set: ExcelApi 1.8];
/// Specifies the vertical alignment for the style. See `Excel.VerticalAlignment` for details. [Api set: ExcelApi 1.7];
/// Specifies if Excel wraps the text in the object. [Api set: ExcelApi 1.7];
}
return StyleUpdateData;
})();
Interfaces.StyleUpdateData.__proto__ = null;
Interfaces.StyleUpdateData = StyleUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var TableStyleUpdateData = (function() {
function TableStyleUpdateData() {
/// An interface for updating data on the TableStyle object, for use in "tableStyle.set({ ... })".
/// Gets the name of the table style. [Api set: ExcelApi 1.10];
}
return TableStyleUpdateData;
})();
Interfaces.TableStyleUpdateData.__proto__ = null;
Interfaces.TableStyleUpdateData = TableStyleUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var PivotTableStyleUpdateData = (function() {
function PivotTableStyleUpdateData() {
/// An interface for updating data on the PivotTableStyle object, for use in "pivotTableStyle.set({ ... })".
/// Gets the name of the PivotTable style. [Api set: ExcelApi 1.10];
}
return PivotTableStyleUpdateData;
})();
Interfaces.PivotTableStyleUpdateData.__proto__ = null;
Interfaces.PivotTableStyleUpdateData = PivotTableStyleUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var SlicerStyleUpdateData = (function() {
function SlicerStyleUpdateData() {
/// An interface for updating data on the SlicerStyle object, for use in "slicerStyle.set({ ... })".
/// Gets the name of the slicer style. [Api set: ExcelApi 1.10];
}
return SlicerStyleUpdateData;
})();
Interfaces.SlicerStyleUpdateData.__proto__ = null;
Interfaces.SlicerStyleUpdateData = SlicerStyleUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var TimelineStyleUpdateData = (function() {
function TimelineStyleUpdateData() {
/// An interface for updating data on the TimelineStyle object, for use in "timelineStyle.set({ ... })".
/// Gets the name of the timeline style. [Api set: ExcelApi 1.10];
}
return TimelineStyleUpdateData;
})();
Interfaces.TimelineStyleUpdateData.__proto__ = null;
Interfaces.TimelineStyleUpdateData = TimelineStyleUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var PageLayoutUpdateData = (function() {
function PageLayoutUpdateData() {
/// An interface for updating data on the PageLayout object, for use in "pageLayout.set({ ... })".
/// Header and footer configuration for the worksheet. [Api set: ExcelApi 1.9]
/// The worksheet's black and white print option. [Api set: ExcelApi 1.9];
/// The worksheet's bottom page margin to use for printing in points. [Api set: ExcelApi 1.9];
/// The worksheet's center horizontally flag. This flag determines whether the worksheet will be centered horizontally when it's printed. [Api set: ExcelApi 1.9];
/// The worksheet's center vertically flag. This flag determines whether the worksheet will be centered vertically when it's printed. [Api set: ExcelApi 1.9];
/// The worksheet's draft mode option. If `true`, the sheet will be printed without graphics. [Api set: ExcelApi 1.9];
/// The worksheet's first page number to print. A `null` value represents "auto" page numbering. [Api set: ExcelApi 1.9];
/// The worksheet's footer margin, in points, for use when printing. [Api set: ExcelApi 1.9];
/// The worksheet's header margin, in points, for use when printing. [Api set: ExcelApi 1.9];
/// The worksheet's left margin, in points, for use when printing. [Api set: ExcelApi 1.9];
/// The worksheet's orientation of the page. [Api set: ExcelApi 1.9];
/// The worksheet's paper size of the page. [Api set: ExcelApi 1.9];
/// Specifies if the worksheet's comments should be displayed when printing. [Api set: ExcelApi 1.9];
/// The worksheet's print errors option. [Api set: ExcelApi 1.9];
/// Specifies if the worksheet's gridlines will be printed. [Api set: ExcelApi 1.9];
/// Specifies if the worksheet's headings will be printed. [Api set: ExcelApi 1.9];
/// The worksheet's page print order option. This specifies the order to use for processing the page number printed. [Api set: ExcelApi 1.9];
/// The worksheet's right margin, in points, for use when printing. [Api set: ExcelApi 1.9];
/// The worksheet's top margin, in points, for use when printing. [Api set: ExcelApi 1.9];
/// The worksheet's print zoom options. The `PageLayoutZoomOptions` object must be set as a JSON object (use `x.zoom = {...}` instead of `x.zoom.scale = ...`). [Api set: ExcelApi 1.9];
}
return PageLayoutUpdateData;
})();
Interfaces.PageLayoutUpdateData.__proto__ = null;
Interfaces.PageLayoutUpdateData = PageLayoutUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var HeaderFooterUpdateData = (function() {
function HeaderFooterUpdateData() {
/// An interface for updating data on the HeaderFooter object, for use in "headerFooter.set({ ... })".
/// 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. [Api set: ExcelApi 1.9];
/// 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. [Api set: ExcelApi 1.9];
/// 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. [Api set: ExcelApi 1.9];
/// 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. [Api set: ExcelApi 1.9];
/// 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. [Api set: ExcelApi 1.9];
/// 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. [Api set: ExcelApi 1.9];
}
return HeaderFooterUpdateData;
})();
Interfaces.HeaderFooterUpdateData.__proto__ = null;
Interfaces.HeaderFooterUpdateData = HeaderFooterUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var HeaderFooterGroupUpdateData = (function() {
function HeaderFooterGroupUpdateData() {
/// An interface for updating data on the HeaderFooterGroup object, for use in "headerFooterGroup.set({ ... })".
/// The general header/footer, used for all pages unless even/odd or first page is specified. [Api set: ExcelApi 1.9]
/// The header/footer to use for even pages, odd header/footer needs to be specified for odd pages. [Api set: ExcelApi 1.9]
/// The first page header/footer, for all other pages general or even/odd is used. [Api set: ExcelApi 1.9]
/// The header/footer to use for odd pages, even header/footer needs to be specified for even pages. [Api set: ExcelApi 1.9]
/// The state by which headers/footers are set. See `Excel.HeaderFooterState` for details. [Api set: ExcelApi 1.9];
/// Gets or sets a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet. [Api set: ExcelApi 1.9];
/// 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. [Api set: ExcelApi 1.9];
}
return HeaderFooterGroupUpdateData;
})();
Interfaces.HeaderFooterGroupUpdateData.__proto__ = null;
Interfaces.HeaderFooterGroupUpdateData = HeaderFooterGroupUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var CommentUpdateData = (function() {
function CommentUpdateData() {
/// An interface for updating data on the Comment object, for use in "comment.set({ ... })".
/// The comment's content. The string is plain text. [Api set: ExcelApi 1.10];
/// The comment thread status. A value of `true` means that the comment thread is resolved. [Api set: ExcelApi 1.11];
}
return CommentUpdateData;
})();
Interfaces.CommentUpdateData.__proto__ = null;
Interfaces.CommentUpdateData = CommentUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var CommentReplyUpdateData = (function() {
function CommentReplyUpdateData() {
/// An interface for updating data on the CommentReply object, for use in "commentReply.set({ ... })".
/// The comment reply's content. The string is plain text. [Api set: ExcelApi 1.10];
}
return CommentReplyUpdateData;
})();
Interfaces.CommentReplyUpdateData.__proto__ = null;
Interfaces.CommentReplyUpdateData = CommentReplyUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ShapeUpdateData = (function() {
function ShapeUpdateData() {
/// An interface for updating data on the Shape object, for use in "shape.set({ ... })".
/// Returns the fill formatting of this shape. [Api set: ExcelApi 1.9]
/// Returns the line formatting of this shape. [Api set: ExcelApi 1.9]
/// Specifies the alternative description text for a `Shape` object. [Api set: ExcelApi 1.9];
/// Specifies the alternative title text for a `Shape` object. [Api set: ExcelApi 1.9];
/// Specifies the geometric shape type of this geometric shape. See `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape". [Api set: ExcelApi 1.9];
/// Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value or zero as an input. [Api set: ExcelApi 1.9];
/// 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. [Api set: ExcelApi 1.9];
/// Specifies if the aspect ratio of this shape is locked. [Api set: ExcelApi 1.9];
/// Specifies the name of the shape. [Api set: ExcelApi 1.9];
/// Represents how the object is attached to the cells below it. [Api set: ExcelApi 1.10];
/// Specifies the rotation, in degrees, of the shape. [Api set: ExcelApi 1.9];
/// 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. [Api set: ExcelApi 1.9];
/// Specifies if the shape is visible. [Api set: ExcelApi 1.9];
/// Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value or zero as an input. [Api set: ExcelApi 1.9];
}
return ShapeUpdateData;
})();
Interfaces.ShapeUpdateData.__proto__ = null;
Interfaces.ShapeUpdateData = ShapeUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var LineUpdateData = (function() {
function LineUpdateData() {
/// An interface for updating data on the Line object, for use in "line.set({ ... })".
/// Represents the length of the arrowhead at the beginning of the specified line. [Api set: ExcelApi 1.9];
/// Represents the style of the arrowhead at the beginning of the specified line. [Api set: ExcelApi 1.9];
/// Represents the width of the arrowhead at the beginning of the specified line. [Api set: ExcelApi 1.9];
/// Represents the length of the arrowhead at the end of the specified line. [Api set: ExcelApi 1.9];
/// Represents the style of the arrowhead at the end of the specified line. [Api set: ExcelApi 1.9];
/// Represents the width of the arrowhead at the end of the specified line. [Api set: ExcelApi 1.9];
/// Represents the connector type for the line. [Api set: ExcelApi 1.9];
}
return LineUpdateData;
})();
Interfaces.LineUpdateData.__proto__ = null;
Interfaces.LineUpdateData = LineUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ShapeFillUpdateData = (function() {
function ShapeFillUpdateData() {
/// An interface for updating data on the ShapeFill object, for use in "shapeFill.set({ ... })".
/// 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") [Api set: ExcelApi 1.9];
/// 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. [Api set: ExcelApi 1.9];
}
return ShapeFillUpdateData;
})();
Interfaces.ShapeFillUpdateData.__proto__ = null;
Interfaces.ShapeFillUpdateData = ShapeFillUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ShapeLineFormatUpdateData = (function() {
function ShapeLineFormatUpdateData() {
/// An interface for updating data on the ShapeLineFormat object, for use in "shapeLineFormat.set({ ... })".
/// Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). [Api set: ExcelApi 1.9];
/// Represents the line style of the shape. Returns `null` when the line is not visible or there are inconsistent dash styles. See `Excel.ShapeLineDashStyle` for details. [Api set: ExcelApi 1.9];
/// Represents the line style of the shape. Returns `null` when the line is not visible or there are inconsistent styles. See `Excel.ShapeLineStyle` for details. [Api set: ExcelApi 1.9];
/// 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. [Api set: ExcelApi 1.9];
/// Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent visibilities. [Api set: ExcelApi 1.9];
/// Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights. [Api set: ExcelApi 1.9];
}
return ShapeLineFormatUpdateData;
})();
Interfaces.ShapeLineFormatUpdateData.__proto__ = null;
Interfaces.ShapeLineFormatUpdateData = ShapeLineFormatUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var TextFrameUpdateData = (function() {
function TextFrameUpdateData() {
/// An interface for updating data on the TextFrame object, for use in "textFrame.set({ ... })".
/// 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. [Api set: ExcelApi 1.9];
/// Represents the bottom margin, in points, of the text frame. [Api set: ExcelApi 1.9];
/// Represents the horizontal alignment of the text frame. See `Excel.ShapeTextHorizontalAlignment` for details. [Api set: ExcelApi 1.9];
/// Represents the horizontal overflow behavior of the text frame. See `Excel.ShapeTextHorizontalOverflow` for details. [Api set: ExcelApi 1.9];
/// Represents the left margin, in points, of the text frame. [Api set: ExcelApi 1.9];
/// Represents the angle to which the text is oriented for the text frame. See `Excel.ShapeTextOrientation` for details. [Api set: ExcelApi 1.9];
/// Represents the reading order of the text frame, either left-to-right or right-to-left. See `Excel.ShapeTextReadingOrder` for details. [Api set: ExcelApi 1.9];
/// Represents the right margin, in points, of the text frame. [Api set: ExcelApi 1.9];
/// Represents the top margin, in points, of the text frame. [Api set: ExcelApi 1.9];
/// Represents the vertical alignment of the text frame. See `Excel.ShapeTextVerticalAlignment` for details. [Api set: ExcelApi 1.9];
/// Represents the vertical overflow behavior of the text frame. See `Excel.ShapeTextVerticalOverflow` for details. [Api set: ExcelApi 1.9];
}
return TextFrameUpdateData;
})();
Interfaces.TextFrameUpdateData.__proto__ = null;
Interfaces.TextFrameUpdateData = TextFrameUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var TextRangeUpdateData = (function() {
function TextRangeUpdateData() {
/// An interface for updating data on the TextRange object, for use in "textRange.set({ ... })".
/// Returns a `ShapeFont` object that represents the font attributes for the text range. [Api set: ExcelApi 1.9]
/// Represents the plain text content of the text range. [Api set: ExcelApi 1.9];
}
return TextRangeUpdateData;
})();
Interfaces.TextRangeUpdateData.__proto__ = null;
Interfaces.TextRangeUpdateData = TextRangeUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var ShapeFontUpdateData = (function() {
function ShapeFontUpdateData() {
/// An interface for updating data on the ShapeFont object, for use in "shapeFont.set({ ... })".
/// Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments. [Api set: ExcelApi 1.9];
/// HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors. [Api set: ExcelApi 1.9];
/// Represents the italic status of font. Returns `null` if the `TextRange` includes both italic and non-italic text fragments. [Api set: ExcelApi 1.9];
/// 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. [Api set: ExcelApi 1.9];
/// Represents font size in points (e.g., 11). Returns `null` if the `TextRange` includes text fragments with different font sizes. [Api set: ExcelApi 1.9];
/// Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See `Excel.ShapeFontUnderlineStyle` for details. [Api set: ExcelApi 1.9];
}
return ShapeFontUpdateData;
})();
Interfaces.ShapeFontUpdateData.__proto__ = null;
Interfaces.ShapeFontUpdateData = ShapeFontUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var SlicerUpdateData = (function() {
function SlicerUpdateData() {
/// An interface for updating data on the Slicer object, for use in "slicer.set({ ... })".
/// Represents the worksheet containing the slicer. [Api set: ExcelApi 1.10]
/// Represents the caption of the slicer. [Api set: ExcelApi 1.10];
/// Represents the height, in points, of the slicer. Throws an `InvalidArgument` exception when set with a negative value or zero as an input. [Api set: ExcelApi 1.10];
/// 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. [Api set: ExcelApi 1.10];
/// Represents the name of the slicer. [Api set: ExcelApi 1.10];
/// Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending". [Api set: ExcelApi 1.10];
/// 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. [Api set: ExcelApi 1.10];
/// 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. [Api set: ExcelApi 1.10];
/// Represents the width, in points, of the slicer. Throws an `InvalidArgument` error when set with a negative value or zero as an input. [Api set: ExcelApi 1.10];
}
return SlicerUpdateData;
})();
Interfaces.SlicerUpdateData.__proto__ = null;
Interfaces.SlicerUpdateData = SlicerUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var SlicerItemUpdateData = (function() {
function SlicerItemUpdateData() {
/// An interface for updating data on the SlicerItem object, for use in "slicerItem.set({ ... })".
/// 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. [Api set: ExcelApi 1.10];
}
return SlicerItemUpdateData;
})();
Interfaces.SlicerItemUpdateData.__proto__ = null;
Interfaces.SlicerItemUpdateData = SlicerItemUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var RibbonUpdateData = (function() {
function RibbonUpdateData() {
/// An interface for updating data on the Ribbon object, for use in "ribbon.set({ ... })".
/// The active ribbon tab. [Api set: ExcelApi 1.9];
}
return RibbonUpdateData;
})();
Interfaces.RibbonUpdateData.__proto__ = null;
Interfaces.RibbonUpdateData = RibbonUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var Interfaces;
(function (Interfaces) {
var NamedSheetViewUpdateData = (function() {
function NamedSheetViewUpdateData() {
/// An interface for updating data on the NamedSheetView object, for use in "namedSheetView.set({ ... })".
/// 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. [Api set: ExcelApiOnline 1.1];
}
return NamedSheetViewUpdateData;
})();
Interfaces.NamedSheetViewUpdateData.__proto__ = null;
Interfaces.NamedSheetViewUpdateData = NamedSheetViewUpdateData;
})(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
})(Excel || (Excel = {__proto__: null}));
var Excel;
(function (Excel) {
var RequestContext = (function (_super) {
__extends(RequestContext, _super);
function RequestContext() {
///
/// The RequestContext object facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the request context is required to get access to the Excel object model from the add-in.
///
/// Root object for interacting with the document
_super.call(this, null);
}
return RequestContext;
})(OfficeExtension.ClientRequestContext);
Excel.RequestContext = RequestContext;
Excel.run = function (batch) {
///
///
/// Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
///
///
/// A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()").
///
/// The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in.
///
///
///
///
/// Executes a batch script that performs actions on the Excel object model, using the RequestContext of a previously-created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
///
///
/// A previously-created API object. The batch will use the same RequestContext as the passed-in object, which means that any changes applied to the object will be picked up by "context.sync()".
///
///
/// A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()").
///
/// The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in.
///
///
///
///
/// Executes a batch script that performs actions on the Excel object model, using the RequestContext of a previously-created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
///
///
/// An array of previously-created API objects. The array will be validated to make sure that all of the objects share the same context. The batch will use this shared RequestContext, which means that any changes applied to these objects will be picked up by "context.sync()".
///
///
/// A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()").
///
/// The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in.
///
///
arguments[arguments.length - 1](new Excel.RequestContext());
return new OfficeExtension.Promise();
}
})(Excel || (Excel = {__proto__: null}));
Excel.__proto__ = null;
var Word;
(function (Word) {
/// [Api set: WordApi]
var Alignment = {
__proto__: null,
"mixed": "mixed",
"unknown": "unknown",
"left": "left",
"centered": "centered",
"right": "right",
"justified": "justified",
}
Word.Alignment = Alignment;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Application = (function(_super) {
__extends(Application, _super);
function Application() {
/// Represents the application object. [Api set: WordApi 1.3]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
}
Application.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Application.prototype.createDocument = function(base64File) {
///
/// Creates a new document by using an optional base64 encoded .docx file. [Api set: WordApi 1.3]
///
/// Optional. The base64 encoded .docx file. The default value is null.
///
}
return Application;
})(OfficeExtension.ClientObject);
Word.Application = Application;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Body = (function(_super) {
__extends(Body, _super);
function Body() {
/// Represents the body of a document or a section. [Api set: WordApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the collection of rich text content control objects in the body. Read-only. [Api set: WordApi 1.1]
/// Gets the text format of the body. Use this to get and set font name, size, color and other properties. Read-only. [Api set: WordApi 1.1]
/// Gets the collection of InlinePicture objects in the body. The collection does not include floating images. Read-only. [Api set: WordApi 1.1]
/// Gets the collection of list objects in the body. Read-only. [Api set: WordApi 1.3]
/// Gets the collection of paragraph objects in the body. Read-only. [Api set: WordApi 1.1]
/// Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws an error if there isn't a parent body. Read-only. [Api set: WordApi 1.3]
/// Gets the parent body of the body. For example, a table cell body's parent body could be a header. Returns a null object if there isn't a parent body. Read-only. [Api set: WordApi 1.3]
/// Gets the content control that contains the body. Throws an error if there isn't a parent content control. Read-only. [Api set: WordApi 1.1]
/// Gets the content control that contains the body. Returns a null object if there isn't a parent content control. Read-only. [Api set: WordApi 1.3]
/// Gets the parent section of the body. Throws an error if there isn't a parent section. Read-only. [Api set: WordApi 1.3]
/// Gets the parent section of the body. Returns a null object if there isn't a parent section. Read-only. [Api set: WordApi 1.3]
/// Gets or sets the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. [Api set: WordApi 1.1]
/// Gets or sets the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. [Api set: WordApi 1.3]
/// Gets the collection of table objects in the body. Read-only. [Api set: WordApi 1.3]
/// Gets the text of the body. Use the insertText method to insert text. Read-only. [Api set: WordApi 1.1]
/// Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Read-only. [Api set: WordApi 1.3]
}
Body.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Body.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Word.Interfaces.BodyUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing Body object, with properties that have already been loaded and synced.
///
}
Body.prototype.clear = function() {
///
/// Clears the contents of the body object. The user can perform the undo operation on the cleared content. [Api set: WordApi 1.1]
///
///
}
Body.prototype.getHtml = function() {
///
/// Gets an HTML representation of the body object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Body.getOoxml()` and convert the returned XML to HTML. [Api set: WordApi 1.1]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = '';
return result;
}
Body.prototype.getOoxml = function() {
///
/// Gets the OOXML (Office Open XML) representation of the body object. [Api set: WordApi 1.1]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = '';
return result;
}
Body.prototype.getRange = function(rangeLocation) {
///
/// Gets the whole body, or the starting or ending point of the body, as a range. [Api set: WordApi 1.3]
///
/// Optional. The range location can be 'Whole', 'Start', 'End', 'After', or 'Content'.
///
}
Body.prototype.insertBreak = function(breakType, insertLocation) {
///
/// Inserts a break at the specified location in the main document. [Api set: WordApi 1.1]
///
/// Required. The break type to add to the body.
/// Required. The value can be 'Start' or 'End'.
///
}
Body.prototype.insertContentControl = function() {
///
/// Wraps the body object with a Rich Text content control. [Api set: WordApi 1.1]
///
///
}
Body.prototype.insertFileFromBase64 = function(base64File, insertLocation) {
///
/// Inserts a document into the body at the specified location. [Api set: WordApi 1.1]
///
/// Required. The base64 encoded content of a .docx file.
/// Required. The value can be 'Replace', 'Start', or 'End'.
///
}
Body.prototype.insertHtml = function(html, insertLocation) {
///
/// Inserts HTML at the specified location. [Api set: WordApi 1.1]
///
/// Required. The HTML to be inserted in the document.
/// Required. The value can be 'Replace', 'Start', or 'End'.
///
}
Body.prototype.insertInlinePictureFromBase64 = function(base64EncodedImage, insertLocation) {
///
/// Inserts a picture into the body at the specified location. [Api set: WordApi 1.2]
///
/// Required. The base64 encoded image to be inserted in the body.
/// Required. The value can be 'Start' or 'End'.
///
}
Body.prototype.insertOoxml = function(ooxml, insertLocation) {
///
/// Inserts OOXML at the specified location. [Api set: WordApi 1.1]
///
/// Required. The OOXML to be inserted.
/// Required. The value can be 'Replace', 'Start', or 'End'.
///
}
Body.prototype.insertParagraph = function(paragraphText, insertLocation) {
///
/// Inserts a paragraph at the specified location. [Api set: WordApi 1.1]
///
/// Required. The paragraph text to be inserted.
/// Required. The value can be 'Start' or 'End'.
///
}
Body.prototype.insertTable = function(rowCount, columnCount, insertLocation, values) {
///
/// Inserts a table with the specified number of rows and columns. [Api set: WordApi 1.3]
///
/// Required. The number of rows in the table.
/// Required. The number of columns in the table.
/// Required. The value can be 'Start' or 'End'.
/// Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
///
}
Body.prototype.insertText = function(text, insertLocation) {
///
/// Inserts text into the body at the specified location. [Api set: WordApi 1.1]
///
/// Required. Text to be inserted.
/// Required. The value can be 'Replace', 'Start', or 'End'.
///
}
Body.prototype.search = function(searchText, searchOptions) {
///
/// Performs a search with the specified SearchOptions on the scope of the body object. The search results are a collection of range objects. [Api set: WordApi 1.1]
///
/// Required. The search text. Can be a maximum of 255 characters.
/// Optional. Options for the search.
///
}
Body.prototype.select = function(selectionMode) {
///
/// Selects the body and navigates the Word UI to it. [Api set: WordApi 1.1]
///
/// Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
///
}
Body.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
Body.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return Body;
})(OfficeExtension.ClientObject);
Word.Body = Body;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// [Api set: WordApi]
var BodyType = {
__proto__: null,
"unknown": "unknown",
"mainDoc": "mainDoc",
"section": "section",
"header": "header",
"footer": "footer",
"tableCell": "tableCell",
"footnote": "footnote",
"endnote": "endnote",
"noteItem": "noteItem",
}
Word.BodyType = BodyType;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// [Api set: WordApi]
var BorderLocation = {
__proto__: null,
"top": "top",
"left": "left",
"bottom": "bottom",
"right": "right",
"insideHorizontal": "insideHorizontal",
"insideVertical": "insideVertical",
"inside": "inside",
"outside": "outside",
"all": "all",
}
Word.BorderLocation = BorderLocation;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// [Api set: WordApi]
var BorderType = {
__proto__: null,
"mixed": "mixed",
"none": "none",
"single": "single",
"double": "double",
"dotted": "dotted",
"dashed": "dashed",
"dotDashed": "dotDashed",
"dot2Dashed": "dot2Dashed",
"triple": "triple",
"thinThickSmall": "thinThickSmall",
"thickThinSmall": "thickThinSmall",
"thinThickThinSmall": "thinThickThinSmall",
"thinThickMed": "thinThickMed",
"thickThinMed": "thickThinMed",
"thinThickThinMed": "thinThickThinMed",
"thinThickLarge": "thinThickLarge",
"thickThinLarge": "thickThinLarge",
"thinThickThinLarge": "thinThickThinLarge",
"wave": "wave",
"doubleWave": "doubleWave",
"dashedSmall": "dashedSmall",
"dashDotStroked": "dashDotStroked",
"threeDEmboss": "threeDEmboss",
"threeDEngrave": "threeDEngrave",
}
Word.BorderType = BorderType;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// Specifies the form of a break. [Api set: WordApi]
var BreakType = {
__proto__: null,
"page": "page",
"sectionNext": "sectionNext",
"sectionContinuous": "sectionContinuous",
"sectionEven": "sectionEven",
"sectionOdd": "sectionOdd",
"line": "line",
}
Word.BreakType = BreakType;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// [Api set: WordApi]
var CellPaddingLocation = {
__proto__: null,
"top": "top",
"left": "left",
"bottom": "bottom",
"right": "right",
}
Word.CellPaddingLocation = CellPaddingLocation;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// ChangeTracking mode. [Api set: WordApi]
var ChangeTrackingMode = {
__proto__: null,
"off": "off",
"trackAll": "trackAll",
"trackMineOnly": "trackMineOnly",
}
Word.ChangeTrackingMode = ChangeTrackingMode;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// Specify the current version or the original version of the document. [Api set: WordApi]
var ChangeTrackingVersion = {
__proto__: null,
"original": "original",
"current": "current",
}
Word.ChangeTrackingVersion = ChangeTrackingVersion;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var ContentControl = (function(_super) {
__extends(ContentControl, _super);
function ContentControl() {
/// Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text content controls are supported. [Api set: WordApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets or sets the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. [Api set: WordApi 1.1]
/// Gets or sets a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. [Api set: WordApi 1.1]
/// Gets or sets a value that indicates whether the user can edit the contents of the content control. [Api set: WordApi 1.1]
/// Gets or sets the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. [Api set: WordApi 1.1]
/// Gets the collection of content control objects in the content control. Read-only. [Api set: WordApi 1.1]
/// Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. Read-only. [Api set: WordApi 1.1]
/// Gets an integer that represents the content control identifier. Read-only. [Api set: WordApi 1.1]
/// Gets the collection of inlinePicture objects in the content control. The collection does not include floating images. Read-only. [Api set: WordApi 1.1]
/// Gets the collection of list objects in the content control. Read-only. [Api set: WordApi 1.3]
/// Get the collection of paragraph objects in the content control. Read-only. [Api set: WordApi 1.1]
/// Gets the parent body of the content control. Read-only. [Api set: WordApi 1.3]
/// Gets the content control that contains the content control. Throws an error if there isn't a parent content control. Read-only. [Api set: WordApi 1.1]
/// Gets the content control that contains the content control. Returns a null object if there isn't a parent content control. Read-only. [Api set: WordApi 1.3]
/// Gets the table that contains the content control. Throws an error if it is not contained in a table. Read-only. [Api set: WordApi 1.3]
/// Gets the table cell that contains the content control. Throws an error if it is not contained in a table cell. Read-only. [Api set: WordApi 1.3]
/// Gets the table cell that contains the content control. Returns a null object if it is not contained in a table cell. Read-only. [Api set: WordApi 1.3]
/// Gets the table that contains the content control. Returns a null object if it is not contained in a table. Read-only. [Api set: WordApi 1.3]
/// Gets or sets the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. **Note**: The set operation for this property is not supported in Word on the web. [Api set: WordApi 1.1]
/// Gets or sets a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. [Api set: WordApi 1.1]
/// Gets or sets the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. [Api set: WordApi 1.1]
/// Gets or sets the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. [Api set: WordApi 1.3]
/// Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls. Read-only. [Api set: WordApi 1.3]
/// Gets the collection of table objects in the content control. Read-only. [Api set: WordApi 1.3]
/// Gets or sets a tag to identify a content control. [Api set: WordApi 1.1]
/// Gets the text of the content control. Read-only. [Api set: WordApi 1.1]
/// Gets or sets the title for a content control. [Api set: WordApi 1.1]
/// Gets the content control type. Only rich text content controls are supported currently. Read-only. [Api set: WordApi 1.1]
}
ContentControl.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ContentControl.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Word.Interfaces.ContentControlUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ContentControl object, with properties that have already been loaded and synced.
///
}
ContentControl.prototype.clear = function() {
///
/// Clears the contents of the content control. The user can perform the undo operation on the cleared content. [Api set: WordApi 1.1]
///
///
}
ContentControl.prototype.delete = function(keepContent) {
///
/// Deletes the content control and its content. If keepContent is set to true, the content is not deleted. [Api set: WordApi 1.1]
///
/// Required. Indicates whether the content should be deleted with the content control. If keepContent is set to true, the content is not deleted.
///
}
ContentControl.prototype.getHtml = function() {
///
/// Gets an HTML representation of the content control object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `ContentControl.getOoxml()` and convert the returned XML to HTML. [Api set: WordApi 1.1]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = '';
return result;
}
ContentControl.prototype.getOoxml = function() {
///
/// Gets the Office Open XML (OOXML) representation of the content control object. [Api set: WordApi 1.1]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = '';
return result;
}
ContentControl.prototype.getRange = function(rangeLocation) {
///
/// Gets the whole content control, or the starting or ending point of the content control, as a range. [Api set: WordApi 1.3]
///
/// Optional. The range location can be 'Whole', 'Before', 'Start', 'End', 'After', or 'Content'.
///
}
ContentControl.prototype.getTextRanges = function(endingMarks, trimSpacing) {
///
/// Gets the text ranges in the content control by using punctuation marks and/or other ending marks. [Api set: WordApi 1.3]
///
/// Required. The punctuation marks and/or other ending marks as an array of strings.
/// Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection.
///
}
ContentControl.prototype.insertBreak = function(breakType, insertLocation) {
///
/// Inserts a break at the specified location in the main document. This method cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls. [Api set: WordApi 1.1]
///
/// Required. Type of break.
/// Required. The value can be 'Start', 'End', 'Before', or 'After'.
///
}
ContentControl.prototype.insertFileFromBase64 = function(base64File, insertLocation) {
///
/// Inserts a document into the content control at the specified location. [Api set: WordApi 1.1]
///
/// Required. The base64 encoded content of a .docx file.
/// Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
///
}
ContentControl.prototype.insertHtml = function(html, insertLocation) {
///
/// Inserts HTML into the content control at the specified location. [Api set: WordApi 1.1]
///
/// Required. The HTML to be inserted in to the content control.
/// Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
///
}
ContentControl.prototype.insertInlinePictureFromBase64 = function(base64EncodedImage, insertLocation) {
///
/// Inserts an inline picture into the content control at the specified location. [Api set: WordApi 1.2]
///
/// Required. The base64 encoded image to be inserted in the content control.
/// Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
///
}
ContentControl.prototype.insertOoxml = function(ooxml, insertLocation) {
///
/// Inserts OOXML into the content control at the specified location. [Api set: WordApi 1.1]
///
/// Required. The OOXML to be inserted in to the content control.
/// Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
///
}
ContentControl.prototype.insertParagraph = function(paragraphText, insertLocation) {
///
/// Inserts a paragraph at the specified location. [Api set: WordApi 1.1]
///
/// Required. The paragraph text to be inserted.
/// Required. The value can be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
///
}
ContentControl.prototype.insertTable = function(rowCount, columnCount, insertLocation, values) {
///
/// Inserts a table with the specified number of rows and columns into, or next to, a content control. [Api set: WordApi 1.3]
///
/// Required. The number of rows in the table.
/// Required. The number of columns in the table.
/// Required. The value can be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
/// Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
///
}
ContentControl.prototype.insertText = function(text, insertLocation) {
///
/// Inserts text into the content control at the specified location. [Api set: WordApi 1.1]
///
/// Required. The text to be inserted in to the content control.
/// Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
///
}
ContentControl.prototype.search = function(searchText, searchOptions) {
///
/// Performs a search with the specified SearchOptions on the scope of the content control object. The search results are a collection of range objects. [Api set: WordApi 1.1]
///
/// Required. The search text.
/// Optional. Options for the search.
///
}
ContentControl.prototype.select = function(selectionMode) {
///
/// Selects the content control. This causes Word to scroll to the selection. [Api set: WordApi 1.1]
///
/// Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
///
}
ContentControl.prototype.split = function(delimiters, multiParagraphs, trimDelimiters, trimSpacing) {
///
/// Splits the content control into child ranges by using delimiters. [Api set: WordApi 1.3]
///
/// Required. The delimiters as an array of strings.
/// Optional. Indicates whether a returned child range can cover multiple paragraphs. Default is false which indicates that the paragraph boundaries are also used as delimiters.
/// Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is false which indicates that the delimiters are included in the ranges returned in the range collection.
/// Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection.
///
}
ContentControl.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
ContentControl.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return ContentControl;
})(OfficeExtension.ClientObject);
Word.ContentControl = ContentControl;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// ContentControl appearance [Api set: WordApi]
var ContentControlAppearance = {
__proto__: null,
"boundingBox": "boundingBox",
"tags": "tags",
"hidden": "hidden",
}
Word.ContentControlAppearance = ContentControlAppearance;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var ContentControlCollection = (function(_super) {
__extends(ContentControlCollection, _super);
function ContentControlCollection() {
/// Contains a collection of {@link Word.ContentControl} objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text content controls are supported. [Api set: WordApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
ContentControlCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ContentControlCollection.prototype.getById = function(id) {
///
/// Gets a content control by its identifier. Throws an error if there isn't a content control with the identifier in this collection. [Api set: WordApi 1.1]
///
/// Required. A content control identifier.
///
}
ContentControlCollection.prototype.getByIdOrNullObject = function(id) {
///
/// Gets a content control by its identifier. Returns a null object if there isn't a content control with the identifier in this collection. [Api set: WordApi 1.3]
///
/// Required. A content control identifier.
///
}
ContentControlCollection.prototype.getByTag = function(tag) {
///
/// Gets the content controls that have the specified tag. [Api set: WordApi 1.1]
///
/// Required. A tag set on a content control.
///
}
ContentControlCollection.prototype.getByTitle = function(title) {
///
/// Gets the content controls that have the specified title. [Api set: WordApi 1.1]
///
/// Required. The title of a content control.
///
}
ContentControlCollection.prototype.getByTypes = function(types) {
///
/// Gets the content controls that have the specified types and/or subtypes. [Api set: WordApi 1.3]
///
/// Required. An array of content control types and/or subtypes.
///
}
ContentControlCollection.prototype.getFirst = function() {
///
/// Gets the first content control in this collection. Throws an error if this collection is empty. [Api set: WordApi 1.3]
///
///
}
ContentControlCollection.prototype.getFirstOrNullObject = function() {
///
/// Gets the first content control in this collection. Returns a null object if this collection is empty. [Api set: WordApi 1.3]
///
///
}
ContentControlCollection.prototype.getItem = function(index) {
///
/// Gets a content control by its index in the collection. [Api set: WordApi 1.1]
///
/// The index.
///
}
ContentControlCollection.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
ContentControlCollection.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return ContentControlCollection;
})(OfficeExtension.ClientObject);
Word.ContentControlCollection = ContentControlCollection;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// Specifies supported content control types and subtypes. [Api set: WordApi]
var ContentControlType = {
__proto__: null,
"unknown": "unknown",
"richTextInline": "richTextInline",
"richTextParagraphs": "richTextParagraphs",
"richTextTableCell": "richTextTableCell",
"richTextTableRow": "richTextTableRow",
"richTextTable": "richTextTable",
"plainTextInline": "plainTextInline",
"plainTextParagraph": "plainTextParagraph",
"picture": "picture",
"buildingBlockGallery": "buildingBlockGallery",
"checkBox": "checkBox",
"comboBox": "comboBox",
"dropDownList": "dropDownList",
"datePicker": "datePicker",
"repeatingSection": "repeatingSection",
"richText": "richText",
"plainText": "plainText",
}
Word.ContentControlType = ContentControlType;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var CustomProperty = (function(_super) {
__extends(CustomProperty, _super);
function CustomProperty() {
/// Represents a custom property. [Api set: WordApi 1.3]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the key of the custom property. Read only. [Api set: WordApi 1.3]
/// Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. Read only. [Api set: WordApi 1.3]
/// Gets or sets the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). [Api set: WordApi 1.3]
}
CustomProperty.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
CustomProperty.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Word.Interfaces.CustomPropertyUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing CustomProperty object, with properties that have already been loaded and synced.
///
}
CustomProperty.prototype.delete = function() {
///
/// Deletes the custom property. [Api set: WordApi 1.3]
///
///
}
CustomProperty.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
CustomProperty.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return CustomProperty;
})(OfficeExtension.ClientObject);
Word.CustomProperty = CustomProperty;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var CustomPropertyCollection = (function(_super) {
__extends(CustomPropertyCollection, _super);
function CustomPropertyCollection() {
/// Contains the collection of {@link Word.CustomProperty} objects. [Api set: WordApi 1.3]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
CustomPropertyCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
CustomPropertyCollection.prototype.add = function(key, value) {
///
/// Creates a new or sets an existing custom property. [Api set: WordApi 1.3]
///
/// Required. The custom property's key, which is case-insensitive.
/// Required. The custom property's value.
///
}
CustomPropertyCollection.prototype.deleteAll = function() {
///
/// Deletes all custom properties in this collection. [Api set: WordApi 1.3]
///
///
}
CustomPropertyCollection.prototype.getCount = function() {
///
/// Gets the count of custom properties. [Api set: WordApi 1.3]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
CustomPropertyCollection.prototype.getItem = function(key) {
///
/// Gets a custom property object by its key, which is case-insensitive. Throws an error if the custom property does not exist. [Api set: WordApi 1.3]
///
/// The key that identifies the custom property object.
///
}
CustomPropertyCollection.prototype.getItemOrNullObject = function(key) {
///
/// Gets a custom property object by its key, which is case-insensitive. Returns a null object if the custom property does not exist. [Api set: WordApi 1.3]
///
/// Required. The key that identifies the custom property object.
///
}
CustomPropertyCollection.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
CustomPropertyCollection.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return CustomPropertyCollection;
})(OfficeExtension.ClientObject);
Word.CustomPropertyCollection = CustomPropertyCollection;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Document = (function(_super) {
__extends(Document, _super);
function Document() {
/// The Document object is the top level object. A Document object contains one or more sections, content controls, and the body that contains the contents of the document. [Api set: WordApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. Read-only. [Api set: WordApi 1.1]
/// Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. Read-only. [Api set: WordApi 1.1]
/// Gets the properties of the document. Read-only. [Api set: WordApi 1.3]
/// Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. Read-only. [Api set: WordApi 1.1]
/// Gets the collection of section objects in the document. Read-only. [Api set: WordApi 1.1]
}
Document.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Document.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Word.Interfaces.DocumentUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing Document object, with properties that have already been loaded and synced.
///
}
Document.prototype.getSelection = function() {
///
/// Gets the current selection of the document. Multiple selections are not supported. [Api set: WordApi 1.1]
///
///
}
Document.prototype.save = function() {
///
/// Saves the document. This uses the Word default file naming convention if the document has not been saved before. [Api set: WordApi 1.1]
///
///
}
Document.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
Document.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return Document;
})(OfficeExtension.ClientObject);
Word.Document = Document;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var DocumentCreated = (function(_super) {
__extends(DocumentCreated, _super);
function DocumentCreated() {
/// The DocumentCreated object is the top level object created by Application.CreateDocument. A DocumentCreated object is a special Document object. [Api set: WordApi 1.3]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.. Read-only. [Api set: WordApiHiddenDocument 1.3]
/// Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc.. Read-only. [Api set: WordApiHiddenDocument 1.3]
/// Gets the properties of the document. Read-only. [Api set: WordApiHiddenDocument 1.3]
/// Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. Read-only. [Api set: WordApiHiddenDocument 1.3]
/// Gets the collection of section objects in the document. Read-only. [Api set: WordApiHiddenDocument 1.3]
}
DocumentCreated.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
DocumentCreated.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Word.Interfaces.DocumentCreatedUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing DocumentCreated object, with properties that have already been loaded and synced.
///
}
DocumentCreated.prototype.open = function() {
///
/// Opens the document. [Api set: WordApi 1.3]
///
///
}
DocumentCreated.prototype.save = function() {
///
/// Saves the document. This uses the Word default file naming convention if the document has not been saved before. [Api set: WordApiHiddenDocument 1.3]
///
///
}
DocumentCreated.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
DocumentCreated.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return DocumentCreated;
})(OfficeExtension.ClientObject);
Word.DocumentCreated = DocumentCreated;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var DocumentProperties = (function(_super) {
__extends(DocumentProperties, _super);
function DocumentProperties() {
/// Represents document properties. [Api set: WordApi 1.3]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the application name of the document. Read only. [Api set: WordApi 1.3]
/// Gets or sets the author of the document. [Api set: WordApi 1.3]
/// Gets or sets the category of the document. [Api set: WordApi 1.3]
/// Gets or sets the comments of the document. [Api set: WordApi 1.3]
/// Gets or sets the company of the document. [Api set: WordApi 1.3]
/// Gets the creation date of the document. Read only. [Api set: WordApi 1.3]
/// Gets the collection of custom properties of the document. Read only. [Api set: WordApi 1.3]
/// Gets or sets the format of the document. [Api set: WordApi 1.3]
/// Gets or sets the keywords of the document. [Api set: WordApi 1.3]
/// Gets the last author of the document. Read only. [Api set: WordApi 1.3]
/// Gets the last print date of the document. Read only. [Api set: WordApi 1.3]
/// Gets the last save time of the document. Read only. [Api set: WordApi 1.3]
/// Gets or sets the manager of the document. [Api set: WordApi 1.3]
/// Gets the revision number of the document. Read only. [Api set: WordApi 1.3]
/// Gets security settings of the document. Read only. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. [Api set: WordApi 1.3]
/// Gets or sets the subject of the document. [Api set: WordApi 1.3]
/// Gets the template of the document. Read only. [Api set: WordApi 1.3]
/// Gets or sets the title of the document. [Api set: WordApi 1.3]
}
DocumentProperties.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
DocumentProperties.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Word.Interfaces.DocumentPropertiesUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing DocumentProperties object, with properties that have already been loaded and synced.
///
}
DocumentProperties.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
DocumentProperties.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return DocumentProperties;
})(OfficeExtension.ClientObject);
Word.DocumentProperties = DocumentProperties;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// [Api set: WordApi]
var DocumentPropertyType = {
__proto__: null,
"string": "string",
"number": "number",
"date": "date",
"boolean": "boolean",
}
Word.DocumentPropertyType = DocumentPropertyType;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// Provides information about the type of a raised event. For each object type, please keep the order of: deleted, selection changed, data changed, added. [Api set: WordApi]
var EventType = {
__proto__: null,
"contentControlDeleted": "contentControlDeleted",
"contentControlSelectionChanged": "contentControlSelectionChanged",
"contentControlDataChanged": "contentControlDataChanged",
"contentControlAdded": "contentControlAdded",
"annotationAdded": "annotationAdded",
"annotationChanged": "annotationChanged",
"annotationDeleted": "annotationDeleted",
}
Word.EventType = EventType;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// [Api set: WordApi]
var FileContentFormat = {
__proto__: null,
"base64": "base64",
"html": "html",
"ooxml": "ooxml",
}
Word.FileContentFormat = FileContentFormat;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Font = (function(_super) {
__extends(Font, _super);
function Font() {
/// Represents a font. [Api set: WordApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets or sets a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. [Api set: WordApi 1.1]
/// Gets or sets the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. [Api set: WordApi 1.1]
/// Gets or sets a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. [Api set: WordApi 1.1]
/// Gets or sets the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or null for no highlight color. **Note**: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. [Api set: WordApi 1.1]
/// Gets or sets a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. [Api set: WordApi 1.1]
/// Gets or sets a value that represents the name of the font. [Api set: WordApi 1.1]
/// Gets or sets a value that represents the font size in points. [Api set: WordApi 1.1]
/// Gets or sets a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. [Api set: WordApi 1.1]
/// Gets or sets a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. [Api set: WordApi 1.1]
/// Gets or sets a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. [Api set: WordApi 1.1]
/// Gets or sets a value that indicates the font's underline type. 'None' if the font is not underlined. [Api set: WordApi 1.1]
}
Font.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Font.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Word.Interfaces.FontUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing Font object, with properties that have already been loaded and synced.
///
}
Font.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
Font.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return Font;
})(OfficeExtension.ClientObject);
Word.Font = Font;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// [Api set: WordApi]
var HeaderFooterType = {
__proto__: null,
"primary": "primary",
"firstPage": "firstPage",
"evenPages": "evenPages",
}
Word.HeaderFooterType = HeaderFooterType;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// [Api set: WordApi]
var ImageFormat = {
__proto__: null,
"unsupported": "unsupported",
"undefined": "undefined",
"bmp": "bmp",
"jpeg": "jpeg",
"gif": "gif",
"tiff": "tiff",
"png": "png",
"icon": "icon",
"exif": "exif",
"wmf": "wmf",
"emf": "emf",
"pict": "pict",
"pdf": "pdf",
"svg": "svg",
}
Word.ImageFormat = ImageFormat;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var InlinePicture = (function(_super) {
__extends(InlinePicture, _super);
function InlinePicture() {
/// Represents an inline picture. [Api set: WordApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets or sets a string that represents the alternative text associated with the inline image. [Api set: WordApi 1.1]
/// Gets or sets a string that contains the title for the inline image. [Api set: WordApi 1.1]
/// Gets or sets a number that describes the height of the inline image. [Api set: WordApi 1.1]
/// Gets or sets a hyperlink on the image. Use a '#' to separate the address part from the optional location part. [Api set: WordApi 1.1]
/// Gets or sets a value that indicates whether the inline image retains its original proportions when you resize it. [Api set: WordApi 1.1]
/// Gets the parent paragraph that contains the inline image. Read-only. [Api set: WordApi 1.2]
/// Gets the content control that contains the inline image. Throws an error if there isn't a parent content control. Read-only. [Api set: WordApi 1.1]
/// Gets the content control that contains the inline image. Returns a null object if there isn't a parent content control. Read-only. [Api set: WordApi 1.3]
/// Gets the table that contains the inline image. Throws an error if it is not contained in a table. Read-only. [Api set: WordApi 1.3]
/// Gets the table cell that contains the inline image. Throws an error if it is not contained in a table cell. Read-only. [Api set: WordApi 1.3]
/// Gets the table cell that contains the inline image. Returns a null object if it is not contained in a table cell. Read-only. [Api set: WordApi 1.3]
/// Gets the table that contains the inline image. Returns a null object if it is not contained in a table. Read-only. [Api set: WordApi 1.3]
/// Gets or sets a number that describes the width of the inline image. [Api set: WordApi 1.1]
}
InlinePicture.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
InlinePicture.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Word.Interfaces.InlinePictureUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing InlinePicture object, with properties that have already been loaded and synced.
///
}
InlinePicture.prototype.delete = function() {
///
/// Deletes the inline picture from the document. [Api set: WordApi 1.2]
///
///
}
InlinePicture.prototype.getBase64ImageSrc = function() {
///
/// Gets the base64 encoded string representation of the inline image. [Api set: WordApi 1.1]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = '';
return result;
}
InlinePicture.prototype.getNext = function() {
///
/// Gets the next inline image. Throws an error if this inline image is the last one. [Api set: WordApi 1.3]
///
///
}
InlinePicture.prototype.getNextOrNullObject = function() {
///
/// Gets the next inline image. Returns a null object if this inline image is the last one. [Api set: WordApi 1.3]
///
///
}
InlinePicture.prototype.getRange = function(rangeLocation) {
///
/// Gets the picture, or the starting or ending point of the picture, as a range. [Api set: WordApi 1.3]
///
/// Optional. The range location can be 'Whole', 'Start', or 'End'.
///
}
InlinePicture.prototype.insertBreak = function(breakType, insertLocation) {
///
/// Inserts a break at the specified location in the main document. [Api set: WordApi 1.2]
///
/// Required. The break type to add.
/// Required. The value can be 'Before' or 'After'.
///
}
InlinePicture.prototype.insertContentControl = function() {
///
/// Wraps the inline picture with a rich text content control. [Api set: WordApi 1.1]
///
///
}
InlinePicture.prototype.insertFileFromBase64 = function(base64File, insertLocation) {
///
/// Inserts a document at the specified location. [Api set: WordApi 1.2]
///
/// Required. The base64 encoded content of a .docx file.
/// Required. The value can be 'Before' or 'After'.
///
}
InlinePicture.prototype.insertHtml = function(html, insertLocation) {
///
/// Inserts HTML at the specified location. [Api set: WordApi 1.2]
///
/// Required. The HTML to be inserted.
/// Required. The value can be 'Before' or 'After'.
///
}
InlinePicture.prototype.insertInlinePictureFromBase64 = function(base64EncodedImage, insertLocation) {
///
/// Inserts an inline picture at the specified location. [Api set: WordApi 1.2]
///
/// Required. The base64 encoded image to be inserted.
/// Required. The value can be 'Replace', 'Before', or 'After'.
///
}
InlinePicture.prototype.insertOoxml = function(ooxml, insertLocation) {
///
/// Inserts OOXML at the specified location. [Api set: WordApi 1.2]
///
/// Required. The OOXML to be inserted.
/// Required. The value can be 'Before' or 'After'.
///
}
InlinePicture.prototype.insertParagraph = function(paragraphText, insertLocation) {
///
/// Inserts a paragraph at the specified location. [Api set: WordApi 1.2]
///
/// Required. The paragraph text to be inserted.
/// Required. The value can be 'Before' or 'After'.
///
}
InlinePicture.prototype.insertText = function(text, insertLocation) {
///
/// Inserts text at the specified location. [Api set: WordApi 1.2]
///
/// Required. Text to be inserted.
/// Required. The value can be 'Before' or 'After'.
///
}
InlinePicture.prototype.select = function(selectionMode) {
///
/// Selects the inline picture. This causes Word to scroll to the selection. [Api set: WordApi 1.2]
///
/// Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
///
}
InlinePicture.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
InlinePicture.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return InlinePicture;
})(OfficeExtension.ClientObject);
Word.InlinePicture = InlinePicture;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var InlinePictureCollection = (function(_super) {
__extends(InlinePictureCollection, _super);
function InlinePictureCollection() {
/// Contains a collection of {@link Word.InlinePicture} objects. [Api set: WordApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
InlinePictureCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
InlinePictureCollection.prototype.getFirst = function() {
///
/// Gets the first inline image in this collection. Throws an error if this collection is empty. [Api set: WordApi 1.3]
///
///
}
InlinePictureCollection.prototype.getFirstOrNullObject = function() {
///
/// Gets the first inline image in this collection. Returns a null object if this collection is empty. [Api set: WordApi 1.3]
///
///
}
InlinePictureCollection.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
InlinePictureCollection.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return InlinePictureCollection;
})(OfficeExtension.ClientObject);
Word.InlinePictureCollection = InlinePictureCollection;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// The insertion location types [Api set: WordApi]
var InsertLocation = {
__proto__: null,
"before": "before",
"after": "after",
"start": "start",
"end": "end",
"replace": "replace",
}
Word.InsertLocation = InsertLocation;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var List = (function(_super) {
__extends(List, _super);
function List() {
/// Contains a collection of {@link Word.Paragraph} objects. [Api set: WordApi 1.3]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the list's id. [Api set: WordApi 1.3]
/// Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. Read-only. [Api set: WordApi 1.3]
/// Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. Read-only. [Api set: WordApi 1.3]
/// Gets paragraphs in the list. Read-only. [Api set: WordApi 1.3]
}
List.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
List.prototype.getLevelParagraphs = function(level) {
///
/// Gets the paragraphs that occur at the specified level in the list. [Api set: WordApi 1.3]
///
/// Required. The level in the list.
///
}
List.prototype.getLevelString = function(level) {
///
/// Gets the bullet, number, or picture at the specified level as a string. [Api set: WordApi 1.3]
///
/// Required. The level in the list.
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = '';
return result;
}
List.prototype.insertParagraph = function(paragraphText, insertLocation) {
///
/// Inserts a paragraph at the specified location. [Api set: WordApi 1.3]
///
/// Required. The paragraph text to be inserted.
/// Required. The value can be 'Start', 'End', 'Before', or 'After'.
///
}
List.prototype.setLevelAlignment = function(level, alignment) {
///
/// Sets the alignment of the bullet, number, or picture at the specified level in the list. [Api set: WordApi 1.3]
///
/// Required. The level in the list.
/// Required. The level alignment that can be 'Left', 'Centered', or 'Right'.
///
}
List.prototype.setLevelBullet = function(level, listBullet, charCode, fontName) {
///
/// Sets the bullet format at the specified level in the list. If the bullet is 'Custom', the charCode is required. [Api set: WordApi 1.3]
///
/// Required. The level in the list.
/// Required. The bullet.
/// Optional. The bullet character's code value. Used only if the bullet is 'Custom'.
/// Optional. The bullet's font name. Used only if the bullet is 'Custom'.
///
}
List.prototype.setLevelIndents = function(level, textIndent, bulletNumberPictureIndent) {
///
/// Sets the two indents of the specified level in the list. [Api set: WordApi 1.3]
///
/// Required. The level in the list.
/// Required. The text indent in points. It is the same as paragraph left indent.
/// Required. The relative indent, in points, of the bullet, number, or picture. It is the same as paragraph first line indent.
///
}
List.prototype.setLevelNumbering = function(level, listNumbering, formatString) {
///
/// Sets the numbering format at the specified level in the list. [Api set: WordApi 1.3]
///
/// Required. The level in the list.
/// Required. The ordinal format.
/// Optional. The numbering string format defined as an array of strings and/or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number.
///
}
List.prototype.setLevelStartingNumber = function(level, startingNumber) {
///
/// Sets the starting number at the specified level in the list. Default value is 1. [Api set: WordApi 1.3]
///
/// Required. The level in the list.
/// Required. The number to start with.
///
}
List.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
List.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return List;
})(OfficeExtension.ClientObject);
Word.List = List;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// [Api set: WordApi]
var ListBullet = {
__proto__: null,
"custom": "custom",
"solid": "solid",
"hollow": "hollow",
"square": "square",
"diamonds": "diamonds",
"arrow": "arrow",
"checkmark": "checkmark",
}
Word.ListBullet = ListBullet;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var ListCollection = (function(_super) {
__extends(ListCollection, _super);
function ListCollection() {
/// Contains a collection of {@link Word.List} objects. [Api set: WordApi 1.3]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
ListCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ListCollection.prototype.getById = function(id) {
///
/// Gets a list by its identifier. Throws an error if there isn't a list with the identifier in this collection. [Api set: WordApi 1.3]
///
/// Required. A list identifier.
///
}
ListCollection.prototype.getByIdOrNullObject = function(id) {
///
/// Gets a list by its identifier. Returns a null object if there isn't a list with the identifier in this collection. [Api set: WordApi 1.3]
///
/// Required. A list identifier.
///
}
ListCollection.prototype.getFirst = function() {
///
/// Gets the first list in this collection. Throws an error if this collection is empty. [Api set: WordApi 1.3]
///
///
}
ListCollection.prototype.getFirstOrNullObject = function() {
///
/// Gets the first list in this collection. Returns a null object if this collection is empty. [Api set: WordApi 1.3]
///
///
}
ListCollection.prototype.getItem = function(index) {
///
/// Gets a list object by its index in the collection. [Api set: WordApi 1.3]
///
/// A number that identifies the index location of a list object.
///
}
ListCollection.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
ListCollection.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return ListCollection;
})(OfficeExtension.ClientObject);
Word.ListCollection = ListCollection;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var ListItem = (function(_super) {
__extends(ListItem, _super);
function ListItem() {
/// Represents the paragraph list item format. [Api set: WordApi 1.3]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets or sets the level of the item in the list. [Api set: WordApi 1.3]
/// Gets the list item bullet, number, or picture as a string. Read-only. [Api set: WordApi 1.3]
/// Gets the list item order number in relation to its siblings. Read-only. [Api set: WordApi 1.3]
}
ListItem.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ListItem.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Word.Interfaces.ListItemUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing ListItem object, with properties that have already been loaded and synced.
///
}
ListItem.prototype.getAncestor = function(parentOnly) {
///
/// Gets the list item parent, or the closest ancestor if the parent does not exist. Throws an error if the list item has no ancestor. [Api set: WordApi 1.3]
///
/// Optional. Specifies only the list item's parent will be returned. The default is false that specifies to get the lowest ancestor.
///
}
ListItem.prototype.getAncestorOrNullObject = function(parentOnly) {
///
/// Gets the list item parent, or the closest ancestor if the parent does not exist. Returns a null object if the list item has no ancestor. [Api set: WordApi 1.3]
///
/// Optional. Specifies only the list item's parent will be returned. The default is false that specifies to get the lowest ancestor.
///
}
ListItem.prototype.getDescendants = function(directChildrenOnly) {
///
/// Gets all descendant list items of the list item. [Api set: WordApi 1.3]
///
/// Optional. Specifies only the list item's direct children will be returned. The default is false that indicates to get all descendant items.
///
}
ListItem.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
ListItem.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return ListItem;
})(OfficeExtension.ClientObject);
Word.ListItem = ListItem;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// [Api set: WordApi]
var ListLevelType = {
__proto__: null,
"bullet": "bullet",
"number": "number",
"picture": "picture",
}
Word.ListLevelType = ListLevelType;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// [Api set: WordApi]
var ListNumbering = {
__proto__: null,
"none": "none",
"arabic": "arabic",
"upperRoman": "upperRoman",
"lowerRoman": "lowerRoman",
"upperLetter": "upperLetter",
"lowerLetter": "lowerLetter",
}
Word.ListNumbering = ListNumbering;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// [Api set: WordApi]
var LocationRelation = {
__proto__: null,
"unrelated": "unrelated",
"equal": "equal",
"containsStart": "containsStart",
"containsEnd": "containsEnd",
"contains": "contains",
"insideStart": "insideStart",
"insideEnd": "insideEnd",
"inside": "inside",
"adjacentBefore": "adjacentBefore",
"overlapsBefore": "overlapsBefore",
"before": "before",
"adjacentAfter": "adjacentAfter",
"overlapsAfter": "overlapsAfter",
"after": "after",
}
Word.LocationRelation = LocationRelation;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// Note item type [Api set: WordApi]
var NoteItemType = {
__proto__: null,
"footnote": "footnote",
"endnote": "endnote",
}
Word.NoteItemType = NoteItemType;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Paragraph = (function(_super) {
__extends(Paragraph, _super);
function Paragraph() {
/// Represents a single paragraph in a selection, range, content control, or document body. [Api set: WordApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets or sets the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. [Api set: WordApi 1.1]
/// Gets the collection of content control objects in the paragraph. Read-only. [Api set: WordApi 1.1]
/// Gets or sets the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. [Api set: WordApi 1.1]
/// Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. Read-only. [Api set: WordApi 1.1]
/// Gets the collection of InlinePicture objects in the paragraph. The collection does not include floating images. Read-only. [Api set: WordApi 1.1]
/// Indicates the paragraph is the last one inside its parent body. Read-only. [Api set: WordApi 1.3]
/// Checks whether the paragraph is a list item. Read-only. [Api set: WordApi 1.3]
/// Gets or sets the left indent value, in points, for the paragraph. [Api set: WordApi 1.1]
/// Gets or sets the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. [Api set: WordApi 1.1]
/// Gets or sets the amount of spacing, in grid lines, after the paragraph. [Api set: WordApi 1.1]
/// Gets or sets the amount of spacing, in grid lines, before the paragraph. [Api set: WordApi 1.1]
/// Gets the List to which this paragraph belongs. Throws an error if the paragraph is not in a list. Read-only. [Api set: WordApi 1.3]
/// Gets the ListItem for the paragraph. Throws an error if the paragraph is not part of a list. Read-only. [Api set: WordApi 1.3]
/// Gets the ListItem for the paragraph. Returns a null object if the paragraph is not part of a list. Read-only. [Api set: WordApi 1.3]
/// Gets the List to which this paragraph belongs. Returns a null object if the paragraph is not in a list. Read-only. [Api set: WordApi 1.3]
/// Gets or sets the outline level for the paragraph. [Api set: WordApi 1.1]
/// Gets the parent body of the paragraph. Read-only. [Api set: WordApi 1.3]
/// Gets the content control that contains the paragraph. Throws an error if there isn't a parent content control. Read-only. [Api set: WordApi 1.1]
/// Gets the content control that contains the paragraph. Returns a null object if there isn't a parent content control. Read-only. [Api set: WordApi 1.3]
/// Gets the table that contains the paragraph. Throws an error if it is not contained in a table. Read-only. [Api set: WordApi 1.3]
/// Gets the table cell that contains the paragraph. Throws an error if it is not contained in a table cell. Read-only. [Api set: WordApi 1.3]
/// Gets the table cell that contains the paragraph. Returns a null object if it is not contained in a table cell. Read-only. [Api set: WordApi 1.3]
/// Gets the table that contains the paragraph. Returns a null object if it is not contained in a table. Read-only. [Api set: WordApi 1.3]
/// Gets or sets the right indent value, in points, for the paragraph. [Api set: WordApi 1.1]
/// Gets or sets the spacing, in points, after the paragraph. [Api set: WordApi 1.1]
/// Gets or sets the spacing, in points, before the paragraph. [Api set: WordApi 1.1]
/// Gets or sets the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. [Api set: WordApi 1.1]
/// Gets or sets the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. [Api set: WordApi 1.3]
/// Gets the level of the paragraph's table. It returns 0 if the paragraph is not in a table. Read-only. [Api set: WordApi 1.3]
/// Gets the text of the paragraph. Read-only. [Api set: WordApi 1.1]
}
Paragraph.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Paragraph.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Word.Interfaces.ParagraphUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing Paragraph object, with properties that have already been loaded and synced.
///
}
Paragraph.prototype.attachToList = function(listId, level) {
///
/// Lets the paragraph join an existing list at the specified level. Fails if the paragraph cannot join the list or if the paragraph is already a list item. [Api set: WordApi 1.3]
///
/// Required. The ID of an existing list.
/// Required. The level in the list.
///
}
Paragraph.prototype.clear = function() {
///
/// Clears the contents of the paragraph object. The user can perform the undo operation on the cleared content. [Api set: WordApi 1.1]
///
///
}
Paragraph.prototype.delete = function() {
///
/// Deletes the paragraph and its content from the document. [Api set: WordApi 1.1]
///
///
}
Paragraph.prototype.detachFromList = function() {
///
/// Moves this paragraph out of its list, if the paragraph is a list item. [Api set: WordApi 1.3]
///
///
}
Paragraph.prototype.getHtml = function() {
///
/// Gets an HTML representation of the paragraph object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Paragraph.getOoxml()` and convert the returned XML to HTML. [Api set: WordApi 1.1]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = '';
return result;
}
Paragraph.prototype.getNext = function() {
///
/// Gets the next paragraph. Throws an error if the paragraph is the last one. [Api set: WordApi 1.3]
///
///
}
Paragraph.prototype.getNextOrNullObject = function() {
///
/// Gets the next paragraph. Returns a null object if the paragraph is the last one. [Api set: WordApi 1.3]
///
///
}
Paragraph.prototype.getOoxml = function() {
///
/// Gets the Office Open XML (OOXML) representation of the paragraph object. [Api set: WordApi 1.1]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = '';
return result;
}
Paragraph.prototype.getPrevious = function() {
///
/// Gets the previous paragraph. Throws an error if the paragraph is the first one. [Api set: WordApi 1.3]
///
///
}
Paragraph.prototype.getPreviousOrNullObject = function() {
///
/// Gets the previous paragraph. Returns a null object if the paragraph is the first one. [Api set: WordApi 1.3]
///
///
}
Paragraph.prototype.getRange = function(rangeLocation) {
///
/// Gets the whole paragraph, or the starting or ending point of the paragraph, as a range. [Api set: WordApi 1.3]
///
/// Optional. The range location can be 'Whole', 'Start', 'End', 'After', or 'Content'.
///
}
Paragraph.prototype.getTextRanges = function(endingMarks, trimSpacing) {
///
/// Gets the text ranges in the paragraph by using punctuation marks and/or other ending marks. [Api set: WordApi 1.3]
///
/// Required. The punctuation marks and/or other ending marks as an array of strings.
/// Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection.
///
}
Paragraph.prototype.insertBreak = function(breakType, insertLocation) {
///
/// Inserts a break at the specified location in the main document. [Api set: WordApi 1.1]
///
/// Required. The break type to add to the document.
/// Required. The value can be 'Before' or 'After'.
///
}
Paragraph.prototype.insertContentControl = function() {
///
/// Wraps the paragraph object with a rich text content control. [Api set: WordApi 1.1]
///
///
}
Paragraph.prototype.insertFileFromBase64 = function(base64File, insertLocation) {
///
/// Inserts a document into the paragraph at the specified location. [Api set: WordApi 1.1]
///
/// Required. The base64 encoded content of a .docx file.
/// Required. The value can be 'Replace', 'Start', or 'End'.
///
}
Paragraph.prototype.insertHtml = function(html, insertLocation) {
///
/// Inserts HTML into the paragraph at the specified location. [Api set: WordApi 1.1]
///
/// Required. The HTML to be inserted in the paragraph.
/// Required. The value can be 'Replace', 'Start', or 'End'.
///
}
Paragraph.prototype.insertInlinePictureFromBase64 = function(base64EncodedImage, insertLocation) {
///
/// Inserts a picture into the paragraph at the specified location. [Api set: WordApi 1.1]
///
/// Required. The base64 encoded image to be inserted.
/// Required. The value can be 'Replace', 'Start', or 'End'.
///
}
Paragraph.prototype.insertOoxml = function(ooxml, insertLocation) {
///
/// Inserts OOXML into the paragraph at the specified location. [Api set: WordApi 1.1]
///
/// Required. The OOXML to be inserted in the paragraph.
/// Required. The value can be 'Replace', 'Start', or 'End'.
///
}
Paragraph.prototype.insertParagraph = function(paragraphText, insertLocation) {
///
/// Inserts a paragraph at the specified location. [Api set: WordApi 1.1]
///
/// Required. The paragraph text to be inserted.
/// Required. The value can be 'Before' or 'After'.
///
}
Paragraph.prototype.insertTable = function(rowCount, columnCount, insertLocation, values) {
///
/// Inserts a table with the specified number of rows and columns. [Api set: WordApi 1.3]
///
/// Required. The number of rows in the table.
/// Required. The number of columns in the table.
/// Required. The value can be 'Before' or 'After'.
/// Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
///
}
Paragraph.prototype.insertText = function(text, insertLocation) {
///
/// Inserts text into the paragraph at the specified location. [Api set: WordApi 1.1]
///
/// Required. Text to be inserted.
/// Required. The value can be 'Replace', 'Start', or 'End'.
///
}
Paragraph.prototype.search = function(searchText, searchOptions) {
///
/// Performs a search with the specified SearchOptions on the scope of the paragraph object. The search results are a collection of range objects. [Api set: WordApi 1.1]
///
/// Required. The search text.
/// Optional. Options for the search.
///
}
Paragraph.prototype.select = function(selectionMode) {
///
/// Selects and navigates the Word UI to the paragraph. [Api set: WordApi 1.1]
///
/// Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
///
}
Paragraph.prototype.split = function(delimiters, trimDelimiters, trimSpacing) {
///
/// Splits the paragraph into child ranges by using delimiters. [Api set: WordApi 1.3]
///
/// Required. The delimiters as an array of strings.
/// Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is false which indicates that the delimiters are included in the ranges returned in the range collection.
/// Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection.
///
}
Paragraph.prototype.startNewList = function() {
///
/// Starts a new list with this paragraph. Fails if the paragraph is already a list item. [Api set: WordApi 1.3]
///
///
}
Paragraph.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
Paragraph.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return Paragraph;
})(OfficeExtension.ClientObject);
Word.Paragraph = Paragraph;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var ParagraphCollection = (function(_super) {
__extends(ParagraphCollection, _super);
function ParagraphCollection() {
/// Contains a collection of {@link Word.Paragraph} objects. [Api set: WordApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
ParagraphCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
ParagraphCollection.prototype.getFirst = function() {
///
/// Gets the first paragraph in this collection. Throws an error if the collection is empty. [Api set: WordApi 1.3]
///
///
}
ParagraphCollection.prototype.getFirstOrNullObject = function() {
///
/// Gets the first paragraph in this collection. Returns a null object if the collection is empty. [Api set: WordApi 1.3]
///
///
}
ParagraphCollection.prototype.getLast = function() {
///
/// Gets the last paragraph in this collection. Throws an error if the collection is empty. [Api set: WordApi 1.3]
///
///
}
ParagraphCollection.prototype.getLastOrNullObject = function() {
///
/// Gets the last paragraph in this collection. Returns a null object if the collection is empty. [Api set: WordApi 1.3]
///
///
}
ParagraphCollection.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
ParagraphCollection.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return ParagraphCollection;
})(OfficeExtension.ClientObject);
Word.ParagraphCollection = ParagraphCollection;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Range = (function(_super) {
__extends(Range, _super);
function Range() {
/// Represents a contiguous area in a document. [Api set: WordApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the collection of content control objects in the range. Read-only. [Api set: WordApi 1.1]
/// Gets the text format of the range. Use this to get and set font name, size, color, and other properties. Read-only. [Api set: WordApi 1.1]
/// Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. [Api set: WordApi 1.3]
/// Gets the collection of inline picture objects in the range. Read-only. [Api set: WordApi 1.2]
/// Checks whether the range length is zero. Read-only. [Api set: WordApi 1.3]
/// Gets the collection of list objects in the range. Read-only. [Api set: WordApi 1.3]
/// Gets the collection of paragraph objects in the range. Read-only. [Api set: WordApi 1.1]
/// Gets the parent body of the range. Read-only. [Api set: WordApi 1.3]
/// Gets the content control that contains the range. Throws an error if there isn't a parent content control. Read-only. [Api set: WordApi 1.1]
/// Gets the content control that contains the range. Returns a null object if there isn't a parent content control. Read-only. [Api set: WordApi 1.3]
/// Gets the table that contains the range. Throws an error if it is not contained in a table. Read-only. [Api set: WordApi 1.3]
/// Gets the table cell that contains the range. Throws an error if it is not contained in a table cell. Read-only. [Api set: WordApi 1.3]
/// Gets the table cell that contains the range. Returns a null object if it is not contained in a table cell. Read-only. [Api set: WordApi 1.3]
/// Gets the table that contains the range. Returns a null object if it is not contained in a table. Read-only. [Api set: WordApi 1.3]
/// Gets or sets the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. [Api set: WordApi 1.1]
/// Gets or sets the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. [Api set: WordApi 1.3]
/// Gets the collection of table objects in the range. Read-only. [Api set: WordApi 1.3]
/// Gets the text of the range. Read-only. [Api set: WordApi 1.1]
}
Range.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Range.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Word.Interfaces.RangeUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing Range object, with properties that have already been loaded and synced.
///
}
Range.prototype.clear = function() {
///
/// Clears the contents of the range object. The user can perform the undo operation on the cleared content. [Api set: WordApi 1.1]
///
///
}
Range.prototype.compareLocationWith = function(range) {
///
/// Compares this range's location with another range's location. [Api set: WordApi 1.3]
///
/// Required. The range to compare with this range.
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = '';
return result;
}
Range.prototype.delete = function() {
///
/// Deletes the range and its content from the document. [Api set: WordApi 1.1]
///
///
}
Range.prototype.expandTo = function(range) {
///
/// Returns a new range that extends from this range in either direction to cover another range. This range is not changed. Throws an error if the two ranges do not have a union. [Api set: WordApi 1.3]
///
/// Required. Another range.
///
}
Range.prototype.expandToOrNullObject = function(range) {
///
/// Returns a new range that extends from this range in either direction to cover another range. This range is not changed. Returns a null object if the two ranges do not have a union. [Api set: WordApi 1.3]
///
/// Required. Another range.
///
}
Range.prototype.getHtml = function() {
///
/// Gets an HTML representation of the range object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Range.getOoxml()` and convert the returned XML to HTML. [Api set: WordApi 1.1]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = '';
return result;
}
Range.prototype.getHyperlinkRanges = function() {
///
/// Gets hyperlink child ranges within the range. [Api set: WordApi 1.3]
///
///
}
Range.prototype.getNextTextRange = function(endingMarks, trimSpacing) {
///
/// Gets the next text range by using punctuation marks and/or other ending marks. Throws an error if this text range is the last one. [Api set: WordApi 1.3]
///
/// Required. The punctuation marks and/or other ending marks as an array of strings.
/// Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is false which indicates that spacing characters at the start and end of the range are included.
///
}
Range.prototype.getNextTextRangeOrNullObject = function(endingMarks, trimSpacing) {
///
/// Gets the next text range by using punctuation marks and/or other ending marks. Returns a null object if this text range is the last one. [Api set: WordApi 1.3]
///
/// Required. The punctuation marks and/or other ending marks as an array of strings.
/// Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is false which indicates that spacing characters at the start and end of the range are included.
///
}
Range.prototype.getOoxml = function() {
///
/// Gets the OOXML representation of the range object. [Api set: WordApi 1.1]
///
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = '';
return result;
}
Range.prototype.getRange = function(rangeLocation) {
///
/// Clones the range, or gets the starting or ending point of the range as a new range. [Api set: WordApi 1.3]
///
/// Optional. The range location can be 'Whole', 'Start', 'End', 'After', or 'Content'.
///
}
Range.prototype.getTextRanges = function(endingMarks, trimSpacing) {
///
/// Gets the text child ranges in the range by using punctuation marks and/or other ending marks. [Api set: WordApi 1.3]
///
/// Required. The punctuation marks and/or other ending marks as an array of strings.
/// Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection.
///
}
Range.prototype.insertBreak = function(breakType, insertLocation) {
///
/// Inserts a break at the specified location in the main document. [Api set: WordApi 1.1]
///
/// Required. The break type to add.
/// Required. The value can be 'Before' or 'After'.
///
}
Range.prototype.insertContentControl = function() {
///
/// Wraps the range object with a rich text content control. [Api set: WordApi 1.1]
///
///
}
Range.prototype.insertFileFromBase64 = function(base64File, insertLocation) {
///
/// Inserts a document at the specified location. [Api set: WordApi 1.1]
///
/// Required. The base64 encoded content of a .docx file.
/// Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
///
}
Range.prototype.insertHtml = function(html, insertLocation) {
///
/// Inserts HTML at the specified location. [Api set: WordApi 1.1]
///
/// Required. The HTML to be inserted.
/// Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
///
}
Range.prototype.insertInlinePictureFromBase64 = function(base64EncodedImage, insertLocation) {
///
/// Inserts a picture at the specified location. [Api set: WordApi 1.2]
///
/// Required. The base64 encoded image to be inserted.
/// Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
///
}
Range.prototype.insertOoxml = function(ooxml, insertLocation) {
///
/// Inserts OOXML at the specified location. [Api set: WordApi 1.1]
///
/// Required. The OOXML to be inserted.
/// Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
///
}
Range.prototype.insertParagraph = function(paragraphText, insertLocation) {
///
/// Inserts a paragraph at the specified location. [Api set: WordApi 1.1]
///
/// Required. The paragraph text to be inserted.
/// Required. The value can be 'Before' or 'After'.
///
}
Range.prototype.insertTable = function(rowCount, columnCount, insertLocation, values) {
///
/// Inserts a table with the specified number of rows and columns. [Api set: WordApi 1.3]
///
/// Required. The number of rows in the table.
/// Required. The number of columns in the table.
/// Required. The value can be 'Before' or 'After'.
/// Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
///
}
Range.prototype.insertText = function(text, insertLocation) {
///
/// Inserts text at the specified location. [Api set: WordApi 1.1]
///
/// Required. Text to be inserted.
/// Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
///
}
Range.prototype.intersectWith = function(range) {
///
/// Returns a new range as the intersection of this range with another range. This range is not changed. Throws an error if the two ranges are not overlapped or adjacent. [Api set: WordApi 1.3]
///
/// Required. Another range.
///
}
Range.prototype.intersectWithOrNullObject = function(range) {
///
/// Returns a new range as the intersection of this range with another range. This range is not changed. Returns a null object if the two ranges are not overlapped or adjacent. [Api set: WordApi 1.3]
///
/// Required. Another range.
///
}
Range.prototype.search = function(searchText, searchOptions) {
///
/// Performs a search with the specified SearchOptions on the scope of the range object. The search results are a collection of range objects. [Api set: WordApi 1.1]
///
/// Required. The search text.
/// Optional. Options for the search.
///
}
Range.prototype.select = function(selectionMode) {
///
/// Selects and navigates the Word UI to the range. [Api set: WordApi 1.1]
///
/// Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
///
}
Range.prototype.split = function(delimiters, multiParagraphs, trimDelimiters, trimSpacing) {
///
/// Splits the range into child ranges by using delimiters. [Api set: WordApi 1.3]
///
/// Required. The delimiters as an array of strings.
/// Optional. Indicates whether a returned child range can cover multiple paragraphs. Default is false which indicates that the paragraph boundaries are also used as delimiters.
/// Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is false which indicates that the delimiters are included in the ranges returned in the range collection.
/// Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection.
///
}
Range.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
Range.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return Range;
})(OfficeExtension.ClientObject);
Word.Range = Range;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var RangeCollection = (function(_super) {
__extends(RangeCollection, _super);
function RangeCollection() {
/// Contains a collection of {@link Word.Range} objects. [Api set: WordApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
RangeCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
RangeCollection.prototype.getFirst = function() {
///
/// Gets the first range in this collection. Throws an error if this collection is empty. [Api set: WordApi 1.3]
///
///
}
RangeCollection.prototype.getFirstOrNullObject = function() {
///
/// Gets the first range in this collection. Returns a null object if this collection is empty. [Api set: WordApi 1.3]
///
///
}
RangeCollection.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
RangeCollection.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return RangeCollection;
})(OfficeExtension.ClientObject);
Word.RangeCollection = RangeCollection;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// [Api set: WordApi]
var RangeLocation = {
__proto__: null,
"whole": "whole",
"start": "start",
"end": "end",
"before": "before",
"after": "after",
"content": "content",
}
Word.RangeLocation = RangeLocation;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var SearchOptions = (function(_super) {
__extends(SearchOptions, _super);
function SearchOptions() {
/// Specifies the options to be included in a search operation. [Api set: WordApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets or sets a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. [Api set: WordApi 1.1]
/// Gets or sets a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. [Api set: WordApi 1.1]
/// Gets or sets a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. [Api set: WordApi 1.1]
/// Gets or sets a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. [Api set: WordApi 1.1]
/// Gets or sets a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. [Api set: WordApi 1.1]
/// Gets or sets a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. [Api set: WordApi 1.1]
/// Gets or sets a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. [Api set: WordApi 1.1]
}
SearchOptions.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
SearchOptions.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Word.Interfaces.SearchOptionsUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing SearchOptions object, with properties that have already been loaded and synced.
///
}
return SearchOptions;
})(OfficeExtension.ClientObject);
Word.SearchOptions = SearchOptions;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Section = (function(_super) {
__extends(Section, _super);
function Section() {
/// Represents a section in a Word document. [Api set: WordApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the body object of the section. This does not include the header/footer and other section metadata. Read-only. [Api set: WordApi 1.1]
}
Section.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Section.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Word.Interfaces.SectionUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing Section object, with properties that have already been loaded and synced.
///
}
Section.prototype.getFooter = function(type) {
///
/// Gets one of the section's footers. [Api set: WordApi 1.1]
///
/// Required. The type of footer to return. This value can be: 'Primary', 'FirstPage', or 'EvenPages'.
///
}
Section.prototype.getHeader = function(type) {
///
/// Gets one of the section's headers. [Api set: WordApi 1.1]
///
/// Required. The type of header to return. This value can be: 'Primary', 'FirstPage', or 'EvenPages'.
///
}
Section.prototype.getNext = function() {
///
/// Gets the next section. Throws an error if this section is the last one. [Api set: WordApi 1.3]
///
///
}
Section.prototype.getNextOrNullObject = function() {
///
/// Gets the next section. Returns a null object if this section is the last one. [Api set: WordApi 1.3]
///
///
}
Section.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
Section.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return Section;
})(OfficeExtension.ClientObject);
Word.Section = Section;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var SectionCollection = (function(_super) {
__extends(SectionCollection, _super);
function SectionCollection() {
/// Contains the collection of the document's {@link Word.Section} objects. [Api set: WordApi 1.1]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
SectionCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
SectionCollection.prototype.getFirst = function() {
///
/// Gets the first section in this collection. Throws an error if this collection is empty. [Api set: WordApi 1.3]
///
///
}
SectionCollection.prototype.getFirstOrNullObject = function() {
///
/// Gets the first section in this collection. Returns a null object if this collection is empty. [Api set: WordApi 1.3]
///
///
}
SectionCollection.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
SectionCollection.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return SectionCollection;
})(OfficeExtension.ClientObject);
Word.SectionCollection = SectionCollection;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// This enum sets where the cursor (insertion point) in the document is after a selection. [Api set: WordApi]
var SelectionMode = {
__proto__: null,
"select": "select",
"start": "start",
"end": "end",
}
Word.SelectionMode = SelectionMode;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// [Api set: WordApi]
var Style = {
__proto__: null,
"other": "other",
"normal": "normal",
"heading1": "heading1",
"heading2": "heading2",
"heading3": "heading3",
"heading4": "heading4",
"heading5": "heading5",
"heading6": "heading6",
"heading7": "heading7",
"heading8": "heading8",
"heading9": "heading9",
"toc1": "toc1",
"toc2": "toc2",
"toc3": "toc3",
"toc4": "toc4",
"toc5": "toc5",
"toc6": "toc6",
"toc7": "toc7",
"toc8": "toc8",
"toc9": "toc9",
"footnoteText": "footnoteText",
"header": "header",
"footer": "footer",
"caption": "caption",
"footnoteReference": "footnoteReference",
"endnoteReference": "endnoteReference",
"endnoteText": "endnoteText",
"title": "title",
"subtitle": "subtitle",
"hyperlink": "hyperlink",
"strong": "strong",
"emphasis": "emphasis",
"noSpacing": "noSpacing",
"listParagraph": "listParagraph",
"quote": "quote",
"intenseQuote": "intenseQuote",
"subtleEmphasis": "subtleEmphasis",
"intenseEmphasis": "intenseEmphasis",
"subtleReference": "subtleReference",
"intenseReference": "intenseReference",
"bookTitle": "bookTitle",
"bibliography": "bibliography",
"tocHeading": "tocHeading",
"tableGrid": "tableGrid",
"plainTable1": "plainTable1",
"plainTable2": "plainTable2",
"plainTable3": "plainTable3",
"plainTable4": "plainTable4",
"plainTable5": "plainTable5",
"tableGridLight": "tableGridLight",
"gridTable1Light": "gridTable1Light",
"gridTable1Light_Accent1": "gridTable1Light_Accent1",
"gridTable1Light_Accent2": "gridTable1Light_Accent2",
"gridTable1Light_Accent3": "gridTable1Light_Accent3",
"gridTable1Light_Accent4": "gridTable1Light_Accent4",
"gridTable1Light_Accent5": "gridTable1Light_Accent5",
"gridTable1Light_Accent6": "gridTable1Light_Accent6",
"gridTable2": "gridTable2",
"gridTable2_Accent1": "gridTable2_Accent1",
"gridTable2_Accent2": "gridTable2_Accent2",
"gridTable2_Accent3": "gridTable2_Accent3",
"gridTable2_Accent4": "gridTable2_Accent4",
"gridTable2_Accent5": "gridTable2_Accent5",
"gridTable2_Accent6": "gridTable2_Accent6",
"gridTable3": "gridTable3",
"gridTable3_Accent1": "gridTable3_Accent1",
"gridTable3_Accent2": "gridTable3_Accent2",
"gridTable3_Accent3": "gridTable3_Accent3",
"gridTable3_Accent4": "gridTable3_Accent4",
"gridTable3_Accent5": "gridTable3_Accent5",
"gridTable3_Accent6": "gridTable3_Accent6",
"gridTable4": "gridTable4",
"gridTable4_Accent1": "gridTable4_Accent1",
"gridTable4_Accent2": "gridTable4_Accent2",
"gridTable4_Accent3": "gridTable4_Accent3",
"gridTable4_Accent4": "gridTable4_Accent4",
"gridTable4_Accent5": "gridTable4_Accent5",
"gridTable4_Accent6": "gridTable4_Accent6",
"gridTable5Dark": "gridTable5Dark",
"gridTable5Dark_Accent1": "gridTable5Dark_Accent1",
"gridTable5Dark_Accent2": "gridTable5Dark_Accent2",
"gridTable5Dark_Accent3": "gridTable5Dark_Accent3",
"gridTable5Dark_Accent4": "gridTable5Dark_Accent4",
"gridTable5Dark_Accent5": "gridTable5Dark_Accent5",
"gridTable5Dark_Accent6": "gridTable5Dark_Accent6",
"gridTable6Colorful": "gridTable6Colorful",
"gridTable6Colorful_Accent1": "gridTable6Colorful_Accent1",
"gridTable6Colorful_Accent2": "gridTable6Colorful_Accent2",
"gridTable6Colorful_Accent3": "gridTable6Colorful_Accent3",
"gridTable6Colorful_Accent4": "gridTable6Colorful_Accent4",
"gridTable6Colorful_Accent5": "gridTable6Colorful_Accent5",
"gridTable6Colorful_Accent6": "gridTable6Colorful_Accent6",
"gridTable7Colorful": "gridTable7Colorful",
"gridTable7Colorful_Accent1": "gridTable7Colorful_Accent1",
"gridTable7Colorful_Accent2": "gridTable7Colorful_Accent2",
"gridTable7Colorful_Accent3": "gridTable7Colorful_Accent3",
"gridTable7Colorful_Accent4": "gridTable7Colorful_Accent4",
"gridTable7Colorful_Accent5": "gridTable7Colorful_Accent5",
"gridTable7Colorful_Accent6": "gridTable7Colorful_Accent6",
"listTable1Light": "listTable1Light",
"listTable1Light_Accent1": "listTable1Light_Accent1",
"listTable1Light_Accent2": "listTable1Light_Accent2",
"listTable1Light_Accent3": "listTable1Light_Accent3",
"listTable1Light_Accent4": "listTable1Light_Accent4",
"listTable1Light_Accent5": "listTable1Light_Accent5",
"listTable1Light_Accent6": "listTable1Light_Accent6",
"listTable2": "listTable2",
"listTable2_Accent1": "listTable2_Accent1",
"listTable2_Accent2": "listTable2_Accent2",
"listTable2_Accent3": "listTable2_Accent3",
"listTable2_Accent4": "listTable2_Accent4",
"listTable2_Accent5": "listTable2_Accent5",
"listTable2_Accent6": "listTable2_Accent6",
"listTable3": "listTable3",
"listTable3_Accent1": "listTable3_Accent1",
"listTable3_Accent2": "listTable3_Accent2",
"listTable3_Accent3": "listTable3_Accent3",
"listTable3_Accent4": "listTable3_Accent4",
"listTable3_Accent5": "listTable3_Accent5",
"listTable3_Accent6": "listTable3_Accent6",
"listTable4": "listTable4",
"listTable4_Accent1": "listTable4_Accent1",
"listTable4_Accent2": "listTable4_Accent2",
"listTable4_Accent3": "listTable4_Accent3",
"listTable4_Accent4": "listTable4_Accent4",
"listTable4_Accent5": "listTable4_Accent5",
"listTable4_Accent6": "listTable4_Accent6",
"listTable5Dark": "listTable5Dark",
"listTable5Dark_Accent1": "listTable5Dark_Accent1",
"listTable5Dark_Accent2": "listTable5Dark_Accent2",
"listTable5Dark_Accent3": "listTable5Dark_Accent3",
"listTable5Dark_Accent4": "listTable5Dark_Accent4",
"listTable5Dark_Accent5": "listTable5Dark_Accent5",
"listTable5Dark_Accent6": "listTable5Dark_Accent6",
"listTable6Colorful": "listTable6Colorful",
"listTable6Colorful_Accent1": "listTable6Colorful_Accent1",
"listTable6Colorful_Accent2": "listTable6Colorful_Accent2",
"listTable6Colorful_Accent3": "listTable6Colorful_Accent3",
"listTable6Colorful_Accent4": "listTable6Colorful_Accent4",
"listTable6Colorful_Accent5": "listTable6Colorful_Accent5",
"listTable6Colorful_Accent6": "listTable6Colorful_Accent6",
"listTable7Colorful": "listTable7Colorful",
"listTable7Colorful_Accent1": "listTable7Colorful_Accent1",
"listTable7Colorful_Accent2": "listTable7Colorful_Accent2",
"listTable7Colorful_Accent3": "listTable7Colorful_Accent3",
"listTable7Colorful_Accent4": "listTable7Colorful_Accent4",
"listTable7Colorful_Accent5": "listTable7Colorful_Accent5",
"listTable7Colorful_Accent6": "listTable7Colorful_Accent6",
}
Word.Style = Style;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Table = (function(_super) {
__extends(Table, _super);
function Table() {
/// Represents a table in a Word document. [Api set: WordApi 1.3]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets or sets the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. [Api set: WordApi 1.3]
/// Gets the font. Use this to get and set font name, size, color, and other properties. Read-only. [Api set: WordApi 1.3]
/// Gets and sets the number of header rows. [Api set: WordApi 1.3]
/// Gets and sets the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. [Api set: WordApi 1.3]
/// Indicates whether all of the table rows are uniform. Read-only. [Api set: WordApi 1.3]
/// Gets the nesting level of the table. Top-level tables have level 1. Read-only. [Api set: WordApi 1.3]
/// Gets the parent body of the table. Read-only. [Api set: WordApi 1.3]
/// Gets the content control that contains the table. Throws an error if there isn't a parent content control. Read-only. [Api set: WordApi 1.3]
/// Gets the content control that contains the table. Returns a null object if there isn't a parent content control. Read-only. [Api set: WordApi 1.3]
/// Gets the table that contains this table. Throws an error if it is not contained in a table. Read-only. [Api set: WordApi 1.3]
/// Gets the table cell that contains this table. Throws an error if it is not contained in a table cell. Read-only. [Api set: WordApi 1.3]
/// Gets the table cell that contains this table. Returns a null object if it is not contained in a table cell. Read-only. [Api set: WordApi 1.3]
/// Gets the table that contains this table. Returns a null object if it is not contained in a table. Read-only. [Api set: WordApi 1.3]
/// Gets the number of rows in the table. Read-only. [Api set: WordApi 1.3]
/// Gets all of the table rows. Read-only. [Api set: WordApi 1.3]
/// Gets and sets the shading color. Color is specified in "#RRGGBB" format or by using the color name. [Api set: WordApi 1.3]
/// Gets or sets the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. [Api set: WordApi 1.3]
/// Gets and sets whether the table has banded columns. [Api set: WordApi 1.3]
/// Gets and sets whether the table has banded rows. [Api set: WordApi 1.3]
/// Gets or sets the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. [Api set: WordApi 1.3]
/// Gets and sets whether the table has a first column with a special style. [Api set: WordApi 1.3]
/// Gets and sets whether the table has a last column with a special style. [Api set: WordApi 1.3]
/// Gets and sets whether the table has a total (last) row with a special style. [Api set: WordApi 1.3]
/// Gets the child tables nested one level deeper. Read-only. [Api set: WordApi 1.3]
/// Gets and sets the text values in the table, as a 2D Javascript array. [Api set: WordApi 1.3]
/// Gets and sets the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. [Api set: WordApi 1.3]
/// Gets and sets the width of the table in points. [Api set: WordApi 1.3]
}
Table.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
Table.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Word.Interfaces.TableUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing Table object, with properties that have already been loaded and synced.
///
}
Table.prototype.addColumns = function(insertLocation, columnCount, values) {
///
/// Adds columns to the start or end of the table, using the first or last existing column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows. [Api set: WordApi 1.3]
///
/// Required. It can be 'Start' or 'End', corresponding to the appropriate side of the table.
/// Required. Number of columns to add.
/// Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
///
}
Table.prototype.addRows = function(insertLocation, rowCount, values) {
///
/// Adds rows to the start or end of the table, using the first or last existing row as a template. The string values, if specified, are set in the newly inserted rows. [Api set: WordApi 1.3]
///
/// Required. It can be 'Start' or 'End'.
/// Required. Number of rows to add.
/// Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
///
}
Table.prototype.autoFitWindow = function() {
///
/// Autofits the table columns to the width of the window. [Api set: WordApi 1.3]
///
///
}
Table.prototype.clear = function() {
///
/// Clears the contents of the table. [Api set: WordApi 1.3]
///
///
}
Table.prototype.delete = function() {
///
/// Deletes the entire table. [Api set: WordApi 1.3]
///
///
}
Table.prototype.deleteColumns = function(columnIndex, columnCount) {
///
/// Deletes specific columns. This is applicable to uniform tables. [Api set: WordApi 1.3]
///
/// Required. The first column to delete.
/// Optional. The number of columns to delete. Default 1.
///
}
Table.prototype.deleteRows = function(rowIndex, rowCount) {
///
/// Deletes specific rows. [Api set: WordApi 1.3]
///
/// Required. The first row to delete.
/// Optional. The number of rows to delete. Default 1.
///
}
Table.prototype.distributeColumns = function() {
///
/// Distributes the column widths evenly. This is applicable to uniform tables. [Api set: WordApi 1.3]
///
///
}
Table.prototype.getBorder = function(borderLocation) {
///
/// Gets the border style for the specified border. [Api set: WordApi 1.3]
///
/// Required. The border location.
///
}
Table.prototype.getCell = function(rowIndex, cellIndex) {
///
/// Gets the table cell at a specified row and column. Throws an error if the specified table cell does not exist. [Api set: WordApi 1.3]
///
/// Required. The index of the row.
/// Required. The index of the cell in the row.
///
}
Table.prototype.getCellOrNullObject = function(rowIndex, cellIndex) {
///
/// Gets the table cell at a specified row and column. Returns a null object if the specified table cell does not exist. [Api set: WordApi 1.3]
///
/// Required. The index of the row.
/// Required. The index of the cell in the row.
///
}
Table.prototype.getCellPadding = function(cellPaddingLocation) {
///
/// Gets cell padding in points. [Api set: WordApi 1.3]
///
/// Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
Table.prototype.getNext = function() {
///
/// Gets the next table. Throws an error if this table is the last one. [Api set: WordApi 1.3]
///
///
}
Table.prototype.getNextOrNullObject = function() {
///
/// Gets the next table. Returns a null object if this table is the last one. [Api set: WordApi 1.3]
///
///
}
Table.prototype.getParagraphAfter = function() {
///
/// Gets the paragraph after the table. Throws an error if there isn't a paragraph after the table. [Api set: WordApi 1.3]
///
///
}
Table.prototype.getParagraphAfterOrNullObject = function() {
///
/// Gets the paragraph after the table. Returns a null object if there isn't a paragraph after the table. [Api set: WordApi 1.3]
///
///
}
Table.prototype.getParagraphBefore = function() {
///
/// Gets the paragraph before the table. Throws an error if there isn't a paragraph before the table. [Api set: WordApi 1.3]
///
///
}
Table.prototype.getParagraphBeforeOrNullObject = function() {
///
/// Gets the paragraph before the table. Returns a null object if there isn't a paragraph before the table. [Api set: WordApi 1.3]
///
///
}
Table.prototype.getRange = function(rangeLocation) {
///
/// Gets the range that contains this table, or the range at the start or end of the table. [Api set: WordApi 1.3]
///
/// Optional. The range location can be 'Whole', 'Start', 'End', or 'After'.
///
}
Table.prototype.insertContentControl = function() {
///
/// Inserts a content control on the table. [Api set: WordApi 1.3]
///
///
}
Table.prototype.insertParagraph = function(paragraphText, insertLocation) {
///
/// Inserts a paragraph at the specified location. [Api set: WordApi 1.3]
///
/// Required. The paragraph text to be inserted.
/// Required. The value can be 'Before' or 'After'.
///
}
Table.prototype.insertTable = function(rowCount, columnCount, insertLocation, values) {
///
/// Inserts a table with the specified number of rows and columns. [Api set: WordApi 1.3]
///
/// Required. The number of rows in the table.
/// Required. The number of columns in the table.
/// Required. The value can be 'Before' or 'After'.
/// Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
///
}
Table.prototype.search = function(searchText, searchOptions) {
///
/// Performs a search with the specified SearchOptions on the scope of the table object. The search results are a collection of range objects. [Api set: WordApi 1.3]
///
/// Required. The search text.
/// Optional. Options for the search.
///
}
Table.prototype.select = function(selectionMode) {
///
/// Selects the table, or the position at the start or end of the table, and navigates the Word UI to it. [Api set: WordApi 1.3]
///
/// Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
///
}
Table.prototype.setCellPadding = function(cellPaddingLocation, cellPadding) {
///
/// Sets cell padding in points. [Api set: WordApi 1.3]
///
/// Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
/// Required. The cell padding.
///
}
Table.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
Table.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return Table;
})(OfficeExtension.ClientObject);
Word.Table = Table;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var TableBorder = (function(_super) {
__extends(TableBorder, _super);
function TableBorder() {
/// Specifies the border style. [Api set: WordApi 1.3]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets or sets the table border color. [Api set: WordApi 1.3]
/// Gets or sets the type of the table border. [Api set: WordApi 1.3]
/// Gets or sets the width, in points, of the table border. Not applicable to table border types that have fixed widths. [Api set: WordApi 1.3]
}
TableBorder.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
TableBorder.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Word.Interfaces.TableBorderUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing TableBorder object, with properties that have already been loaded and synced.
///
}
TableBorder.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
TableBorder.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return TableBorder;
})(OfficeExtension.ClientObject);
Word.TableBorder = TableBorder;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var TableCell = (function(_super) {
__extends(TableCell, _super);
function TableCell() {
/// Represents a table cell in a Word document. [Api set: WordApi 1.3]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the body object of the cell. Read-only. [Api set: WordApi 1.3]
/// Gets the index of the cell in its row. Read-only. [Api set: WordApi 1.3]
/// Gets and sets the width of the cell's column in points. This is applicable to uniform tables. [Api set: WordApi 1.3]
/// Gets and sets the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. [Api set: WordApi 1.3]
/// Gets the parent row of the cell. Read-only. [Api set: WordApi 1.3]
/// Gets the parent table of the cell. Read-only. [Api set: WordApi 1.3]
/// Gets the index of the cell's row in the table. Read-only. [Api set: WordApi 1.3]
/// Gets or sets the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. [Api set: WordApi 1.3]
/// Gets and sets the text of the cell. [Api set: WordApi 1.3]
/// Gets and sets the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. [Api set: WordApi 1.3]
/// Gets the width of the cell in points. Read-only. [Api set: WordApi 1.3]
}
TableCell.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
TableCell.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Word.Interfaces.TableCellUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing TableCell object, with properties that have already been loaded and synced.
///
}
TableCell.prototype.deleteColumn = function() {
///
/// Deletes the column containing this cell. This is applicable to uniform tables. [Api set: WordApi 1.3]
///
///
}
TableCell.prototype.deleteRow = function() {
///
/// Deletes the row containing this cell. [Api set: WordApi 1.3]
///
///
}
TableCell.prototype.getBorder = function(borderLocation) {
///
/// Gets the border style for the specified border. [Api set: WordApi 1.3]
///
/// Required. The border location.
///
}
TableCell.prototype.getCellPadding = function(cellPaddingLocation) {
///
/// Gets cell padding in points. [Api set: WordApi 1.3]
///
/// Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
TableCell.prototype.getNext = function() {
///
/// Gets the next cell. Throws an error if this cell is the last one. [Api set: WordApi 1.3]
///
///
}
TableCell.prototype.getNextOrNullObject = function() {
///
/// Gets the next cell. Returns a null object if this cell is the last one. [Api set: WordApi 1.3]
///
///
}
TableCell.prototype.insertColumns = function(insertLocation, columnCount, values) {
///
/// Adds columns to the left or right of the cell, using the cell's column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows. [Api set: WordApi 1.3]
///
/// Required. It can be 'Before' or 'After'.
/// Required. Number of columns to add.
/// Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
///
}
TableCell.prototype.insertRows = function(insertLocation, rowCount, values) {
///
/// Inserts rows above or below the cell, using the cell's row as a template. The string values, if specified, are set in the newly inserted rows. [Api set: WordApi 1.3]
///
/// Required. It can be 'Before' or 'After'.
/// Required. Number of rows to add.
/// Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
///
}
TableCell.prototype.setCellPadding = function(cellPaddingLocation, cellPadding) {
///
/// Sets cell padding in points. [Api set: WordApi 1.3]
///
/// Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
/// Required. The cell padding.
///
}
TableCell.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
TableCell.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return TableCell;
})(OfficeExtension.ClientObject);
Word.TableCell = TableCell;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var TableCellCollection = (function(_super) {
__extends(TableCellCollection, _super);
function TableCellCollection() {
/// Contains the collection of the document's TableCell objects. [Api set: WordApi 1.3]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
TableCellCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
TableCellCollection.prototype.getFirst = function() {
///
/// Gets the first table cell in this collection. Throws an error if this collection is empty. [Api set: WordApi 1.3]
///
///
}
TableCellCollection.prototype.getFirstOrNullObject = function() {
///
/// Gets the first table cell in this collection. Returns a null object if this collection is empty. [Api set: WordApi 1.3]
///
///
}
TableCellCollection.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
TableCellCollection.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return TableCellCollection;
})(OfficeExtension.ClientObject);
Word.TableCellCollection = TableCellCollection;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var TableCollection = (function(_super) {
__extends(TableCollection, _super);
function TableCollection() {
/// Contains the collection of the document's Table objects. [Api set: WordApi 1.3]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
TableCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
TableCollection.prototype.getFirst = function() {
///
/// Gets the first table in this collection. Throws an error if this collection is empty. [Api set: WordApi 1.3]
///
///
}
TableCollection.prototype.getFirstOrNullObject = function() {
///
/// Gets the first table in this collection. Returns a null object if this collection is empty. [Api set: WordApi 1.3]
///
///
}
TableCollection.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
TableCollection.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return TableCollection;
})(OfficeExtension.ClientObject);
Word.TableCollection = TableCollection;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var TableRow = (function(_super) {
__extends(TableRow, _super);
function TableRow() {
/// Represents a row in a Word document. [Api set: WordApi 1.3]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the number of cells in the row. Read-only. [Api set: WordApi 1.3]
/// Gets cells. Read-only. [Api set: WordApi 1.3]
/// Gets the font. Use this to get and set font name, size, color, and other properties. Read-only. [Api set: WordApi 1.3]
/// Gets and sets the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. [Api set: WordApi 1.3]
/// Checks whether the row is a header row. Read-only. To set the number of header rows, use HeaderRowCount on the Table object. [Api set: WordApi 1.3]
/// Gets parent table. Read-only. [Api set: WordApi 1.3]
/// Gets and sets the preferred height of the row in points. [Api set: WordApi 1.3]
/// Gets the index of the row in its parent table. Read-only. [Api set: WordApi 1.3]
/// Gets and sets the shading color. Color is specified in "#RRGGBB" format or by using the color name. [Api set: WordApi 1.3]
/// Gets and sets the text values in the row, as a 2D Javascript array. [Api set: WordApi 1.3]
/// Gets and sets the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. [Api set: WordApi 1.3]
}
TableRow.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
TableRow.prototype.set = function() {
///
/// Sets multiple properties on the object at the same time, based on JSON input.
/// Properties described by the Word.Interfaces.TableRowUpdateData interface.
/// Options of the form { throwOnReadOnly?: boolean }
///
/// * throwOnReadOnly: Throw an error if the passed-in property list includes read-only properties (default = true).
///
///
///
/// Sets multiple properties on the object at the same time, based on an existing loaded object.
/// An existing TableRow object, with properties that have already been loaded and synced.
///
}
TableRow.prototype.clear = function() {
///
/// Clears the contents of the row. [Api set: WordApi 1.3]
///
///
}
TableRow.prototype.delete = function() {
///
/// Deletes the entire row. [Api set: WordApi 1.3]
///
///
}
TableRow.prototype.getBorder = function(borderLocation) {
///
/// Gets the border style of the cells in the row. [Api set: WordApi 1.3]
///
/// Required. The border location.
///
}
TableRow.prototype.getCellPadding = function(cellPaddingLocation) {
///
/// Gets cell padding in points. [Api set: WordApi 1.3]
///
/// Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
///
var result = new OfficeExtension.ClientResult();
result.__proto__ = null;
result.value = 0;
return result;
}
TableRow.prototype.getNext = function() {
///
/// Gets the next row. Throws an error if this row is the last one. [Api set: WordApi 1.3]
///
///
}
TableRow.prototype.getNextOrNullObject = function() {
///
/// Gets the next row. Returns a null object if this row is the last one. [Api set: WordApi 1.3]
///
///
}
TableRow.prototype.insertRows = function(insertLocation, rowCount, values) {
///
/// Inserts rows using this row as a template. If values are specified, inserts the values into the new rows. [Api set: WordApi 1.3]
///
/// Required. Where the new rows should be inserted, relative to the current row. It can be 'Before' or 'After'.
/// Required. Number of rows to add
/// Optional. Strings to insert in the new rows, specified as a 2D array. The number of cells in each row must not exceed the number of cells in the existing row.
///
}
TableRow.prototype.search = function(searchText, searchOptions) {
///
/// Performs a search with the specified SearchOptions on the scope of the row. The search results are a collection of range objects. [Api set: WordApi 1.3]
///
/// Required. The search text.
/// Optional. Options for the search.
///
}
TableRow.prototype.select = function(selectionMode) {
///
/// Selects the row and navigates the Word UI to it. [Api set: WordApi 1.3]
///
/// Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
///
}
TableRow.prototype.setCellPadding = function(cellPaddingLocation, cellPadding) {
///
/// Sets cell padding in points. [Api set: WordApi 1.3]
///
/// Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
/// Required. The cell padding.
///
}
TableRow.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
TableRow.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return TableRow;
})(OfficeExtension.ClientObject);
Word.TableRow = TableRow;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var TableRowCollection = (function(_super) {
__extends(TableRowCollection, _super);
function TableRowCollection() {
/// Contains the collection of the document's TableRow objects. [Api set: WordApi 1.3]
/// The request context associated with this object.
/// Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.
/// Gets the loaded child items in this collection.
}
TableRowCollection.prototype.load = function(option) {
///
/// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
///
///
///
}
TableRowCollection.prototype.getFirst = function() {
///
/// Gets the first row in this collection. Throws an error if this collection is empty. [Api set: WordApi 1.3]
///
///
}
TableRowCollection.prototype.getFirstOrNullObject = function() {
///
/// Gets the first row in this collection. Returns a null object if this collection is empty. [Api set: WordApi 1.3]
///
///
}
TableRowCollection.prototype.track = function() {
///
/// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
///
///
}
TableRowCollection.prototype.untrack = function() {
///
/// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
///
///
}
return TableRowCollection;
})(OfficeExtension.ClientObject);
Word.TableRowCollection = TableRowCollection;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// [Api set: WordApi]
var TapObjectType = {
__proto__: null,
"chart": "chart",
"smartArt": "smartArt",
"table": "table",
"image": "image",
"slide": "slide",
"ole": "ole",
"text": "text",
}
Word.TapObjectType = TapObjectType;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// Underline types [Api set: WordApi]
var UnderlineType = {
__proto__: null,
"mixed": "mixed",
"none": "none",
"single": "single",
"word": "word",
"double": "double",
"thick": "thick",
"dotted": "dotted",
"dottedHeavy": "dottedHeavy",
"dashLine": "dashLine",
"dashLineHeavy": "dashLineHeavy",
"dashLineLong": "dashLineLong",
"dashLineLongHeavy": "dashLineLongHeavy",
"dotDashLine": "dotDashLine",
"dotDashLineHeavy": "dotDashLineHeavy",
"twoDotDashLine": "twoDotDashLine",
"twoDotDashLineHeavy": "twoDotDashLineHeavy",
"wave": "wave",
"waveHeavy": "waveHeavy",
"waveDouble": "waveDouble",
}
Word.UnderlineType = UnderlineType;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
/// [Api set: WordApi]
var VerticalAlignment = {
__proto__: null,
"mixed": "mixed",
"top": "top",
"center": "center",
"bottom": "bottom",
}
Word.VerticalAlignment = VerticalAlignment;
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Interfaces;
(function (Interfaces) {
var AnnotationUpdateData = (function() {
function AnnotationUpdateData() {
/// An interface for updating data on the Annotation object, for use in "annotation.set({ ... })".
/// State of the annotation. [Api set: WordApi];
}
return AnnotationUpdateData;
})();
Interfaces.AnnotationUpdateData.__proto__ = null;
Interfaces.AnnotationUpdateData = AnnotationUpdateData;
})(Interfaces = Word.Interfaces || (Word.Interfaces = { __proto__: null}));
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Interfaces;
(function (Interfaces) {
var BodyUpdateData = (function() {
function BodyUpdateData() {
/// An interface for updating data on the Body object, for use in "body.set({ ... })".
/// Gets the text format of the body. Use this to get and set font name, size, color and other properties. [Api set: WordApi 1.1]
/// Gets or sets the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. [Api set: WordApi 1.1];
/// Gets or sets the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. [Api set: WordApi 1.3];
}
return BodyUpdateData;
})();
Interfaces.BodyUpdateData.__proto__ = null;
Interfaces.BodyUpdateData = BodyUpdateData;
})(Interfaces = Word.Interfaces || (Word.Interfaces = { __proto__: null}));
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Interfaces;
(function (Interfaces) {
var ContentControlUpdateData = (function() {
function ContentControlUpdateData() {
/// An interface for updating data on the ContentControl object, for use in "contentControl.set({ ... })".
/// Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. [Api set: WordApi 1.1]
/// Gets or sets the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. [Api set: WordApi 1.1];
/// Gets or sets a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. [Api set: WordApi 1.1];
/// Gets or sets a value that indicates whether the user can edit the contents of the content control. [Api set: WordApi 1.1];
/// Gets or sets the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. [Api set: WordApi 1.1];
/// Gets or sets the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. **Note**: The set operation for this property is not supported in Word on the web. [Api set: WordApi 1.1];
/// Gets or sets a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. [Api set: WordApi 1.1];
/// Gets or sets the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. [Api set: WordApi 1.1];
/// Gets or sets the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. [Api set: WordApi 1.3];
/// Gets or sets a tag to identify a content control. [Api set: WordApi 1.1];
/// Gets or sets the title for a content control. [Api set: WordApi 1.1];
}
return ContentControlUpdateData;
})();
Interfaces.ContentControlUpdateData.__proto__ = null;
Interfaces.ContentControlUpdateData = ContentControlUpdateData;
})(Interfaces = Word.Interfaces || (Word.Interfaces = { __proto__: null}));
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Interfaces;
(function (Interfaces) {
var CustomPropertyUpdateData = (function() {
function CustomPropertyUpdateData() {
/// An interface for updating data on the CustomProperty object, for use in "customProperty.set({ ... })".
/// Gets or sets the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). [Api set: WordApi 1.3];
}
return CustomPropertyUpdateData;
})();
Interfaces.CustomPropertyUpdateData.__proto__ = null;
Interfaces.CustomPropertyUpdateData = CustomPropertyUpdateData;
})(Interfaces = Word.Interfaces || (Word.Interfaces = { __proto__: null}));
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Interfaces;
(function (Interfaces) {
var DocumentUpdateData = (function() {
function DocumentUpdateData() {
/// An interface for updating data on the Document object, for use in "document.set({ ... })".
/// Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. [Api set: WordApi 1.1]
/// Gets the properties of the document. [Api set: WordApi 1.3]
/// Gets or sets a value that indicates that, when opening a new document, whether it is allowed to close this document even if this document is untitled. True to close, false otherwise. [Api set: WordApi];
}
return DocumentUpdateData;
})();
Interfaces.DocumentUpdateData.__proto__ = null;
Interfaces.DocumentUpdateData = DocumentUpdateData;
})(Interfaces = Word.Interfaces || (Word.Interfaces = { __proto__: null}));
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Interfaces;
(function (Interfaces) {
var DocumentCreatedUpdateData = (function() {
function DocumentCreatedUpdateData() {
/// An interface for updating data on the DocumentCreated object, for use in "documentCreated.set({ ... })".
/// Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.. [Api set: WordApiHiddenDocument 1.3]
/// Gets the properties of the document. [Api set: WordApiHiddenDocument 1.3]
}
return DocumentCreatedUpdateData;
})();
Interfaces.DocumentCreatedUpdateData.__proto__ = null;
Interfaces.DocumentCreatedUpdateData = DocumentCreatedUpdateData;
})(Interfaces = Word.Interfaces || (Word.Interfaces = { __proto__: null}));
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Interfaces;
(function (Interfaces) {
var DocumentPropertiesUpdateData = (function() {
function DocumentPropertiesUpdateData() {
/// An interface for updating data on the DocumentProperties object, for use in "documentProperties.set({ ... })".
/// Gets or sets the author of the document. [Api set: WordApi 1.3];
/// Gets or sets the category of the document. [Api set: WordApi 1.3];
/// Gets or sets the comments of the document. [Api set: WordApi 1.3];
/// Gets or sets the company of the document. [Api set: WordApi 1.3];
/// Gets or sets the format of the document. [Api set: WordApi 1.3];
/// Gets or sets the keywords of the document. [Api set: WordApi 1.3];
/// Gets or sets the manager of the document. [Api set: WordApi 1.3];
/// Gets or sets the subject of the document. [Api set: WordApi 1.3];
/// Gets or sets the title of the document. [Api set: WordApi 1.3];
}
return DocumentPropertiesUpdateData;
})();
Interfaces.DocumentPropertiesUpdateData.__proto__ = null;
Interfaces.DocumentPropertiesUpdateData = DocumentPropertiesUpdateData;
})(Interfaces = Word.Interfaces || (Word.Interfaces = { __proto__: null}));
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Interfaces;
(function (Interfaces) {
var FontUpdateData = (function() {
function FontUpdateData() {
/// An interface for updating data on the Font object, for use in "font.set({ ... })".
/// Gets or sets a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. [Api set: WordApi 1.1];
/// Gets or sets the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. [Api set: WordApi 1.1];
/// Gets or sets a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. [Api set: WordApi 1.1];
/// Gets or sets the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or null for no highlight color. **Note**: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. [Api set: WordApi 1.1];
/// Gets or sets a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. [Api set: WordApi 1.1];
/// Gets or sets a value that represents the name of the font. [Api set: WordApi 1.1];
/// Gets or sets a value that represents the font size in points. [Api set: WordApi 1.1];
/// Gets or sets a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. [Api set: WordApi 1.1];
/// Gets or sets a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. [Api set: WordApi 1.1];
/// Gets or sets a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. [Api set: WordApi 1.1];
/// Gets or sets a value that indicates the font's underline type. 'None' if the font is not underlined. [Api set: WordApi 1.1];
}
return FontUpdateData;
})();
Interfaces.FontUpdateData.__proto__ = null;
Interfaces.FontUpdateData = FontUpdateData;
})(Interfaces = Word.Interfaces || (Word.Interfaces = { __proto__: null}));
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Interfaces;
(function (Interfaces) {
var InlinePictureUpdateData = (function() {
function InlinePictureUpdateData() {
/// An interface for updating data on the InlinePicture object, for use in "inlinePicture.set({ ... })".
/// Gets or sets a string that represents the alternative text associated with the inline image. [Api set: WordApi 1.1];
/// Gets or sets a string that contains the title for the inline image. [Api set: WordApi 1.1];
/// Gets or sets a number that describes the height of the inline image. [Api set: WordApi 1.1];
/// Gets or sets a hyperlink on the image. Use a '#' to separate the address part from the optional location part. [Api set: WordApi 1.1];
/// Gets or sets a value that indicates whether the inline image retains its original proportions when you resize it. [Api set: WordApi 1.1];
/// Gets or sets a number that describes the width of the inline image. [Api set: WordApi 1.1];
}
return InlinePictureUpdateData;
})();
Interfaces.InlinePictureUpdateData.__proto__ = null;
Interfaces.InlinePictureUpdateData = InlinePictureUpdateData;
})(Interfaces = Word.Interfaces || (Word.Interfaces = { __proto__: null}));
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Interfaces;
(function (Interfaces) {
var ListItemUpdateData = (function() {
function ListItemUpdateData() {
/// An interface for updating data on the ListItem object, for use in "listItem.set({ ... })".
/// Gets or sets the level of the item in the list. [Api set: WordApi 1.3];
}
return ListItemUpdateData;
})();
Interfaces.ListItemUpdateData.__proto__ = null;
Interfaces.ListItemUpdateData = ListItemUpdateData;
})(Interfaces = Word.Interfaces || (Word.Interfaces = { __proto__: null}));
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Interfaces;
(function (Interfaces) {
var ParagraphUpdateData = (function() {
function ParagraphUpdateData() {
/// An interface for updating data on the Paragraph object, for use in "paragraph.set({ ... })".
/// Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. [Api set: WordApi 1.1]
/// Gets the ListItem for the paragraph. Throws an error if the paragraph is not part of a list. [Api set: WordApi 1.3]
/// Gets the ListItem for the paragraph. Returns a null object if the paragraph is not part of a list. [Api set: WordApi 1.3]
/// Gets or sets the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. [Api set: WordApi 1.1];
/// Gets or sets the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. [Api set: WordApi 1.1];
/// Gets or sets the left indent value, in points, for the paragraph. [Api set: WordApi 1.1];
/// Gets or sets the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. [Api set: WordApi 1.1];
/// Gets or sets the amount of spacing, in grid lines, after the paragraph. [Api set: WordApi 1.1];
/// Gets or sets the amount of spacing, in grid lines, before the paragraph. [Api set: WordApi 1.1];
/// Gets or sets the outline level for the paragraph. [Api set: WordApi 1.1];
/// Gets or sets the right indent value, in points, for the paragraph. [Api set: WordApi 1.1];
/// Gets or sets the spacing, in points, after the paragraph. [Api set: WordApi 1.1];
/// Gets or sets the spacing, in points, before the paragraph. [Api set: WordApi 1.1];
/// Gets or sets the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. [Api set: WordApi 1.1];
/// Gets or sets the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. [Api set: WordApi 1.3];
}
return ParagraphUpdateData;
})();
Interfaces.ParagraphUpdateData.__proto__ = null;
Interfaces.ParagraphUpdateData = ParagraphUpdateData;
})(Interfaces = Word.Interfaces || (Word.Interfaces = { __proto__: null}));
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Interfaces;
(function (Interfaces) {
var RangeUpdateData = (function() {
function RangeUpdateData() {
/// An interface for updating data on the Range object, for use in "range.set({ ... })".
/// Gets the text format of the range. Use this to get and set font name, size, color, and other properties. [Api set: WordApi 1.1]
/// Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. [Api set: WordApi 1.3];
/// Gets or sets the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. [Api set: WordApi 1.1];
/// Gets or sets the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. [Api set: WordApi 1.3];
}
return RangeUpdateData;
})();
Interfaces.RangeUpdateData.__proto__ = null;
Interfaces.RangeUpdateData = RangeUpdateData;
})(Interfaces = Word.Interfaces || (Word.Interfaces = { __proto__: null}));
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Interfaces;
(function (Interfaces) {
var SearchOptionsUpdateData = (function() {
function SearchOptionsUpdateData() {
/// An interface for updating data on the SearchOptions object, for use in "searchOptions.set({ ... })".
/// Gets or sets a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. [Api set: WordApi 1.1];
/// Gets or sets a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. [Api set: WordApi 1.1];
/// Gets or sets a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. [Api set: WordApi 1.1];
/// Gets or sets a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. [Api set: WordApi 1.1];
/// Gets or sets a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. [Api set: WordApi 1.1];
/// Gets or sets a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. [Api set: WordApi 1.1];
/// Gets or sets a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. [Api set: WordApi 1.1];
}
return SearchOptionsUpdateData;
})();
Interfaces.SearchOptionsUpdateData.__proto__ = null;
Interfaces.SearchOptionsUpdateData = SearchOptionsUpdateData;
})(Interfaces = Word.Interfaces || (Word.Interfaces = { __proto__: null}));
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Interfaces;
(function (Interfaces) {
var SectionUpdateData = (function() {
function SectionUpdateData() {
/// An interface for updating data on the Section object, for use in "section.set({ ... })".
/// Gets the body object of the section. This does not include the header/footer and other section metadata. [Api set: WordApi 1.1]
}
return SectionUpdateData;
})();
Interfaces.SectionUpdateData.__proto__ = null;
Interfaces.SectionUpdateData = SectionUpdateData;
})(Interfaces = Word.Interfaces || (Word.Interfaces = { __proto__: null}));
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Interfaces;
(function (Interfaces) {
var TableUpdateData = (function() {
function TableUpdateData() {
/// An interface for updating data on the Table object, for use in "table.set({ ... })".
/// Gets the font. Use this to get and set font name, size, color, and other properties. [Api set: WordApi 1.3]
/// Gets or sets the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. [Api set: WordApi 1.3];
/// Gets and sets the number of header rows. [Api set: WordApi 1.3];
/// Gets and sets the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. [Api set: WordApi 1.3];
/// Gets and sets the shading color. Color is specified in "#RRGGBB" format or by using the color name. [Api set: WordApi 1.3];
/// Gets or sets the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. [Api set: WordApi 1.3];
/// Gets and sets whether the table has banded columns. [Api set: WordApi 1.3];
/// Gets and sets whether the table has banded rows. [Api set: WordApi 1.3];
/// Gets or sets the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. [Api set: WordApi 1.3];
/// Gets and sets whether the table has a first column with a special style. [Api set: WordApi 1.3];
/// Gets and sets whether the table has a last column with a special style. [Api set: WordApi 1.3];
/// Gets and sets whether the table has a total (last) row with a special style. [Api set: WordApi 1.3];
/// Gets and sets the text values in the table, as a 2D Javascript array. [Api set: WordApi 1.3];
/// Gets and sets the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. [Api set: WordApi 1.3];
/// Gets and sets the width of the table in points. [Api set: WordApi 1.3];
}
return TableUpdateData;
})();
Interfaces.TableUpdateData.__proto__ = null;
Interfaces.TableUpdateData = TableUpdateData;
})(Interfaces = Word.Interfaces || (Word.Interfaces = { __proto__: null}));
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Interfaces;
(function (Interfaces) {
var TableRowUpdateData = (function() {
function TableRowUpdateData() {
/// An interface for updating data on the TableRow object, for use in "tableRow.set({ ... })".
/// Gets the font. Use this to get and set font name, size, color, and other properties. [Api set: WordApi 1.3]
/// Gets and sets the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. [Api set: WordApi 1.3];
/// Gets and sets the preferred height of the row in points. [Api set: WordApi 1.3];
/// Gets and sets the shading color. Color is specified in "#RRGGBB" format or by using the color name. [Api set: WordApi 1.3];
/// Gets and sets the text values in the row, as a 2D Javascript array. [Api set: WordApi 1.3];
/// Gets and sets the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. [Api set: WordApi 1.3];
}
return TableRowUpdateData;
})();
Interfaces.TableRowUpdateData.__proto__ = null;
Interfaces.TableRowUpdateData = TableRowUpdateData;
})(Interfaces = Word.Interfaces || (Word.Interfaces = { __proto__: null}));
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Interfaces;
(function (Interfaces) {
var TableCellUpdateData = (function() {
function TableCellUpdateData() {
/// An interface for updating data on the TableCell object, for use in "tableCell.set({ ... })".
/// Gets the body object of the cell. [Api set: WordApi 1.3]
/// Gets and sets the width of the cell's column in points. This is applicable to uniform tables. [Api set: WordApi 1.3];
/// Gets and sets the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. [Api set: WordApi 1.3];
/// Gets or sets the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. [Api set: WordApi 1.3];
/// Gets and sets the text of the cell. [Api set: WordApi 1.3];
/// Gets and sets the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. [Api set: WordApi 1.3];
}
return TableCellUpdateData;
})();
Interfaces.TableCellUpdateData.__proto__ = null;
Interfaces.TableCellUpdateData = TableCellUpdateData;
})(Interfaces = Word.Interfaces || (Word.Interfaces = { __proto__: null}));
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var Interfaces;
(function (Interfaces) {
var TableBorderUpdateData = (function() {
function TableBorderUpdateData() {
/// An interface for updating data on the TableBorder object, for use in "tableBorder.set({ ... })".
/// Gets or sets the table border color. [Api set: WordApi 1.3];
/// Gets or sets the type of the table border. [Api set: WordApi 1.3];
/// Gets or sets the width, in points, of the table border. Not applicable to table border types that have fixed widths. [Api set: WordApi 1.3];
}
return TableBorderUpdateData;
})();
Interfaces.TableBorderUpdateData.__proto__ = null;
Interfaces.TableBorderUpdateData = TableBorderUpdateData;
})(Interfaces = Word.Interfaces || (Word.Interfaces = { __proto__: null}));
})(Word || (Word = {__proto__: null}));
var Word;
(function (Word) {
var RequestContext = (function (_super) {
__extends(RequestContext, _super);
function RequestContext() {
///
/// The RequestContext object facilitates requests to the Word application. Since the Office add-in and the Word application run in two different processes, the request context is required to get access to the Word object model from the add-in.
///
/// Root object for interacting with the document
_super.call(this, null);
}
return RequestContext;
})(OfficeExtension.ClientRequestContext);
Word.RequestContext = RequestContext;
Word.run = function (batch) {
///
///
/// Executes a batch script that performs actions on the Word object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
///
///
/// A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()").
///
/// The context parameter facilitates requests to the Word application. Since the Office add-in and the Word application run in two different processes, the RequestContext is required to get access to the Word object model from the add-in.
///
///
///
///
/// Executes a batch script that performs actions on the Word object model, using the RequestContext of a previously-created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
///
///
/// A previously-created API object. The batch will use the same RequestContext as the passed-in object, which means that any changes applied to the object will be picked up by "context.sync()".
///
///
/// A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()").
///
/// The context parameter facilitates requests to the Word application. Since the Office add-in and the Word application run in two different processes, the RequestContext is required to get access to the Word object model from the add-in.
///
///
///
///
/// Executes a batch script that performs actions on the Word object model, using the RequestContext of a previously-created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
///
///
/// An array of previously-created API objects. The array will be validated to make sure that all of the objects share the same context. The batch will use this shared RequestContext, which means that any changes applied to these objects will be picked up by "context.sync()".
///
///
/// A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()").
///
/// The context parameter facilitates requests to the Word application. Since the Office add-in and the Word application run in two different processes, the RequestContext is required to get access to the Word object model from the add-in.
///
///
arguments[arguments.length - 1](new Word.RequestContext());
return new OfficeExtension.Promise();
}
})(Word || (Word = {__proto__: null}));
Word.__proto__ = null;