diff --git a/data/ExcelApi_1.7_build.cs b/data/ExcelApi_1.7_build.cs new file mode 100644 index 0000000..36fee7a --- /dev/null +++ b/data/ExcelApi_1.7_build.cs @@ -0,0 +1,6130 @@ +// -------------------------------------------------------------------------------------------------- +// +// +// Copyright (c) Microsoft Corporation. All rights reserved. +// +// +// Contains the metadata of Excel API that is currently implemented. +// The following is the workflow to add a new API +// 1) DEV add the API to xlshared\src\api\metadata\current\ExcelApi.cs +// 2) DEV runs xlshared\util\XlsApiGen.bat to re-generate the following files +// xlshared\src\api\Xlapi.h COM CoClass header file +// xlshared\src\api\Xlapi_i.h COM interface header file +// xlshared\src\api\Xlapi_i.cpp COM GUIDs +// xlshared\src\api\TypeRegistration.cpp Type registration file +// xlshared\src\api\*.disp.cpp COM IDispatch interface related implementation +// xlshared\src\api\script\Xlapi.ts TypeScript file +// 3) DEV implement the new API, update xlshared\src\api\sources.inc if necessary. +// +// -------------------------------------------------------------------------------------------------- + +using System; +using System.Collections.Generic; +using Microsoft.OfficeExtension.CodeGen; + +[assembly: ClientCallableNamespaceMap("Microsoft.ExcelServices", ComCoClassNamespaceName = "ExcelApiImpl", ComInterfaceNamespaceName = "ExcelApi", TypeScriptNamespaceName = "Excel")] + +// Default error (fallback if not uniquely mapped below) +[assembly: HResultDefaultError(HttpStatusCode.InternalServerError, Microsoft.ExcelServices.ErrorCodes.GeneralException, "stridsApiGeneralException")] + +// Errors we specifically want to hide into general exception (500) +[assembly: HResultError("hrFail", HttpStatusCode.InternalServerError, Microsoft.ExcelServices.ErrorCodes.GeneralException, "stridsApiGeneralException")] +[assembly: HResultError("hrUnexpected", HttpStatusCode.InternalServerError, Microsoft.ExcelServices.ErrorCodes.GeneralException, "stridsApiGeneralException")] +[assembly: HResultError("hrOutOfMemory", HttpStatusCode.InternalServerError, Microsoft.ExcelServices.ErrorCodes.GeneralException, "stridsApiGeneralException")] +[assembly: HResultError("SharedInterimIfs::hrFormulaParseError", HttpStatusCode.BadRequest, Microsoft.ExcelServices.ErrorCodes.InvalidArgument, "stridsApiInvalidArgument")] + +// Errors 400s +[assembly: HResultError("E_POINTER", HttpStatusCode.NotFound, Microsoft.ExcelServices.ErrorCodes.ItemNotFound, "stridsApiItemNotFound")] +[assembly: HResultError("hrBadIndex", HttpStatusCode.BadRequest, Microsoft.ExcelServices.ErrorCodes.InvalidArgument, "stridsWCOUTOFBOUNDS")] +[assembly: HResultError("hrInvalidArg", HttpStatusCode.BadRequest, Microsoft.ExcelServices.ErrorCodes.InvalidArgument, "stridsApiInvalidArgument")] +[assembly: HResultError("hrInvalidAPIOperation", HttpStatusCode.BadRequest, Microsoft.ExcelServices.ErrorCodes.InvalidOperation, "stridsApiInvalidAPIOperation")] +[assembly: HResultError("hrInvalidBinding", HttpStatusCode.BadRequest, Microsoft.ExcelServices.ErrorCodes.InvalidBinding, "stridsApiInvalidBinding")] +[assembly: HResultError("hrInvalidAPISelection", HttpStatusCode.BadRequest, Microsoft.ExcelServices.ErrorCodes.InvalidSelection, "stridsApiInvalidSelection")] +[assembly: HResultError("hrInvalidAPIReference", HttpStatusCode.BadRequest, Microsoft.ExcelServices.ErrorCodes.InvalidReference, "stridsApiInvalidReference")] +[assembly: HResultError("hrNotFound", HttpStatusCode.NotFound, Microsoft.ExcelServices.ErrorCodes.ItemNotFound, "stridsApiItemNotFound")] +[assembly: HResultError("SharedInterimIfs::hrInsDelDisallowedByFeature", HttpStatusCode.Conflict, Microsoft.ExcelServices.ErrorCodes.InsertDeleteConflict, "stridsBadListInsDel")] +[assembly: HResultError("hrListCannotGrow", HttpStatusCode.Conflict, Microsoft.ExcelServices.ErrorCodes.InsertDeleteConflict, "stridsBadListInsDel")] +[assembly: HResultError("hrNotYetSupportedApiOperation", HttpStatusCode.BadRequest, Microsoft.ExcelServices.ErrorCodes.UnsupportedOperation, "stridsApiNotImplemented")] +[assembly: HResultError("SharedInterimIfs::hrRangeSheetsMismatch", HttpStatusCode.BadRequest, Microsoft.ExcelServices.ErrorCodes.InvalidArgument, "stridsApiInvalidArgument")] +[assembly: HResultError("SharedInterimIfs::hrRangeParseError", HttpStatusCode.BadRequest, Microsoft.ExcelServices.ErrorCodes.InvalidArgument, "stridsApiInvalidArgument")] +[assembly: HResultError("SharedInterimIfs::hrRangeWrong", HttpStatusCode.BadRequest, Microsoft.ExcelServices.ErrorCodes.InvalidArgument, "stridsApiInvalidArgument")] +[assembly: HResultError("hrNoPermission", HttpStatusCode.Forbidden, Microsoft.ExcelServices.ErrorCodes.AccessDenied, "stridsApiAccessDenied")] +[assembly: HResultError("E_ACCESSDENIED", HttpStatusCode.Forbidden, Microsoft.ExcelServices.ErrorCodes.AccessDenied, "stridsApiAccessDenied")] +[assembly: HResultError("SharedInterimIfs::hrCreateTableBadListSrcRange", HttpStatusCode.BadRequest, Microsoft.ExcelServices.ErrorCodes.InvalidArgument, "stridsBadListPasteSrcRange")] +[assembly: HResultError("SharedInterimIfs::hrGetTableBadListSrcRange", HttpStatusCode.BadRequest, Microsoft.ExcelServices.ErrorCodes.InvalidArgument, "stridsBadListSrcRange")] +[assembly: HResultError("SharedInterimIfs::hrCreateTableFormulaInListHdr", HttpStatusCode.BadRequest, Microsoft.ExcelServices.ErrorCodes.InvalidArgument, "stridsFormulaInListHdr")] +[assembly: HResultError("SharedInterimIfs::hrCreateTableColHdrTruncate", HttpStatusCode.BadRequest, Microsoft.ExcelServices.ErrorCodes.InvalidArgument, "stridsTableColHdrTruncate")] +[assembly: HResultError("SharedInterimIfs::hrGetTableListsOverlap", HttpStatusCode.BadRequest, Microsoft.ExcelServices.ErrorCodes.InvalidArgument, "stridsListsOverlap")] +[assembly: HResultError("hrItemAlreadyExists", HttpStatusCode.BadRequest, Microsoft.ExcelServices.ErrorCodes.ItemAlreadyExists, "stridsApiItemAlreadyExists")] +[assembly: HResultError("hrNoInterface", HttpStatusCode.BadRequest, Microsoft.ExcelServices.ErrorCodes.InvalidArgument, "stridsApiInvalidArgument")] +[assembly: HResultError("DISP_E_UNKNOWNNAME", HttpStatusCode.BadRequest, Microsoft.ExcelServices.ErrorCodes.ApiNotFound, "stridsApiNotFound")] + +// Errors 500s +[assembly: HResultError("hrNotImplemented", HttpStatusCode.NotImplemented, Microsoft.ExcelServices.ErrorCodes.NotImplemented, "stridsApiNotImplemented")] +//[assembly: HResultError("hrAborted", HttpStatusCode.InternalServerError, Microsoft.ExcelServices.ErrorCodes.RequestAborted, "stridsApiAborted")] (hrAborted is not yet implemented) + +namespace Microsoft.ExcelServices +{ + internal static class ApiSet + { + /// + /// 1.2 because for now, RTM (1.1) still uses old 16.00 JS file instead of 16.01. + /// Once redirection is complete, will mark it as 1.1 + /// + internal const double PolyfillableDownTo1_1 = 1.2; + + internal static class InProgressFeatures + { + internal const double SmallApiAdditions = 1.7; + + // Planned simple APIs, slated likely for 1.5, but still need to be implemented. + internal const double GetFirstGetLast = 1.8; + internal const double GetPreviousGetNext = 1.8; + internal const double WorkbookRange = 1.8; + internal const double GetSurroundingRegion = 1.8; + + internal const double ChartingApi = 1.9; + } + } + + internal static class ErrorCodes + { + internal const string GeneralException = "GeneralException"; + internal const string InvalidArgument = "InvalidArgument"; + internal const string InvalidOperation = "InvalidOperation"; + internal const string InvalidSelection = "InvalidSelection"; + internal const string InvalidBinding = "InvalidBinding"; + internal const string InsertDeleteConflict = "InsertDeleteConflict"; + internal const string ItemNotFound = "ItemNotFound"; + internal const string NotImplemented = "NotImplemented"; + internal const string InvalidReference = "InvalidReference"; + internal const string InvalidRequest = "InvalidRequest"; + internal const string ApiNotAvailable = "ApiNotAvailable"; + internal const string Unauthenticated = "Unauthenticated"; + internal const string AccessDenied = "AccessDenied"; + internal const string Conflict = "Conflict"; + internal const string ItemAlreadyExists = "ItemAlreadyExists"; + internal const string ContentLengthRequired = "ContentLengthRequired"; + internal const string ActivityLimitReached = "ActivityLimitReached"; + internal const string RequestAborted = "RequestAborted"; + internal const string ServiceNotAvailable = "ServiceNotAvailable"; + internal const string UnsupportedOperation = "UnsupportedOperation"; + internal const string BadPassword = "BadPassword"; + internal const string ApiNotFound = "ApiNotFound"; + } + + // These need to be defined here since the other file (FunctionsCodeGen.cs) is codegenned + internal static class FunctionResultDispatchIds + { + internal const int FunctionResult_Error = 1; + internal const int FunctionResult_Value = 2; + } + +#region Event Arguments + /// + /// Provides information about the binding that raised the SelectionChanged event. + /// + [ClientCallableType(ExcludedFromRest = true)] + [ApiSet(Version = 1.1, IntroducedInVersion = 1.3)] + public struct BindingSelectionChangedEventArgs + { + /// + /// Gets the Binding object that represents the binding that raised the SelectionChanged event. + /// + [ApiSet(Version = 1.1, IntroducedInVersion = 1.3)] + public Binding Binding { get; set; } + + /// + /// Gets the index of the first row of the selection (zero-based). + /// + [ApiSet(Version = 1.1, IntroducedInVersion = 1.3)] + int StartRow { get; set; } + + /// + /// Gets the index of the first column of the selection (zero-based). + /// + [ApiSet(Version = 1.1, IntroducedInVersion = 1.3)] + int StartColumn { get; set; } + + /// + /// Gets the number of rows selected. + /// + [ApiSet(Version = 1.1, IntroducedInVersion = 1.3)] + int RowCount { get; set; } + + /// + /// Gets the number of columns selected. + /// + [ApiSet(Version = 1.1, IntroducedInVersion = 1.3)] + int ColumnCount { get; set; } + } + + /// + /// Provides information about the binding that raised the DataChanged event. + /// + [ClientCallableType(ExcludedFromRest = true)] + [ApiSet(Version = 1.1, IntroducedInVersion = 1.3)] + public struct BindingDataChangedEventArgs + { + /// + /// Gets the Binding object that represents the binding that raised the DataChanged event. + /// + [ApiSet(Version = 1.1, IntroducedInVersion = 1.3)] + public Binding Binding { get; set; } + } + + /// + /// Provides information about the document that raised the SelectionChanged event. + /// + [ClientCallableType(ExcludedFromRest = true)] + [ApiSet(Version = 1.1, IntroducedInVersion = 1.3)] + public struct SelectionChangedEventArgs + { + /// + /// Gets the workbook object that raised the SelectionChanged event. + /// + [ApiSet(Version = 1.1, IntroducedInVersion = 1.3)] + public Workbook Workbook { get; set; } + } + + /// + /// Provides information about the setting that raised the SettingsChanged event + /// + [ClientCallableType(ExcludedFromRest = true)] + [ApiSet(Version = 1.4)] + public struct SettingsChangedEventArgs + { + /// + /// Gets the Setting object that represents the binding that raised the SettingsChanged event + /// + [ApiSet(Version = 1.4)] + public SettingCollection Settings { get; set; } + } + + #endregion + +#region Application + internal static class ApplicationDispatchIds + { + internal const int Application_CalculationMode = 1; + internal const int Application_Calculate = 2; + internal const int Application_SuspendApiCalculationUntilNextSync = 3; + } + + /// + /// Represents the Excel application that manages the workbook. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IApplication", InterfaceId = "053AAB3F-C5B6-4A91-93A5-A2C4DA223516", CoClassName = "Application")] + public interface Application + { + /// + /// Returns the calculation mode used in the workbook. See Excel.CalculationMode for details. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ApplicationDispatchIds.Application_CalculationMode)] + CalculationMode CalculationMode { get; } + + /// + /// Recalculate all currently opened workbooks in Excel. + /// + /// Specifies the calculation type to use. See Excel.CalculationType for details. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ApplicationDispatchIds.Application_Calculate)] + void Calculate(CalculationType calculationType); + + /// + /// 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. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ApplicationDispatchIds.Application_SuspendApiCalculationUntilNextSync)] + [ClientCallableOperation(RESTfulName = "")] + void SuspendApiCalculationUntilNextSync(); + } +#endregion Application + +#region Workbook + internal static class WorkbookDispatchIds + { + internal const int Workbook_Worksheets = 1; + internal const int Workbook_Names = 2; + internal const int Workbook_Tables = 3; + internal const int Workbook_Application = 4; + internal const int Workbook_SelectedRange = 5; + internal const int Workbook_Bindings = 6; + internal const int Workbook_RemoveReference = 7; + internal const int Workbook_GetObjectByReferenceId = 8; + internal const int Workbook_GetObjectTypeNameByReferenceId = 9; + internal const int Workbook_RemoveAllReferences = 10; + internal const int Workbook_GetReferenceCount = 11; + internal const int Workbook_Functions = 12; + internal const int Workbook_V1Api = 13; + internal const int Workbook_PivotTables = 14; + internal const int Workbook_Settings = 15; + internal const int Workbook_CustomXmlParts = 16; + internal const int Workbook_ActiveWorksheet = 17; + internal const int Workbook_GetWorksheetById = 18; + internal const int Workbook_Range = 19; + internal const int Workbook_Test = 20; + internal const int Workbook_Name = 21; + } + + /// + /// Workbook is the top level object which contains related workbook objects such as worksheets, tables, ranges, etc. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IWorkbook", InterfaceId = "bb02266c-6204-4e0d-baa3-cc1a928f573e", CoClassName = "Workbook", ExtensibleObject = true)] + [ClientCallableServiceRoot] + public interface Workbook + { + + /// + /// Gets the currently selected range from the workbook. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = WorkbookDispatchIds.Workbook_SelectedRange)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "", InvalidateReturnObjectPathAfterRequest = true)] + Range GetSelectedRange(); + + [ClientCallableComMember(DispatchId = WorkbookDispatchIds.Workbook_GetObjectByReferenceId)] + [ClientCallableOperation(OperationType = OperationType.Read)] + object _GetObjectByReferenceId(string bstrReferenceId); + + [ClientCallableComMember(DispatchId = WorkbookDispatchIds.Workbook_GetObjectTypeNameByReferenceId)] + [ClientCallableOperation(OperationType = OperationType.Read)] + string _GetObjectTypeNameByReferenceId(string bstrReferenceId); + + [ClientCallableComMember(DispatchId = WorkbookDispatchIds.Workbook_GetReferenceCount)] + [ClientCallableOperation(OperationType = OperationType.Read)] + int _GetReferenceCount(); + + [ClientCallableComMember(DispatchId = WorkbookDispatchIds.Workbook_RemoveAllReferences)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _RemoveAllReferences(); + + [ClientCallableComMember(DispatchId = WorkbookDispatchIds.Workbook_RemoveReference)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _RemoveReference(string bstrReferenceId); + + /// + /// Represents Excel application instance that contains this workbook. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = WorkbookDispatchIds.Workbook_Application)] + Application Application { get; } + + /// + /// Represents the collection of custom XML parts contained by this workbook. Read-only. + /// + [ApiSet(Version = 1.5)] + [ClientCallableComMember(DispatchId = WorkbookDispatchIds.Workbook_CustomXmlParts)] + CustomXmlPartCollection CustomXmlParts { get; } + + /// + /// Represents Excel application instance that contains this workbook. Read-only. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = WorkbookDispatchIds.Workbook_Functions)] + Functions Functions { get; } + + /// + /// Represents a collection of workbook scoped named items (named ranges and constants). Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = WorkbookDispatchIds.Workbook_Names)] + NamedItemCollection Names { get; } + + /// + /// Represents a collection of worksheets associated with the workbook. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = WorkbookDispatchIds.Workbook_Worksheets)] + WorksheetCollection Worksheets { get; } + + /// + /// Represents a collection of tables associated with the workbook. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = WorkbookDispatchIds.Workbook_Tables)] + TableCollection Tables { get; } + + /// + /// Represents a collection of bindings that are part of the workbook. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = WorkbookDispatchIds.Workbook_Bindings)] + [ClientCallableProperty(ExcludedFromRest = true)] + BindingCollection Bindings { get; } + + + /// + /// Represents a collection of PivotTables associated with the workbook. Read-only. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = WorkbookDispatchIds.Workbook_PivotTables)] + PivotTableCollection PivotTables { get; } + + /// + /// Represents a collection of Settings associated with the workbook. Read-only. + /// + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = WorkbookDispatchIds.Workbook_Settings)] + [ClientCallableProperty(ExcludedFromRest = true)] + SettingCollection Settings { get; } + + /// + /// Occurs when the selection in the document is changed. + /// + [ApiSet(Version = 1.1, IntroducedInVersion = 1.3)] + event EventHandler SelectionChanged; + + /// + /// For internal use only. + /// + [ApiSet(Version = 1.6)] + [ClientCallableProperty(ExcludedFromClientLibrary = true, ExcludedFromRest = true)] + [ClientCallableComMember(DispatchId = WorkbookDispatchIds.Workbook_Test)] + Test Test { get; } + + } + #endregion Workbook + + #region Worksheet + internal static class WorksheetDispatchIds + { + internal const int Worksheet_Range = 1; + internal const int Worksheet_UsedRange = 2; + internal const int Worksheet_Charts = 3; + internal const int Worksheet_Cell = 4; + internal const int Worksheet_Name = 5; + internal const int Worksheet_Delete = 6; + internal const int Worksheet_Id = 7; + internal const int Worksheet_Tables = 8; + internal const int Worksheet_Activate = 9; + internal const int Worksheet_Position = 10; + internal const int Worksheet_OnAccess = 11; + internal const int Worksheet_Visible = 12; + internal const int Worksheet_Protection = 13; + internal const int Worksheet_PivotTables = 14; + internal const int Worksheet_Names = 15; + internal const int Worksheet_UsedRangeOrNullObject = 16; + internal const int Worksheet_RangeByIndexes = 17; + internal const int Worksheet_Previous = 18; + internal const int Worksheet_PreviousOrNullObject = 19; + internal const int Worksheet_Next = 20; + internal const int Worksheet_NextOrNullObject = 21; + internal const int Worksheet_TabColor = 22; + internal const int Worksheet_Calculate = 23; + internal const int Worksheet_Gridlines = 24; + internal const int Worksheet_Headings = 25; + + internal const int WorksheetCollection_Indexer = 1; + internal const int WorksheetCollection_Add = 2; + internal const int WorksheetCollection_ActiveWorksheet = 3; + internal const int WorksheetCollection_GetItemOrNullObject = 4; + internal const int WorksheetCollection_First = 5; + internal const int WorksheetCollection_Last = 6; + internal const int WorksheetCollection_GetCount = 7; + + internal const int WorksheetProtection_OnAccess = 1; + internal const int WorksheetProtection_Protected = 2; + internal const int WorksheetProtection_Options = 3; + internal const int WorksheetProtection_Protect = 4; + internal const int WorksheetProtection_Unprotect = 5; + + internal const int WorksheetProtectionOptions_AllowFormatCells = 1; + internal const int WorksheetProtectionOptions_AllowFormatColumns = 2; + internal const int WorksheetProtectionOptions_AllowFormatRows = 3; + internal const int WorksheetProtectionOptions_AllowInsertColumns = 4; + internal const int WorksheetProtectionOptions_AllowInsertRows = 5; + internal const int WorksheetProtectionOptions_AllowInsertHyperlinks = 6; + internal const int WorksheetProtectionOptions_AllowDeleteColumns = 7; + internal const int WorksheetProtectionOptions_AllowDeleteRows = 8; + internal const int WorksheetProtectionOptions_AllowSort = 9; + internal const int WorksheetProtectionOptions_AllowAutoFilter = 10; + internal const int WorksheetProtectionOptions_AllowPivotTables = 11; + } + + /// + /// An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc. + /// + [ApiSet(Version = 1.1)] + [ClientCallableType(DeleteOperationName = "Delete")] + [ClientCallableComType(Name = "IWorksheet", InterfaceId = "b86e5ae1-476e-4e56-825d-885468e549f3", CoClassName = "Worksheet")] + public interface Worksheet + { + + /// + /// Activate the worksheet in the Excel UI. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.Worksheet_Activate)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "")] + void Activate(); + + /// + /// Calculates all cells on a worksheet. + /// + /// Boolean to mark as dirty. + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.Worksheet_Calculate)] + void Calculate(bool markAllDirty); + + /// + /// Returns collection of charts that are part of the worksheet. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.Worksheet_Charts)] + ChartCollection Charts { get; } + + /// + /// Deletes the worksheet from the workbook. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.Worksheet_Delete)] + void Delete(); + + /// + /// 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's stays within the worksheet grid. + /// + /// The row number of the cell to be retrieved. Zero-indexed. + /// the column number of the cell to be retrieved. Zero-indexed. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.Worksheet_Cell)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "Cell", InvalidateReturnObjectPathAfterRequest = true)] + Range GetCell(int row, int column); + + /// + /// Gets the range object specified by the address or name. + /// + /// The address or the name of the range. If not specified, the entire worksheet range is returned. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.Worksheet_Range)] + [ClientCallableOperation(OperationType = OperationType.Read, InvalidateReturnObjectPathAfterRequest = true)] + Range GetRange([Optional]string address); + + + /// + /// Gets the worksheet that precedes this one. If there are no previous worksheets, this method will throw an error. + /// + /// If true, considers only visible worksheets, skipping over any hidden ones. + [ApiSet(Version = 1.5)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.Worksheet_Previous)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "Previous", InvalidateReturnObjectPathAfterRequest = true)] + Worksheet GetPrevious([Optional]bool visibleOnly); + + /// + /// Gets the worksheet that precedes this one. If there are no previous worksheets, this method will return a null objet. + /// + /// If true, considers only visible worksheets, skipping over any hidden ones. + [ApiSet(Version = 1.5)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.Worksheet_PreviousOrNullObject)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "", InvalidateReturnObjectPathAfterRequest = true)] + Worksheet GetPreviousOrNullObject([Optional]bool visibleOnly); + + /// + /// Gets the worksheet that follows this one. If there are no worksheets following this one, this method will throw an error. + /// + /// If true, considers only visible worksheets, skipping over any hidden ones. + [ApiSet(Version = 1.5)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.Worksheet_Next)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "Next", InvalidateReturnObjectPathAfterRequest = true)] + Worksheet GetNext([Optional]bool visibleOnly); + + /// + /// Gets the worksheet that follows this one. If there are no worksheets following this one, this method will return a null object. + /// + /// If true, considers only visible worksheets, skipping over any hidden ones. + [ApiSet(Version = 1.5)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.Worksheet_NextOrNullObject)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "", InvalidateReturnObjectPathAfterRequest = true)] + Worksheet GetNextOrNullObject([Optional]bool visibleOnly); + + /// + /// 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). + /// + /// Considers only cells with values as used cells (ignoring formatting). + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.Worksheet_UsedRange)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "UsedRange", InvalidateReturnObjectPathAfterRequest = true)] + Range GetUsedRange([Optional]bool 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 a null object. + /// + /// Considers only cells with values as used cells. + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.Worksheet_UsedRangeOrNullObject)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "", InvalidateReturnObjectPathAfterRequest = true)] + Range GetUsedRangeOrNullObject([Optional]bool valuesOnly); + + /// + /// 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. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.Worksheet_Id)] + string Id { get; } + + /// + /// The zero-based position of the worksheet within the workbook. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.Worksheet_Position)] + int Position { get; set; } + + /// + /// The display name of the worksheet. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.Worksheet_Name)] + string Name { get; set; } + + /// + /// Collection of tables that are part of the worksheet. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.Worksheet_Tables)] + TableCollection Tables { get; } + + /// + /// The Visibility of the worksheet. + /// + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.Worksheet_Visible)] + [ApiSet(Version = 1.1, CustomText = "1.1 for reading visibility; 1.2 for setting it.")] + SheetVisibility Visibility { get; set; } + + /// + /// Returns sheet protection object for a worksheet. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.Worksheet_Protection)] + [JsonStringify()] + WorksheetProtection Protection { get; } + + /// + /// Collection of PivotTables that are part of the worksheet. Read-only. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.Worksheet_PivotTables)] + PivotTableCollection PivotTables { get; } + + /// + /// Collection of names scoped to the current worksheet. Read-only. + /// + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.Worksheet_Names)] + NamedItemCollection Names { get; } + + } + + /// + /// Represents a collection of worksheet objects that are part of the workbook. + /// + [ApiSet(Version = 1.1)] + [ClientCallableType(CreateItemOperationName = "Add")] + [ClientCallableComType(Name = "IWorksheetCollection", InterfaceId = "55a36c77-3310-4afb-aa64-3c1a685f2f50", CoClassName = "WorksheetCollection", SupportEnumeration = true)] + public interface WorksheetCollection : IEnumerable + { + /// + /// Gets the currently active worksheet in the workbook. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.WorksheetCollection_ActiveWorksheet)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "")] + Worksheet GetActiveWorksheet(); + + /// + /// Gets a worksheet object using its Name or ID. + /// + /// The Name or ID of the worksheet. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.WorksheetCollection_Indexer)] + Worksheet this[string key] { get; } + + /// + /// Gets a worksheet object using its Name or ID. If the worksheet does not exist, will return a null object. + /// + /// The Name or ID of the worksheet. + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.WorksheetCollection_GetItemOrNullObject)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "")] + Worksheet GetItemOrNullObject(string key); + + /// + /// 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. + /// + /// The name of the worksheet to be added. If specified, name should be unqiue. If not specified, Excel determines the name of the new worksheet. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.WorksheetCollection_Add)] + Worksheet Add([Optional]string name); + + /// + /// Gets the number of worksheets in the collection. + /// + /// Considers only the visible cells. + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.WorksheetCollection_GetCount)] + [ClientCallableOperation(OperationType = OperationType.Read)] + int GetCount([Optional]bool visibleOnly); + + /// + /// Gets the first worksheet in the collection. + /// If true, considers only visible worksheets, skipping over any hidden ones. + /// + [ApiSet(Version = 1.5)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.WorksheetCollection_First)] + [ClientCallableOperation(OperationType = OperationType.Read, InvalidateReturnObjectPathAfterRequest = true)] + Worksheet GetFirst([Optional]bool visibleOnly); + + /// + /// Gets the last worksheet in the collection. + /// If true, considers only visible worksheets, skipping over any hidden ones. + /// + [ApiSet(Version = 1.5)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.WorksheetCollection_Last)] + [ClientCallableOperation(OperationType = OperationType.Read, InvalidateReturnObjectPathAfterRequest = true)] + Worksheet GetLast([Optional]bool visibleOnly); + } + + /// + /// Represents the protection of a sheet object. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComType(Name = "IWorksheetProtection", InterfaceId = "C84C0D35-DEDB-4865-B4A0-B027BAFEC20D", CoClassName = "WorksheetProtection")] + public interface WorksheetProtection + { + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.WorksheetProtection_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + /// + /// Indicates if the worksheet is protected. Read-Only. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.WorksheetProtection_Protected)] + bool Protected { get; } + /// + /// Sheet protection options. Read-Only. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.WorksheetProtection_Options)] + WorksheetProtectionOptions Options { get; } + /// + /// Protects a worksheet. Fails if the worksheet has been protected. + /// + /// sheet protection options. + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.WorksheetProtection_Protect)] + void Protect([Optional]WorksheetProtectionOptions options); + /// + /// Unprotects a worksheet. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.WorksheetProtection_Unprotect)] + void Unprotect(); + } + + /// + /// Represents the options in sheet protection. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComType(Name = "IWorksheetProtectionOptions", InterfaceId = "201D75BE-81F5-4B2A-A3A8-AE4E72E47ECB", CoClassName = "WorksheetProtectionOptions", CoClassId = "56C94DB3-B781-44CF-9CA8-29FB47A6A267")] + public struct WorksheetProtectionOptions + { + /// + /// Represents the worksheet protection option of allowing formatting cells. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.WorksheetProtectionOptions_AllowFormatCells)] + [Optional] + bool AllowFormatCells { get; set; } + /// + /// Represents the worksheet protection option of allowing formatting columns. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.WorksheetProtectionOptions_AllowFormatColumns)] + [Optional] + bool AllowFormatColumns { get; set; } + /// + /// Represents the worksheet protection option of allowing formatting rows. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.WorksheetProtectionOptions_AllowFormatRows)] + [Optional] + bool AllowFormatRows { get; set; } + /// + /// Represents the worksheet protection option of allowing inserting columns. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.WorksheetProtectionOptions_AllowInsertColumns)] + [Optional] + bool AllowInsertColumns { get; set; } + /// + /// Represents the worksheet protection option of allowing inserting rows. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.WorksheetProtectionOptions_AllowInsertRows)] + [Optional] + bool AllowInsertRows { get; set; } + /// + /// Represents the worksheet protection option of allowing inserting hyperlinks. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.WorksheetProtectionOptions_AllowInsertHyperlinks)] + [Optional] + bool AllowInsertHyperlinks { get; set; } + /// + /// Represents the worksheet protection option of allowing deleting columns. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.WorksheetProtectionOptions_AllowDeleteColumns)] + [Optional] + bool AllowDeleteColumns { get; set; } + /// + /// Represents the worksheet protection option of allowing deleting rows. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.WorksheetProtectionOptions_AllowDeleteRows)] + [Optional] + bool AllowDeleteRows { get; set; } + /// + /// Represents the worksheet protection option of allowing using sort feature. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.WorksheetProtectionOptions_AllowSort)] + [Optional] + bool AllowSort { get; set; } + /// + /// Represents the worksheet protection option of allowing using auto filter feature. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.WorksheetProtectionOptions_AllowAutoFilter)] + [Optional] + bool AllowAutoFilter { get; set; } + /// + /// Represents the worksheet protection option of allowing using PivotTable feature. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = WorksheetDispatchIds.WorksheetProtectionOptions_AllowPivotTables)] + [Optional] + bool AllowPivotTables { get; set; } + } +#endregion Worksheet + +#region Range + internal static class RangeDispatchIds + { + internal const int Range_NumberFormat = 1; // DO NOT CHANGE Order of NumberFormat and Values + internal const int Range_Values = 2; // DO NOT CHANGE Order of NumberFormat and Values + internal const int Range_Text = 3; + internal const int Range_Formulas = 4; + internal const int Range_FormulasLocal = 5; + internal const int Range_RowIndex = 6; + internal const int Range_ColumnIndex = 7; + internal const int Range_RowCount = 8; + internal const int Range_ColumnCount = 9; + internal const int Range_Format = 10; + internal const int Range_Address = 11; + internal const int Range_AddressLocal = 12; + internal const int Range_Cell = 13; + internal const int Range_CellCount = 14; + internal const int Range_UsedRange = 15; + internal const int Range_Clear = 16; + internal const int Range_Insert = 17; + internal const int Range_Delete = 18; + internal const int Range_EntireColumn = 19; + internal const int Range_EntireRow = 20; + internal const int Range_Worksheet = 21; + internal const int Range_Select = 22; + internal const int Range_ReferenceId = 23; + internal const int Range_KeepReference = 24; + internal const int Range_GetOffsetRange = 25; + internal const int Range_GetRow = 26; + internal const int Range_GetColumn = 27; + internal const int Range_OnAccess = 28; + internal const int Range_GetIntersection = 29; + internal const int Range_GetBoundingRect = 30; + internal const int Range_ValueTypes = 31; + internal const int Range_GetLastCell = 32; + internal const int Range_GetLastColumn = 33; + internal const int Range_GetLastRow = 34; + internal const int Range_FormulasR1C1 = 35; + internal const int Range_Sort = 36; + internal const int Range_Merge = 37; + internal const int Range_Unmerge = 38; + internal const int Range_Hidden = 39; + internal const int Range_RowHidden = 40; + internal const int Range_ColumnHidden = 41; + internal const int Range_ValidateArraySize = 42; + internal const int Range_GetIntersectionOrNullObject = 43; + internal const int Range_GetRowsAbove = 44; + internal const int Range_GetRowsBelow = 45; + internal const int Range_GetColumnsBefore = 46; + internal const int Range_GetColumnsAfter = 47; + internal const int Range_GetResizedRange = 48; + internal const int Range_RangeView = 49; + internal const int Range_ConditionalFormats = 50; + internal const int Range_UsedRangeOrNullObject = 51; + internal const int Range_SurroundingRegion = 52; + internal const int Range_isEntireColumn = 53; + internal const int Range_isEntireRow = 54; + internal const int Range_Calculate = 55; + internal const int Range_GetAbsoluteResizedRange = 56; + internal const int Range_Hyperlink = 57; + + internal const int RangeReference_Address = 1; + + internal const int RangeHyperlink_ScreenTip = 1; + internal const int RangeHyperlink_Address = 2; + internal const int RangeHyperlink_DocumentReference = 3; + internal const int RangeHyperlink_TextToDisplay = 4; + } + + /// + /// Range represents a set of one or more contiguous cells such as a cell, a row, a column, block of cells, etc. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IRange", InterfaceId = "906962e8-a18a-4cc9-9342-279f056bc293", CoClassName = "Range")] + public interface Range + { + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_ValidateArraySize)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _ValidateArraySize(int rows, int columns); + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_KeepReference)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _KeepReference(); + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_ReferenceId)] + string _ReferenceId { get; } + /// + /// Represents the range reference in A1-style. Address value will contain the Sheet reference (e.g. Sheet1!A1:B4). Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_Address)] + string Address { get; } + /// + /// Represents range reference for the specified range in the language of the user. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_AddressLocal)] + string AddressLocal { get; } + + /// + /// Calculates a range of cells on a worksheet. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_Calculate)] + void Calculate(); + + /// + /// Number of cells in the range. This API will return -1 if the cell count exceeds 2^31-1 (2,147,483,647). Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_CellCount)] + int CellCount { get; } + /// + /// Clear range values, format, fill, border, etc. + /// + /// Determines the type of clear action. See Excel.ClearApplyTo for details. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_Clear)] + void Clear([Optional]ClearApplyTo applyTo); + /// + /// Represents the total number of columns in the range. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_ColumnCount)] + int ColumnCount { get; } + /// + /// Represents the column number of the first cell in the range. Zero-indexed. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_ColumnIndex)] + int ColumnIndex { get; } + /// + /// Collection of ConditionalFormats that intersect the range. Read-only. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_ConditionalFormats)] + ConditionalFormatCollection ConditionalFormats { get; } + /// + /// Deletes the cells associated with the range. + /// + /// Specifies which way to shift the cells. See Excel.DeleteShiftDirection for details. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_Delete)] + void Delete(DeleteShiftDirection shift); + /// + /// Gets an object that represents the entire column of the range (for example, if the current range represents cells "B4:E11", it's `getEntireColumn` is a range that represents columns "B:E"). + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_EntireColumn)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "EntireColumn", InvalidateReturnObjectPathAfterRequest = true)] + Range GetEntireColumn(); + /// + /// Gets an object that represents the entire row of the range (for example, if the current range represents cells "B4:E11", it's `GetEntireRow` is a range that represents rows "4:11"). + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_EntireRow)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "EntireRow", InvalidateReturnObjectPathAfterRequest = true)] + Range GetEntireRow(); + + + /// + /// Represents the type of data of each cell. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_ValueTypes)] + RangeValueType[][] ValueTypes { get; } + /// + /// Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_Format)] + [JsonStringify()] + RangeFormat Format { get; } + /// + /// Represents the formula in A1-style notation. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_Formulas)] + object[][] Formulas { get; set; } + /// + /// 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. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_FormulasLocal)] + object[][] FormulasLocal { get; set; } + /// + /// Represents the formula in R1C1-style notation. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_FormulasR1C1)] + object[][] FormulasR1C1 { get; set; } + + /// + /// Gets the smallest range object that encompasses the given ranges. For example, the GetBoundingRect of "B2:C5" and "D10:E15" is "B2:E16". + /// + /// The range object or address or range name. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_GetBoundingRect)] + [ClientCallableOperation(OperationType = OperationType.Read, InvalidateReturnObjectPathAfterRequest = true)] + Range GetBoundingRect([TypeScriptType("Excel.Range|string")]object anotherRange); + /// + /// 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's stays within the worksheet grid. The returned cell is located relative to the top left cell of the range. + /// + /// Row number of the cell to be retrieved. Zero-indexed. + /// Column number of the cell to be retrieved. Zero-indexed. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_Cell)] + [ClientCallableOperation(OperationType = OperationType.Read, InvalidateReturnObjectPathAfterRequest = true)] + Range GetCell(int row, int column); + /// + /// Gets a column contained in the range. + /// + /// Column number of the range to be retrieved. Zero-indexed. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_GetColumn)] + [ClientCallableOperation(OperationType = OperationType.Read, InvalidateReturnObjectPathAfterRequest = true)] + Range GetColumn(int column); + /// + /// Gets a certain number of columns to the right of the current Range object. + /// + /// 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. + [ApiSet(Version = 1.1, IntroducedInVersion = 1.3)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "ColumnsAfter", InvalidateReturnObjectPathAfterRequest = true)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_GetColumnsAfter)] + Range GetColumnsAfter([Optional]int? count); + /// + /// Gets a certain number of columns to the left of the current Range object. + /// + /// 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. + // NOTE: Until implemented in C++, this is an API that is "Polyfill-ed" using JavaScript. We don't want any codegen for it. Including it here just to capture the signature. + [ApiSet(Version = 1.1, IntroducedInVersion = 1.3)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "ColumnsBefore", InvalidateReturnObjectPathAfterRequest = true)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_GetColumnsBefore)] + Range GetColumnsBefore([Optional]int? count); + /// + /// 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. + /// + /// 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 columnsby 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. + [ApiSet(Version = 1.1, IntroducedInVersion = 1.3)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "ResizedRange", InvalidateReturnObjectPathAfterRequest = true)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_GetResizedRange)] + Range GetResizedRange(int deltaRows, int deltaColumns); + /// + /// Gets the range object that represents the rectangular intersection of the given ranges. + /// + /// The range object or range address that will be used to determine the intersection of ranges. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_GetIntersection)] + [ClientCallableOperation(OperationType = OperationType.Read, InvalidateReturnObjectPathAfterRequest = true)] + Range GetIntersection([TypeScriptType("Excel.Range|string")]object anotherRange); + /// + /// Gets the range object that represents the rectangular intersection of the given ranges. If no intersection is found, will return a null object. + /// + /// The range object or range address that will be used to determine the intersection of ranges. + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_GetIntersectionOrNullObject)] + [ClientCallableOperation(OperationType = OperationType.Read, InvalidateReturnObjectPathAfterRequest = true, RESTfulName = "")] + Range GetIntersectionOrNullObject([TypeScriptType("Excel.Range|string")]object anotherRange); + /// + /// Gets the last cell within the range. For example, the last cell of "B2:D5" is "D5". + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_GetLastCell)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "LastCell", InvalidateReturnObjectPathAfterRequest = true)] + Range GetLastCell(); + /// + /// Gets the last column within the range. For example, the last column of "B2:D5" is "D2:D5". + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_GetLastColumn)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "LastColumn", InvalidateReturnObjectPathAfterRequest = true)] + Range GetLastColumn(); + /// + /// Gets the last row within the range. For example, the last row of "B2:D5" is "B5:D5". + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_GetLastRow)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "LastRow", InvalidateReturnObjectPathAfterRequest = true)] + Range GetLastRow(); + /// + /// 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. + /// + /// 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. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_GetOffsetRange)] + [ClientCallableOperation(OperationType = OperationType.Read, InvalidateReturnObjectPathAfterRequest = true)] + Range GetOffsetRange(int rowOffset, int columnOffset); + /// + /// Gets a row contained in the range. + /// + /// Row number of the range to be retrieved. Zero-indexed. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_GetRow)] + [ClientCallableOperation(OperationType = OperationType.Read, InvalidateReturnObjectPathAfterRequest = true)] + Range GetRow(int row); + /// + /// Gets a certain number of rows above the current Range object. + /// + /// 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. + [ApiSet(Version = 1.1, IntroducedInVersion = 1.3)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "RowsAbove", InvalidateReturnObjectPathAfterRequest = true)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_GetRowsAbove)] + Range GetRowsAbove([Optional]int? count); + /// + /// Gets a certain number of rows below the current Range object. + /// + /// 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. + [ApiSet(Version = 1.1, IntroducedInVersion = 1.3)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "RowsBelow", InvalidateReturnObjectPathAfterRequest = true)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_GetRowsBelow)] + Range GetRowsBelow([Optional]int? count); + /// + /// Represents if all cells of the current range are hidden. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_Hidden)] + bool? Hidden { get; } + /// + /// Represents if all rows of the current range are hidden. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_RowHidden)] + bool? RowHidden { get; set; } + /// + /// Represents if all columns of the current range are hidden. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_ColumnHidden)] + bool? ColumnHidden { get; set; } + /// + /// 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. + /// + /// Specifies which way to shift the cells. See Excel.InsertShiftDirection for details. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_Insert)] + [ClientCallableOperation(InvalidateReturnObjectPathAfterRequest = true)] + Range Insert(InsertShiftDirection shift); + + /// + /// Merge the range cells into one region in the worksheet. + /// + /// Set true to merge cells in each row of the specified range as separate merged cells. The default value is false. + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_Merge)] + void Merge([Optional]bool across); + /// + /// Unmerge the range cells into separate cells. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_Unmerge)] + void Unmerge(); + /// + /// Represents Excel's number format code for the given cell. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_NumberFormat)] + object[][] NumberFormat { get; set; } + /// + /// Returns the total number of rows in the range. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_RowCount)] + int RowCount { get; } + /// + /// Returns the row number of the first cell in the range. Zero-indexed. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_RowIndex)] + int RowIndex { get; } + /// + /// Selects the specified range in the Excel UI. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_Select)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "")] + void Select(); + /// + /// 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. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_Text)] + object[][] Text { get; } + + /// + /// 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. + /// + /// Considers only cells with values as used cells. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_UsedRange)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "UsedRange", InvalidateReturnObjectPathAfterRequest = true)] + Range GetUsedRange([Optional]bool valuesOnly); + + /// + /// Returns the used range of the given range object. If there are no used cells within the range, this function will return a null object. + /// + /// Considers only cells with values as used cells. + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_UsedRangeOrNullObject)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "", InvalidateReturnObjectPathAfterRequest = true)] + Range GetUsedRangeOrNullObject([Optional]bool valuesOnly); + + /// + /// Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_Values)] + object[][] Values { get; set; } + /// + /// The worksheet containing the current range. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_Worksheet)] + Worksheet Worksheet { get; } + /// + /// Represents the range sort of the current range. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_Sort)] + RangeSort Sort { get; } + /// + /// Represents the visible rows of the current range. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.Range_RangeView)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "VisibleView")] + RangeView GetVisibleView(); + + + + } + + /// + /// Represents a string reference of the form SheetName!A1:B5, or a global or local named range. + /// + [ClientCallableComType(Name = "IRangeReference", InterfaceId = "A253E7A6-82CA-4314-9FEA-411507C37024", CoClassName = "RangeReference", CoClassId = "3A7C6019-23C3-4A18-AEDE-21CD89AAA672")] + [ApiSet(Version = 1.2)] + public struct RangeReference + { + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = RangeDispatchIds.RangeReference_Address)] + string Address { get; set; } + } + + #endregion Range + + #region RangeView + internal static class RangeViewDispatchIds + { + internal const int RangeViewCollection_Indexer = 1; + internal const int RangeViewCollection_First = 2; + internal const int RangeViewCollection_Last = 3; + internal const int RangeViewCollection_GetCount = 4; + + internal const int RangeView_OnAccess = 1; + internal const int RangeView_NumberFormat = 2; // DO NOT CHANGE Order of NumberFormat and Values + internal const int RangeView_Values = 3; // DO NOT CHANGE Order of NumberFormat and Values + internal const int RangeView_Text = 4; + internal const int RangeView_Rows = 5; + internal const int RangeView_Formulas = 6; + internal const int RangeView_FormulasLocal = 7; + internal const int RangeView_FormulasR1C1 = 8; + internal const int RangeView_ValueTypes = 9; + internal const int RangeView_RowCount = 10; + internal const int RangeView_ColumnCount = 11; + internal const int RangeView_Range = 12; + internal const int RangeView_CellAddresses = 13; + internal const int RangeView_Index = 14; + internal const int RangeView_First = 15; + internal const int RangeView_Last = 16; + } + + /// + /// RangeView represents a set of visible cells of the parent range. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComType(Name = "IRangeView", InterfaceId = "FE06F84B-2349-433F-B312-A2EFB1BFE2C8", CoClassName = "RangeView")] + public interface RangeView + { + [ClientCallableComMember(DispatchId = RangeViewDispatchIds.RangeView_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Returns a value that represents the index of the RangeView. Read-only. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = RangeViewDispatchIds.RangeView_Index)] + int Index { get; } + + /// + /// Represents the cell addresses of the RangeView. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = RangeViewDispatchIds.RangeView_CellAddresses)] + object[][] CellAddresses { get; } + + /// + /// Represents the formula in A1-style notation. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = RangeViewDispatchIds.RangeView_Formulas)] + object[][] Formulas { get; set; } + + /// + /// 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. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = RangeViewDispatchIds.RangeView_FormulasLocal)] + object[][] FormulasLocal { get; set; } + + /// + /// Represents the formula in R1C1-style notation. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = RangeViewDispatchIds.RangeView_FormulasR1C1)] + object[][] FormulasR1C1 { get; set; } + + /// + /// Represents Excel's number format code for the given cell. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = RangeViewDispatchIds.RangeView_NumberFormat)] + object[][] NumberFormat { get; set; } + + /// + /// Represents the raw values of the specified range view. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = RangeViewDispatchIds.RangeView_Values)] + object[][] Values { get; set; } + + /// + /// Represents the type of data of each cell. Read-only. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = RangeViewDispatchIds.RangeView_ValueTypes)] + RangeValueType[][] ValueTypes { get; } + + /// + /// 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. Read-only. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = RangeViewDispatchIds.RangeView_Text)] + object[][] Text { get; } + + /// + /// Gets the parent range associated with the current RangeView. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = RangeViewDispatchIds.RangeView_Range)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "Range", InvalidateReturnObjectPathAfterRequest = true)] + Range GetRange(); + + /// + /// Represents a collection of range views associated with the range. Read-only. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = RangeViewDispatchIds.RangeView_Rows)] + RangeViewCollection Rows { get; } + + /// + /// Returns the number of visible rows. Read-only. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = RangeViewDispatchIds.RangeView_RowCount)] + int RowCount { get; } + + /// + /// Returns the number of visible columns. Read-only. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = RangeViewDispatchIds.RangeView_ColumnCount)] + int ColumnCount { get; } + } + + /// + /// Represents a collection of RangeView objects. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComType(Name = "IRangeViewCollection", InterfaceId = "BB47319E-6777-4041-B46B-1D6F2AB827A3", CoClassName = "RangeViewCollection", SupportEnumeration = true)] + public interface RangeViewCollection : IEnumerable + { + /// + /// Gets a RangeView Row via it's index. Zero-Indexed. + /// + /// Index of the visible row. + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = RangeViewDispatchIds.RangeViewCollection_Indexer)] + [ClientCallableOperation(OperationType = OperationType.Read)] + RangeView GetItemAt(int index); + + /// + /// Gets the number of RangeView objects in the collection. + /// + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = RangeViewDispatchIds.RangeViewCollection_GetCount)] + [ClientCallableOperation(OperationType = OperationType.Read)] + int GetCount(); + } +#endregion + +#region Settings + internal static class SettingsDispatchIds + { + internal const int SettingCollection_Indexer = 1; + internal const int SettingCollection_Set = 2; + internal const int SettingCollection_Save = 3; + internal const int SettingCollection_Refresh = 4; + internal const int SettingCollection_ItemOrNullObject = 5; + internal const int SettingCollection_GetCount = 6; + + internal const int Setting_OnAccess = 1; + internal const int Setting_Key = 2; + internal const int Setting_Value = 3; + internal const int Setting_Delete = 4; + } + + /// + /// Represents a collection of worksheet objects that are part of the workbook. + /// + [ApiSet(Version = 1.4)] + [ClientCallableType(ExcludedFromRest = true)] + [ClientCallableComType(Name = "ISettingCollection", InterfaceId = "4BB24302-09C0-4717-B398-DCC2D834ED4C", CoClassName = "SettingCollection", SupportEnumeration = true)] + public interface SettingCollection : IEnumerable + { + /// + /// Gets a Setting entry via the key. + /// + /// Key of the setting. + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = SettingsDispatchIds.SettingCollection_Indexer)] + Setting this[string key] { get; } + /// + /// Sets or adds the specified setting to the workbook. + /// + /// The Key of the new setting. + /// The Value for the new setting. + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = SettingsDispatchIds.SettingCollection_Set)] + Setting Add(string key, [TypeScriptType("string|number|boolean|Array|any")] object value); + + /// + /// Gets a Setting entry via the key. If the Setting does not exist, will return a null object. + /// + /// The key of the setting. + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = SettingsDispatchIds.SettingCollection_ItemOrNullObject)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "")] + Setting GetItemOrNullObject(string key); + + /// + /// Occurs when the Settings in the document are changed. + /// + [ApiSet(Version = 1.4)] + event EventHandler SettingsChanged; + + /// + /// Gets the number of Settings in the collection. + /// + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = SettingsDispatchIds.SettingCollection_GetCount)] + [ClientCallableOperation(OperationType = OperationType.Read)] + int GetCount(); + } + + /// + /// Setting represents a key-value pair of a setting persisted to the document. + /// + [ApiSet(Version = 1.4)] + [ClientCallableType(ExcludedFromRest = true)] + [ClientCallableComType(Name = "ISetting", InterfaceId = "1907D9BB-DED3-498D-BD7C-9EB195333B2C", CoClassName = "Setting")] + public interface Setting + { + [ClientCallableComMember(DispatchId = SettingsDispatchIds.Setting_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Returns the key that represents the id of the Setting. Read-only. + /// + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = SettingsDispatchIds.Setting_Key)] + string Key { get; } + + /// + /// Represents the value stored for this setting. + /// + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = SettingsDispatchIds.Setting_Value)] + object Value { get; set; } + + /// + /// Deletes the setting. + /// + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = SettingsDispatchIds.Setting_Delete)] + void Delete(); + } +#endregion + +#region NamedItem + internal static class NamedItemDispatchIds + { + internal const int NamedItem_Name = 1; + internal const int NamedItem_Type = 2; + internal const int NamedItem_Value = 3; + internal const int NamedItem_Range = 4; + internal const int NamedItem_Visible = 5; + internal const int NamedItem_Id = 6; + internal const int NamedItem_OnAccess = 7; + internal const int NamedItem_Delete = 8; + internal const int NamedItem_Comment = 9; + internal const int NamedItem_RangeOrNull = 10; + internal const int NamedItem_Scope = 11; + internal const int NamedItem_Worksheet = 12; + internal const int NamedItem_WorksheetOrNull = 13; + + internal const int NamedItemCollection_Indexer = 1; + internal const int NamedItemCollection_GetItemOrNullObject = 2; + internal const int NamedItemCollection_Add = 3; + internal const int NamedItemCollection_AddFormulaLocal = 4; + internal const int NamedItemCollection_OnAccess = 5; + internal const int NamedItemCollection_GetCount = 6; + } + + /// + /// A collection of all the nameditem objects that are part of the workbook or worksheet, depending on how it was reached. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "INamedItemCollection", InterfaceId = "BD4C9F4B-F762-4779-AF4E-9E9665797830", CoClassName = "NamedItemCollection", SupportEnumeration = true)] + public interface NamedItemCollection : IEnumerable + { + /// + /// Gets a nameditem object using its name + /// + /// nameditem name. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = NamedItemDispatchIds.NamedItemCollection_Indexer)] + NamedItem this[string name] { get; } + + /// + /// Gets a nameditem object using its name. If the nameditem object does not exist, will return a null object. + /// + /// nameditem name. + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = NamedItemDispatchIds.NamedItemCollection_GetItemOrNullObject)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "")] + NamedItem GetItemOrNullObject(string name); + /// + /// Adds a new name to the collection of the given scope. + /// + /// The name of the named item. + /// The formula or the range that the name will refer to. + /// The comment associated with the named item + /// + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = NamedItemDispatchIds.NamedItemCollection_Add)] + NamedItem Add(string name, [TypeScriptType("Excel.Range|string")]object reference, [Optional]string comment); + + /// + /// Adds a new name to the collection of the given scope using the user's locale for the formula. + /// + /// The "name" of the named item. + /// The formula in the user's locale that the name will refer to. + /// The comment associated with the named item + /// + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = NamedItemDispatchIds.NamedItemCollection_AddFormulaLocal)] + NamedItem AddFormulaLocal(string name, string formula, [Optional] string comment); + + /// + /// Gets the number of named items in the collection. + /// + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = NamedItemDispatchIds.NamedItemCollection_GetCount)] + [ClientCallableOperation(OperationType = OperationType.Read)] + int GetCount(); + + [ClientCallableComMember(DispatchId = NamedItemDispatchIds.NamedItemCollection_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + } + + /// + /// 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, reference to a range. This object can be used to obtain range object associated with names. + /// + [ApiSet(Version = 1.1)] + [ClientCallableType(DeleteOperationName = "Delete")] + [ClientCallableComType(Name = "INamedItem", InterfaceId = "E76EE454-3E5E-4187-9389-3C65234609EF", CoClassName = "NamedItem")] + public interface NamedItem + { + [ClientCallableComMember(DispatchId = NamedItemDispatchIds.NamedItem_Id)] + string _Id { get; } + [ClientCallableComMember(DispatchId = NamedItemDispatchIds.NamedItem_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + /// + /// The name of the object. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = NamedItemDispatchIds.NamedItem_Name)] + string Name { get; } + + /// + /// Returns the range object that is associated with the name. Throws an error if the named item's type is not a range. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = NamedItemDispatchIds.NamedItem_Range)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "Range", InvalidateReturnObjectPathAfterRequest = true)] + Range GetRange(); + + /// + /// Returns the range object that is associated with the name. Returns a null object if the named item's type is not a range. + /// + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = NamedItemDispatchIds.NamedItem_RangeOrNull)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "", InvalidateReturnObjectPathAfterRequest = true)] + Range GetRangeOrNullObject(); + + /// + /// Indicates the type of the value returned by the name's formula. See Excel.NamedItemType for details. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = NamedItemDispatchIds.NamedItem_Type)] + NamedItemType? Type { get; } + + /// + /// Represents the value computed by the name's formula. For a named range, will return the range address. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = NamedItemDispatchIds.NamedItem_Value)] + object Value { get; } + + /// + /// Specifies whether the object is visible or not. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = NamedItemDispatchIds.NamedItem_Visible)] + bool Visible { get; set; } + + /// + /// Deletes the given name. + /// + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = NamedItemDispatchIds.NamedItem_Delete)] + void Delete(); + + /// + /// Represents the comment associated with this name. + /// + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = NamedItemDispatchIds.NamedItem_Comment)] + string Comment { get; set; } + + /// + /// Indicates whether the name is scoped to the workbook or to a specific worksheet. Read-only. + /// + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = NamedItemDispatchIds.NamedItem_Scope)] + NamedItemScope Scope { get; } + + /// + /// Returns the worksheet on which the named item is scoped to. Throws an error if the items is scoped to the workbook instead. + /// + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = NamedItemDispatchIds.NamedItem_Worksheet)] + Worksheet Worksheet { get; } + + /// + /// Returns the worksheet on which the named item is scoped to. Returns a null object if the item is scoped to the workbook instead. + /// + [ApiSet(Version = 1.4)] + [ClientCallableProperty(ExcludedFromRest = true)] + [ClientCallableComMember(DispatchId = NamedItemDispatchIds.NamedItem_WorksheetOrNull)] + Worksheet WorksheetOrNullObject { get; } + } + #endregion NamedItem + +#region Binding + internal static class BindingDispatchIds + { + internal const int Binding_Id = 1; + internal const int Binding_Type = 2; + internal const int Binding_Table = 3; + internal const int Binding_Range = 4; + internal const int Binding_Text = 5; + internal const int Binding_OnAccess = 6; + internal const int Binding_Delete = 7; + + internal const int BindingCollection_Indexer = 1; + internal const int BindingCollection_Count = 2; + internal const int BindingCollection_ItemAt = 3; + internal const int BindingCollection_Add = 4; + internal const int BindingCollection_AddFromNamedItem = 5; + internal const int BindingCollection_AddFromSelection = 6; + internal const int BindingCollection_GetItemOrNullObject = 7; + internal const int BindingCollection_GetCount = 8; + } + + /// + /// Represents an Office.js binding that is defined in the workbook. + /// + [ClientCallableType(ExcludedFromRest = true)] + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IBinding", InterfaceId = "7957FCE9-D0AF-4302-9F89-6818D8DEC5D5", CoClassName = "Binding")] + public interface Binding + { + [ClientCallableComMember(DispatchId = BindingDispatchIds.Binding_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + /// + /// Represents binding identifier. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = BindingDispatchIds.Binding_Id)] + [ClientCallableProperty(ExcludedFromRest = true)] + string Id { get; } + /// + /// Deletes the binding. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = BindingDispatchIds.Binding_Delete)] + void Delete(); + /// + /// Returns the range represented by the binding. Will throw an error if binding is not of the correct type. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = BindingDispatchIds.Binding_Range)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "")] + Range GetRange(); + /// + /// Returns the table represented by the binding. Will throw an error if binding is not of the correct type. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = BindingDispatchIds.Binding_Table)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "")] + Table GetTable(); + /// + /// Returns the text represented by the binding. Will throw an error if binding is not of the correct type. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = BindingDispatchIds.Binding_Text)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "")] + string GetText(); + /// + /// Returns the type of the binding. See Excel.BindingType for details. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = BindingDispatchIds.Binding_Type)] + [ClientCallableProperty(ExcludedFromRest = true)] + BindingType Type { get; } + + /// + /// Occurs when the selection is changed within the binding. + /// + [ApiSet(Version = 1.1, IntroducedInVersion = 1.3)] + event EventHandler SelectionChanged; + + /// + /// Occurs when data or formatting within the binding is changed. + /// + [ApiSet(Version = 1.1, IntroducedInVersion = 1.3)] + event EventHandler DataChanged; + } + + /// + /// Represents the collection of all the binding objects that are part of the workbook. + /// + [ClientCallableType(ExcludedFromRest = true)] + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IBindingCollection", InterfaceId = "0D1B5A8F-B3C1-4386-A285-5533EA59846E", CoClassName = "BindingCollection")] + public interface BindingCollection : IEnumerable + { + /// + /// Gets a binding object by ID. + /// + /// Id of the binding object to be retrieved. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = BindingDispatchIds.BindingCollection_Indexer)] + Binding this[string id] { get; } + /// + /// Gets a binding object by ID. If the binding object does not exist, will return a null object. + /// + /// Id of the binding object to be retrieved. + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = BindingDispatchIds.BindingCollection_GetItemOrNullObject)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "")] + Binding GetItemOrNullObject(string id); + /// + /// Returns the number of bindings in the collection. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = BindingDispatchIds.BindingCollection_Count)] + int Count { get; } + + /// + /// Gets the number of bindings in the collection. + /// + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = BindingDispatchIds.BindingCollection_GetCount)] + [ClientCallableOperation(OperationType = OperationType.Read)] + int GetCount(); + + /// + /// Gets a binding object based on its position in the items array. + /// + /// Index value of the object to be retrieved. Zero-indexed. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = BindingDispatchIds.BindingCollection_ItemAt)] + [ClientCallableOperation(OperationType = OperationType.Read)] + Binding GetItemAt(int index); + + /// + /// Add a new binding to a particular Range. + /// + /// Range to bind the binding to. May be an Excel Range object, or a string. If string, must contain the full address, including the sheet name + /// Type of binding. See Excel.BindingType. + /// Name of binding. + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = BindingDispatchIds.BindingCollection_Add)] + Binding Add([TypeScriptType("Excel.Range|string")] object range, BindingType bindingType, string id); + + /// + /// Add a new binding based on a named item in the workbook. + /// + /// Name from which to create binding. + /// Type of binding. See Excel.BindingType. + /// Name of binding. + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = BindingDispatchIds.BindingCollection_AddFromNamedItem)] + Binding AddFromNamedItem(string name, BindingType bindingType, string id); + + /// + /// Add a new binding based on the current selection. + /// + /// Type of binding. See Excel.BindingType. + /// Name of binding. + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = BindingDispatchIds.BindingCollection_AddFromSelection)] + Binding AddFromSelection(BindingType bindingType, string id); + + } + + #endregion Binding + +#region Table + internal static class TableDispatchIds + { + internal const int Table_Id = 1; + internal const int Table_Name = 2; + internal const int Table_Range = 3; + internal const int Table_HeaderRowRange = 4; + internal const int Table_DataBodyRange = 5; + internal const int Table_TotalRowRange = 6; + internal const int Table_ShowHeaders = 7; + internal const int Table_ShowTotals = 8; + internal const int Table_TableStyle = 9; + internal const int Table_TableColumns = 10; + internal const int Table_TableRows = 11; + internal const int Table_Delete = 12; + internal const int Table_OnAccess = 13; + internal const int Table_Sort = 14; + internal const int Table_ConvertToRange = 15; + internal const int Table_Worksheet = 16; + internal const int Table_ClearFilters = 17; + internal const int Table_ReapplyFilters = 18; + internal const int Table_FirstColumn = 19; + internal const int Table_LastColumn = 20; + internal const int Table_BandedRows = 21; + internal const int Table_BandedColumns = 22; + internal const int Table_FilterButton = 23; + + internal const int TableCollection_Count = 1; + internal const int TableCollection_Indexer = 2; + internal const int TableCollection_ItemAt = 3; + internal const int TableCollection_Add = 4; + internal const int TableCollection_OnAccess = 5; + internal const int TableCollection_GetItemOrNullObject = 6; + internal const int TableCollection_GetCount = 7; + + internal const int TableColumn_Id = 1; + // = 2 PREVIOUSLY USED ALREADY. DO NOT REUSE THIS ID. + internal const int TableColumn_Index = 3; + internal const int TableColumn_Range = 4; + internal const int TableColumn_HeaderRowRange = 5; + internal const int TableColumn_DataBodyRange = 6; + internal const int TableColumn_TotalRowRange = 7; + internal const int TableColumn_Values = 8; + internal const int TableColumn_Delete = 9; + internal const int TableColumn_OnAccess = 10; + internal const int TableColumn_Filter = 11; + internal const int TableColumn_Name = 12; + internal const int TableColumn_Previous = 13; + internal const int TableColumn_PreviousOrNullObject = 14; + internal const int TableColumn_Next = 15; + internal const int TableColumn_NextOrNullObject = 16; + + internal const int TableColumnCollection_Count = 1; + internal const int TableColumnCollection_Indexer = 2; + internal const int TableColumnCollection_ItemAt = 3; + internal const int TableColumnCollection_Insert = 4; + internal const int TableColumnCollection_OnAccess = 5; + internal const int TableColumnCollection_GetItemOrNullObject = 6; + internal const int TableColumnCollection_GetCount = 7; + internal const int TableColumnCollection_First = 8; + internal const int TableColumnCollection_Last = 9; + + internal const int TableRow_Index = 1; + internal const int TableRow_Range = 2; + internal const int TableRow_Values = 3; + internal const int TableRow_Delete = 4; + internal const int TableRow_OnAccess = 5; + + internal const int TableRowCollection_Count = 1; + internal const int TableRowCollection_ItemAt = 2; + internal const int TableRowCollection_Insert = 3; + internal const int TableRowCollection_OnAccess = 4; + internal const int TableRowCollection_GetCount = 5; + } + + /// + /// Represents a collection of all the tables that are part of the workbook or worksheet, depending on how it was reached. + /// + [ApiSet(Version = 1.1)] + [ClientCallableType(CreateItemOperationName = "Add")] + [ClientCallableComType(Name = "ITableCollection", InterfaceId = "D0BDE1B5-7F2E-480A-A803-98CE6BEBB873", CoClassName = "TableCollection")] + public interface TableCollection : IEnumerable + { + [ClientCallableComMember(DispatchId = TableDispatchIds.TableCollection_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + /// + /// Gets a table by Name or ID. + /// + /// Name or ID of the table to be retrieved. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableCollection_Indexer)] + Table this[[TypeScriptType("number|string")]object key] { get; } + /// + /// Gets a table by Name or ID. If the table does not exist, will return a null object. + /// + /// Name or ID of the table to be retrieved. + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableCollection_GetItemOrNullObject)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "")] + Table GetItemOrNullObject([TypeScriptType("number|string")]object key); + + /// + /// Returns the number of tables in the workbook. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableCollection_Count)] + int Count { get; } + + /// + /// Gets the number of tables in the collection. + /// + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableCollection_GetCount)] + [ClientCallableOperation(OperationType = OperationType.Read)] + int GetCount(); + + /// + /// Gets a table based on its position in the collection. + /// + /// Index value of the object to be retrieved. Zero-indexed. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableCollection_ItemAt)] + [ClientCallableOperation(OperationType = OperationType.Read)] + Table GetItemAt(int index); + + /// + /// Create 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. + /// + /// 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. + /// 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 header shifting the data down by one row. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableCollection_Add)] + Table Add(object address, bool hasHeaders); + } + + /// + /// Represents an Excel table. + /// + [ApiSet(Version = 1.1)] + [ClientCallableType(DeleteOperationName = "Delete", ConvertIntegerKeyValueToString = true)] + [ClientCallableComType(Name = "ITable", InterfaceId = "302DF59F-3294-46A2-8046-6A7647C75847", CoClassName = "Table")] + public interface Table + { + [ClientCallableComMember(DispatchId = TableDispatchIds.Table_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + /// + /// 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. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.Table_Id)] + int Id { get; } + /// + /// Name of the table. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.Table_Name)] + string Name { get; set; } + /// + /// Gets the range object associated with the entire table. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.Table_Range)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "Range", InvalidateReturnObjectPathAfterRequest = true)] + Range GetRange(); + /// + /// Gets the range object associated with header row of the table. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.Table_HeaderRowRange)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "HeaderRowRange", InvalidateReturnObjectPathAfterRequest = true)] + Range GetHeaderRowRange(); + /// + /// Gets the range object associated with the data body of the table. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.Table_DataBodyRange)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "DataBodyRange", InvalidateReturnObjectPathAfterRequest = true)] + Range GetDataBodyRange(); + /// + /// Gets the range object associated with totals row of the table. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.Table_TotalRowRange)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "TotalRowRange", InvalidateReturnObjectPathAfterRequest = true)] + Range GetTotalRowRange(); + /// + /// Indicates whether the header row is visible or not. This value can be set to show or remove the header row. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.Table_ShowHeaders)] + bool ShowHeaders { get; set; } + /// + /// Indicates whether the total row is visible or not. This value can be set to show or remove the total row. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.Table_ShowTotals)] + bool ShowTotals { get; set; } + /// + /// Indicates whether the first column contains special formatting. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = TableDispatchIds.Table_FirstColumn)] + bool HighlightFirstColumn { get; set; } + /// + /// Indicates whether the last column contains special formatting. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = TableDispatchIds.Table_LastColumn)] + bool HighlightLastColumn { get; set; } + /// + /// Indicates whether the rows show banded formatting in which odd rows are highlighted differently from even ones to make reading the table easier. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = TableDispatchIds.Table_BandedRows)] + bool ShowBandedRows { get; set; } + /// + /// Indicates whether the columns show banded formatting in which odd columns are highlighted differently from even ones to make reading the table easier. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = TableDispatchIds.Table_BandedColumns)] + bool ShowBandedColumns { get; set; } + /// + /// Indicates whether the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = TableDispatchIds.Table_FilterButton)] + bool ShowFilterButton { get; set; } + /// + /// Constant value that represents the Table style. Possible values are: TableStyleLight1 thru TableStyleLight21, TableStyleMedium1 thru TableStyleMedium28, TableStyleStyleDark1 thru TableStyleStyleDark11. A custom user-defined style present in the workbook can also be specified. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.Table_TableStyle)] + string Style { get; set; } + /// + /// Represents a collection of all the columns in the table. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.Table_TableColumns)] + TableColumnCollection Columns { get; } + /// + /// Represents a collection of all the rows in the table. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.Table_TableRows)] + TableRowCollection Rows { get; } + /// + /// The worksheet containing the current table. Read-only. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = TableDispatchIds.Table_Worksheet)] + Worksheet Worksheet { get; } + /// + /// Deletes the table. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.Table_Delete)] + void Delete(); + /// + /// Represents the sorting for the table. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = TableDispatchIds.Table_Sort)] + TableSort Sort { get; } + /// + /// Converts the table into a normal range of cells. All data is preserved. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = TableDispatchIds.Table_ConvertToRange)] + [ClientCallableOperation(InvalidateReturnObjectPathAfterRequest = true)] + Range ConvertToRange(); + + /// + /// Clears all the filters currently applied on the table. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = TableDispatchIds.Table_ClearFilters)] + void ClearFilters(); + + /// + /// Reapplies all the filters currently on the table. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = TableDispatchIds.Table_ReapplyFilters)] + void ReapplyFilters(); + } + + /// + /// Represents a collection of all the columns that are part of the table. + /// + [ApiSet(Version = 1.1)] + [ClientCallableType(CreateItemOperationName = "Add")] + [ClientCallableComType(Name = "ITableColumnCollection", InterfaceId = "97FD1554-DDA6-49CD-9D39-737AF8297E70", CoClassName = "TableColumnCollection")] + public interface TableColumnCollection : IEnumerable + { + [ClientCallableComMember(DispatchId = TableDispatchIds.TableColumnCollection_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + /// + /// Gets a column object by Name or ID. + /// + /// Column Name or ID. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableColumnCollection_Indexer)] + TableColumn this[object key] { get; } + /// + /// Gets a column object by Name or ID. If the column does not exist, will return a null object. + /// + /// Column Name or ID. + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableColumnCollection_GetItemOrNullObject)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "")] + TableColumn GetItemOrNullObject(object key); + + /// + /// Returns the number of columns in the table. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableColumnCollection_Count)] + int Count { get; } + + /// + /// Gets the number of columns in the table. + /// + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableColumnCollection_GetCount)] + [ClientCallableOperation(OperationType = OperationType.Read)] + int GetCount(); + + /// + /// Gets a column based on its position in the collection. + /// + /// Index value of the object to be retrieved. Zero-indexed. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableColumnCollection_ItemAt)] + [ClientCallableOperation(OperationType = OperationType.Read)] + TableColumn GetItemAt(int index); + + /// + /// Adds a new column to the table. + /// + /// 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. + /// A 2-dimensional array of unformatted values of the table column. + /// Specifies the name of the new column. If null, the default name will be used. + [ApiSet(Version = 1.1, CustomText = "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.")] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableColumnCollection_Insert)] + TableColumn Add([Optional]int? index, [Optional]object values, [Optional]string name); + } + + /// + /// Represents a column in a table. + /// + [ApiSet(Version = 1.1)] + [ClientCallableType(DeleteOperationName = "Delete", ConvertIntegerKeyValueToString = true)] + [ClientCallableComType(Name = "ITableColumn", InterfaceId = "3291F5CF-437F-482D-BAA1-B0F4C2E430D0", CoClassName = "TableColumn")] + public interface TableColumn + { + [ClientCallableComMember(DispatchId = TableDispatchIds.TableColumn_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + /// + /// Returns a unique key that identifies the column within the table. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableColumn_Id)] + int Id { get; } + /// + /// Represents the name of the table column. + /// + [ApiSet(Version = 1.1, CustomText = "1.1 for getting the name; 1.4 for setting it.")] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableColumn_Name)] + string Name { get; set; } + /// + /// Returns the index number of the column within the columns collection of the table. Zero-indexed. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableColumn_Index)] + int Index { get; } + /// + /// Gets the range object associated with the entire column. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableColumn_Range)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "Range", InvalidateReturnObjectPathAfterRequest = true)] + Range GetRange(); + /// + /// Gets the range object associated with the header row of the column. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableColumn_HeaderRowRange)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "HeaderRowRange", InvalidateReturnObjectPathAfterRequest = true)] + Range GetHeaderRowRange(); + /// + /// Gets the range object associated with the data body of the column. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableColumn_DataBodyRange)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "DataBodyRange", InvalidateReturnObjectPathAfterRequest = true)] + Range GetDataBodyRange(); + /// + /// Gets the range object associated with the totals row of the column. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableColumn_TotalRowRange)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "TotalRowRange", InvalidateReturnObjectPathAfterRequest = true)] + Range GetTotalRowRange(); + + + /// + /// Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableColumn_Values)] + object[][] Values { get; set; } + /// + /// Deletes the column from the table. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableColumn_Delete)] + void Delete(); + /// + /// Retrieve the filter applied to the column. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableColumn_Filter)] + Filter Filter { get; } + } + + /// + /// 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/columns are added before them, + /// a TableRow object represent 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. + /// + [ApiSet(Version = 1.1)] + [ClientCallableType(CreateItemOperationName = "Add")] + [ClientCallableComType(Name = "ITableRowCollection", InterfaceId = "70544D5B-C1BD-4D4F-A410-87785C4BF2B4", CoClassName = "TableRowCollection")] + public interface TableRowCollection : IEnumerable + { + [ClientCallableComMember(DispatchId = TableDispatchIds.TableRowCollection_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Returns the number of rows in the table. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableRowCollection_Count)] + int Count { get; } + + /// + /// Gets the number of rows in the table. + /// + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableRowCollection_GetCount)] + [ClientCallableOperation(OperationType = OperationType.Read)] + int GetCount(); + + /// + /// Gets a row based on its position in the collection. + /// + /// Note that unlike Ranges or Columns, which will adjust if new rows/columns are added before them, + /// a TableRow object represent 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. + /// + /// Index value of the object to be retrieved. Zero-indexed. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableRowCollection_ItemAt)] + [ClientCallableOperation(OperationType = OperationType.Read)] + TableRow GetItemAt(int index); + + /// + /// 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/columns are added before them, + /// a TableRow object represent 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. + /// + /// 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. + /// A 2-dimensional array of unformatted values of the table row. + [ApiSet(Version = 1.1, CustomText = "1.1 for adding a single row; 1.4 allows adding of multiple rows.")] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableRowCollection_Insert)] + TableRow Add([Optional]int? index, [Optional]object values); + } + + /// + /// Represents a row in a table. + /// + /// Note that unlike Ranges or Columns, which will adjust if new rows/columns are added before them, + /// a TableRow object represent 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. + /// + [ApiSet(Version = 1.1)] + [ClientCallableType(DeleteOperationName = "Delete")] + [ClientCallableComType(Name = "ITableRow", InterfaceId = "2604BD8F-678C-4688-9A24-A43F5B3BE4C2", CoClassName = "TableRow")] + public interface TableRow + { + [ClientCallableComMember(DispatchId = TableDispatchIds.TableRow_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + /// + /// Returns the index number of the row within the rows collection of the table. Zero-indexed. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableRow_Index)] + int Index { get; } + /// + /// Returns the range object associated with the entire row. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableRow_Range)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "Range", InvalidateReturnObjectPathAfterRequest = true)] + Range GetRange(); + /// + /// Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableRow_Values)] + object[][] Values { get; set; } + /// + /// Deletes the row from the table. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = TableDispatchIds.TableRow_Delete)] + void Delete(); + } +#endregion Table + +#region Range Formats + internal static class RangeFormatDispatchIds + { + internal const int RangeBorder_SideIndex = 1; + internal const int RangeBorder_LineStyle = 2; + internal const int RangeBorder_Weight = 3; + internal const int RangeBorder_Color = 4; + internal const int RangeBorder_OnAccess = 5; + internal const int RangeBorder_Id = 6; + + internal const int RangeBorderCollection_Indexer = 1; + internal const int RangeBorderCollection_Count = 2; + internal const int RangeBorderCollection_ItemAt = 3; + internal const int RangeBorderCollection_OnAccess = 4; + + internal const int RangeFill_Color = 1; + internal const int RangeFill_Clear = 2; + internal const int RangeFill_OnAccess = 3; + + internal const int RangeFont_Name = 1; + internal const int RangeFont_Size = 2; + internal const int RangeFont_Color = 3; + internal const int RangeFont_Italic = 4; + internal const int RangeFont_Bold = 5; + internal const int RangeFont_Underline = 6; + internal const int RangeFont_OnAccess = 7; + + internal const int RangeFormat_Fill = 1; + internal const int RangeFormat_Font = 2; + internal const int RangeFormat_WrapText = 3; + internal const int RangeFormat_HorizontalAlignment = 4; + internal const int RangeFormat_VerticalAlignment = 5; + internal const int RangeFormat_Borders = 6; + internal const int RangeFormat_OnAccess = 7; + internal const int RangeFormat_ColumnWidth = 8; + internal const int RangeFormat_RowHeight = 9; + internal const int RangeFormat_AutofitColumns = 10; + internal const int RangeFormat_AutofitRows = 11; + internal const int RangeFormat_Protection = 12; + internal const int RangeFormat_TextOrientation = 13; + + internal const int FormatProtection_OnAccess = 1; + internal const int FormatProtection_Locked = 2; + internal const int FormatProtection_FormulaHidden = 3; + } + + /// + /// A format object encapsulating the range's font, fill, borders, alignment, and other properties. + /// + [ClientCallableComType(Name = "IRangeFormat", InterfaceId = "E97D0B6E-8FBA-4FD5-9922-495283F3C44C", CoClassName = "RangeFormat")] + [ApiSet(Version = 1.1)] + public interface RangeFormat + { + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeFormat_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + /// + /// Gets or sets the width of all colums within the range. If the column widths are not uniform, null will be returned. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeFormat_ColumnWidth)] + double? ColumnWidth { get; set; } + /// + /// Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeFormat_AutofitColumns)] + void AutofitColumns(); + /// + /// Returns the fill object defined on the overall range. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeFormat_Fill)] + [JsonStringify()] + RangeFill Fill { get; } + /// + /// Collection of border objects that apply to the overall range. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeFormat_Borders)] + RangeBorderCollection Borders { get; } + /// + /// Returns the font object defined on the overall range. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeFormat_Font)] + [JsonStringify()] + RangeFont Font { get; } + /// + /// Represents the horizontal alignment for the specified object. See Excel.HorizontalAlignment for details. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeFormat_HorizontalAlignment)] + HorizontalAlignment? HorizontalAlignment { get; set; } + /// + /// Gets or sets the height of all rows in the range. If the row heights are not uniform null will be returned. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeFormat_RowHeight)] + double? RowHeight { get; set; } + /// + /// Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeFormat_AutofitRows)] + void AutofitRows(); + /// + /// Represents the vertical alignment for the specified object. See Excel.VerticalAlignment for details. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeFormat_VerticalAlignment)] + VerticalAlignment? VerticalAlignment { get; set; } + /// + /// Indicates if Excel wraps the text in the object. A null value indicates that the entire range doesn't have uniform wrap setting + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeFormat_WrapText)] + bool? WrapText { get; set; } + /// + /// Returns the format protection object for a range. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeFormat_Protection)] + [JsonStringify()] + FormatProtection Protection { get; } + + } + + /// + /// Represents the format protection of a range object. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComType(Name = "IFormatProtection", InterfaceId = "52AB99FC-FBC1-4E4B-B08B-3AD22314A32E", CoClassName = "FormatProtection")] + public interface FormatProtection + { + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.FormatProtection_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + /// + /// Indicates if Excel locks the cells in the object. A null value indicates that the entire range doesn't have uniform lock setting. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.FormatProtection_Locked)] + bool? Locked { get; set; } + /// + /// Indicates if Excel hides the formula for the cells in the range. A null value indicates that the entire range doesn't have uniform formula hidden setting. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.FormatProtection_FormulaHidden)] + bool? FormulaHidden { get; set; } + } + + /// + /// Represents the background of a range object. + /// + [ClientCallableComType(Name = "IRangeFill", InterfaceId = "C4514652-D1DB-41D1-8B25-9A27F1B33413", CoClassName = "RangeFill")] + [ApiSet(Version = 1.1)] + public interface RangeFill + { + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeFill_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + /// + /// HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange") + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeFill_Color)] + string Color { get; set; } + /// + /// Resets the range background. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeFill_Clear)] + void Clear(); + } + + /// + /// Represents the border of an object. + /// + [ClientCallableComType(Name = "IRangeBorder", InterfaceId = "AACFA926-132B-4B49-9D78-1AD4E20B1382", CoClassName = "RangeBorder")] + [ApiSet(Version = 1.1)] + public interface RangeBorder + { + /// + /// Represents border identifier. Read-only. + /// + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeBorder_Id)] + [ClientCallableProperty(ExcludedFromClientLibrary = true)] + [ApiSet(Version = 1.1)] + BorderIndex Id { get; } + + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeBorder_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + /// + /// HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeBorder_Color)] + string Color { get; set; } + /// + /// One of the constants of line style specifying the line style for the border. See Excel.BorderLineStyle for details. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeBorder_LineStyle)] + BorderLineStyle? Style { get; set; } + /// + /// Constant value that indicates the specific side of the border. See Excel.BorderIndex for details. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeBorder_SideIndex)] + BorderIndex? SideIndex { get; } + /// + /// Specifies the weight of the border around a range. See Excel.BorderWeight for details. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeBorder_Weight)] + BorderWeight? Weight { get; set; } + } + + /// + /// Represents the border objects that make up the range border. + /// + [ClientCallableComType(Name = "IRangeBorderCollection", InterfaceId = "BD62C8A4-0125-4EB9-9FE5-91E58E718D06", CoClassName = "RangeBorderCollection")] + [ApiSet(Version = 1.1)] + public interface RangeBorderCollection : IEnumerable + { + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeBorderCollection_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + /// + /// Gets a border object using its name + /// + /// Index value of the border object to be retrieved. See Excel.BorderIndex for details. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeBorderCollection_Indexer)] + RangeBorder this[BorderIndex index] { get; } + + /// + /// Number of border objects in the collection. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeBorderCollection_Count)] + int Count { get; } + + /// + /// Gets a border object using its index + /// + /// Index value of the object to be retrieved. Zero-indexed. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeBorderCollection_ItemAt)] + [ClientCallableOperation(OperationType = OperationType.Read)] + RangeBorder GetItemAt(int index); + } + + /// + /// This object represents the font attributes (font name, font size, color, etc.) for an object. + /// + [ClientCallableComType(Name = "IRangeFont", InterfaceId = "FAAF874F-30F4-4445-8D6A-F99A6EE81C72", CoClassName = "RangeFont")] + [ApiSet(Version = 1.1)] + public interface RangeFont + { + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeFont_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + /// + /// Represents the bold status of font. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeFont_Bold)] + bool? Bold { get; set; } + /// + /// HTML color code representation of the text color. E.g. #FF0000 represents Red. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeFont_Color)] + string Color { get; set; } + /// + /// Represents the italic status of the font. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeFont_Italic)] + bool? Italic { get; set; } + /// + /// Font name (e.g. "Calibri") + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeFont_Name)] + string Name { get; set; } + /// + /// Font size. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeFont_Size)] + double? Size { get; set; } + /// + /// Type of underline applied to the font. See Excel.RangeUnderlineStyle for details. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = RangeFormatDispatchIds.RangeFont_Underline)] + RangeUnderlineStyle? Underline { get; set; } + } +#endregion Formats + +#region Charts + internal static class ChartDispatchIds + { + internal const int ChartAxes_Category = 1; + internal const int ChartAxes_Series = 2; + internal const int ChartAxes_Value = 3; + internal const int ChartAxes_OnAccess = 4; + + internal const int ChartAxis_MajorGridlines = 1; + internal const int ChartAxis_MajorUnit = 2; + internal const int ChartAxis_Maximum = 3; + internal const int ChartAxis_Minimum = 4; + internal const int ChartAxis_MinorGridlines = 5; + internal const int ChartAxis_MinorUnit = 6; + internal const int ChartAxis_Title = 7; + internal const int ChartAxis_Format = 8; + internal const int ChartAxis_Type = 9; + internal const int ChartAxis_MinorUnitScale = 10; + internal const int ChartAxis_MajorUnitScale = 11; + internal const int ChartAxis_BaseUnit = 12; + internal const int ChartAxis_CategoryNames = 13; + internal const int ChartAxis_CategoryType = 14; + internal const int ChartAxis_OnAccess = 15; + internal const int ChartAxis_DisplayUnit = 16; + internal const int ChartAxis_ShowDisplayUnitLabel = 17; + internal const int ChartAxis_CustomDisplayUnit = 18; + + internal const int ChartAxisFormat_Font = 1; + internal const int ChartAxisFormat_Line = 2; + internal const int ChartAxisFormat_OnAccess = 3; + + internal const int ChartAxisTitle_Text = 1; + internal const int ChartAxisTitle_Visible = 2; + internal const int ChartAxisTitle_Format = 3; + internal const int ChartAxisTitle_OnAccess = 4; + + internal const int ChartAxisTitleFormat_Font = 1; + internal const int ChartAxisTitleFormat_OnAccess = 2; + + internal const int Chart_Title = 1; + internal const int Chart_SetData = 2; + internal const int Chart_DataLabels = 3; + internal const int Chart_Legend = 4; + internal const int Chart_Name = 5; + internal const int Chart_Top = 6; + internal const int Chart_Left = 7; + internal const int Chart_Width = 8; + internal const int Chart_Height = 9; + internal const int Chart_Delete = 10; + internal const int Chart_Series = 11; + internal const int Chart_Id = 12; + internal const int Chart_Axes = 13; + internal const int Chart_Format = 14; + internal const int Chart_OnAccess = 15; + internal const int Chart_SetPosition = 16; + internal const int Chart_GetImage = 17; + internal const int Chart_Worksheet = 18; + + internal const int ChartAreaFormat_Fill = 1; + internal const int ChartAreaFormat_Font = 2; + internal const int ChartAreaFormat_OnAccess = 3; + + internal const int ChartCollection_Add = 1; + internal const int ChartCollection_Count = 2; + internal const int ChartCollection_ItemAt = 3; + internal const int ChartCollection_Indexer = 4; + internal const int ChartCollection_GetByName = 5; + internal const int ChartCollection_GetItem = 6; + internal const int ChartCollection_OnAccess = 7; + internal const int ChartCollection_GetItemOrNullObject = 8; + internal const int ChartCollection_GetCount = 9; + + internal const int ChartDataLabels_Position = 1; + internal const int ChartDataLabels_ShowValue = 2; + internal const int ChartDataLabels_ShowSeriesName = 3; + internal const int ChartDataLabels_ShowCategoryName = 4; + internal const int ChartDataLabels_ShowLegendKey = 5; + internal const int ChartDataLabels_ShowPercentage = 6; + internal const int ChartDataLabels_ShowBubbleSize = 7; + internal const int ChartDataLabels_Separator = 8; + internal const int ChartDataLabels_Format = 9; + internal const int ChartDataLabels_OnAccess = 10; + + internal const int ChartDataLabelFormat_Font = 1; + internal const int ChartDataLabelFormat_Fill = 2; + internal const int ChartDataLabelFormat_OnAccess = 3; + + internal const int ChartFill_SolidColor = 1; + internal const int ChartFill_Clear = 2; + internal const int ChartFill_OnAccess = 3; + + internal const int ChartBorder_SolidColor = 1; + internal const int ChartBorder_Clear = 2; + internal const int ChartBorder_OnAccess = 3; + + internal const int ChartFont_Bold = 1; + internal const int ChartFont_Color = 2; + internal const int ChartFont_Italic = 3; + internal const int ChartFont_Name = 4; + internal const int ChartFont_Size = 5; + internal const int ChartFont_Underline = 6; + internal const int ChartFont_OnAccess = 7; + + internal const int ChartGridlines_Visible = 1; + internal const int ChartGridlines_Format = 2; + internal const int ChartGridlines_OnAccess = 3; + + internal const int ChartGridlinesFormat_Line = 1; + internal const int ChartGridlinesFormat_OnAccess = 2; + + internal const int ChartLegend_Visible = 1; + internal const int ChartLegend_Position = 2; + internal const int ChartLegend_Overlay = 3; + internal const int ChartLegend_Format = 4; + internal const int ChartLegend_OnAccess = 5; + + internal const int ChartLegendFormat_Font = 1; + internal const int ChartLegendFormat_Fill = 2; + internal const int ChartLegendFormat_OnAccess = 3; + + internal const int ChartLineFormat_Clear = 1; + internal const int ChartLineFormat_Color = 2; + internal const int ChartLineFormat_OnAccess = 3; + + internal const int ChartTitle_Visible = 1; + internal const int ChartTitle_Text = 2; + internal const int ChartTitle_Overlay = 3; + internal const int ChartTitle_Format = 4; + internal const int ChartTitle_OnAccess = 5; + internal const int ChartTitle_GetSubstring = 6; + internal const int ChartTitle_HorizontalAlignment = 7; + + internal const int ChartTitleFormat_Font = 1; + internal const int ChartTitleFormat_Fill = 2; + internal const int ChartTitleFormat_OnAccess = 3; + + internal const int ChartPoint_Format = 1; + internal const int ChartPoint_Value = 2; + internal const int ChartPoint_OnAccess = 3; + + internal const int ChartPointFormat_Fill = 1; + internal const int ChartPointFormat_OnAccess = 2; + internal const int ChartPointFormat_Border = 3; + + internal const int ChartPointsCollection_Count = 1; + internal const int ChartPointsCollection_ItemAt = 2; + internal const int ChartPointsCollection_OnAccess = 3; + internal const int ChartPointsCollection_GetCount = 4; + internal const int ChartPointsCollection_First = 5; + internal const int ChartPointsCollection_Last = 6; + + internal const int ChartSeries_Name = 1; + internal const int ChartSeries_Points = 2; + internal const int ChartSeries_Format = 3; + internal const int ChartSeries_OnAccess = 4; + internal const int ChartSeries_Delete = 5; + internal const int ChartSeries_SetXAxisValues = 6; + internal const int ChartSeries_SetValues = 7; + internal const int ChartSeries_SetBubbleSizes = 8; + internal const int ChartSeries_Trendlines = 9; + + internal const int ChartSeriesFormat_Fill = 1; + internal const int ChartSeriesFormat_Line = 2; + internal const int ChartSeriesFormat_OnAccess = 3; + + internal const int ChartSeriesCollection_Count = 1; + internal const int ChartSeriesCollection_ItemAt = 2; + internal const int ChartSeriesCollection_OnAccess = 3; + internal const int ChartSeriesCollection_GetCount = 4; + internal const int ChartSeriesCollection_First = 5; + internal const int ChartSeriesCollection_Last = 6; + internal const int ChartSeriesCollection_Add = 7; + + internal const int ChartTrendline_Format = 1; + internal const int ChartTrendline_Type = 2; + internal const int ChartTrendline_PolynomialOrder = 3; + internal const int ChartTrendline_MovingAveragePeriod = 4; + internal const int ChartTrendline_OnAccess = 5; + + internal const int ChartTrendlineCollection_OnAccess = 1; + internal const int ChartTrendlineCollection_GetCount = 2; + internal const int ChartTrendlineCollection_Add = 3; + + internal const int ChartTrendlineFormat_Line = 1; + internal const int ChartTrendlineFormat_OnAccess = 2; + + internal const int ChartFormatString_Font = 1; + internal const int ChartFormatString_OnAccess = 2; + } + + /// + /// A collection of all the chart objects on a worksheet. + /// + [ApiSet(Version = 1.1)] + [ClientCallableType(CreateItemOperationName = "Add", HiddenIndexerMethod = true)] + [ClientCallableComType(Name = "IChartCollection", InterfaceId = "c70eaacf-0ea6-4a54-b148-c600f9a5f5e4", CoClassName = "ChartCollection")] + public interface ChartCollection : IEnumerable + { + /// + /// Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned. + /// + /// Name of the chart to be retrieved. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartCollection_GetItem)] + [ClientCallableOperation(OperationType = OperationType.Read)] + Chart GetItem(string 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 does not exist, will return a null object. + /// + /// Name of the chart to be retrieved. + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartCollection_GetItemOrNullObject)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "")] + Chart GetItemOrNullObject(string name); + + /// + /// Creates a new chart. + /// + /// Represents the type of a chart. See Excel.ChartType for details. + /// The Range object corresponding to the source data. + /// Specifies the way columns or rows are used as data series on the chart. See Excel.ChartSeriesBy for details. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartCollection_Add)] + // Note: while sourceData can accept either a Range object or a string (necessary for REST), we will ONLY allow Range objects in JS. + // Otherwise, desktop code and WAC behavior diverges, given their different treatement of multi-range areas (WAC disallows them), table expansion (desktop does, WAC doesn't), etc. + Chart Add(ChartType type, object sourceData, [Optional]ChartSeriesBy seriesBy); + + /// + /// Returns the number of charts in the worksheet. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartCollection_Count)] + int Count { get; } + + /// + /// Returns the number of charts in the worksheet. + /// + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartCollection_GetCount)] + [ClientCallableOperation(OperationType = OperationType.Read)] + int GetCount(); + + /// + /// Gets a chart based on its position in the collection. + /// + /// Index value of the object to be retrieved. Zero-indexed. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartCollection_ItemAt)] + [ClientCallableOperation(OperationType = OperationType.Read)] + Chart GetItemAt(int index); + } + + /// + /// Represents a chart object in a workbook. + /// + [ApiSet(Version = 1.1)] + [ClientCallableType(DeleteOperationName = "Delete")] + [ClientCallableComType(Name = "IChart", InterfaceId = "b35ce724-5414-4380-8eac-582651db71e7", CoClassName = "Chart")] + public interface Chart + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.Chart_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + [ClientCallableComMember(DispatchId = ChartDispatchIds.Chart_Id)] + [ClientCallableProperty(ExcludedFromClientLibrary = true)] + [ApiSet(Version = 1.2)] + string Id { get; } + + /// + /// Represents chart axes. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.Chart_Axes)] + [JsonStringify()] + ChartAxes Axes { get; } + + /// + /// Represents the datalabels on the chart. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.Chart_DataLabels)] + [JsonStringify()] + ChartDataLabels DataLabels { get; } + + /// + /// Deletes the chart object. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.Chart_Delete)] + void Delete(); + + /// + /// Represents the height, in points, of the chart object. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.Chart_Height)] + double Height { get; set; } + + /// + /// The distance, in points, from the left side of the chart to the worksheet origin. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.Chart_Left)] + double Left { get; set; } + + /// + /// Represents the legend for the chart. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.Chart_Legend)] + [JsonStringify()] + ChartLegend Legend { get; } + + /// + /// Represents the name of a chart object. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.Chart_Name)] + string Name { get; set; } + + /// + /// Represents either a single series or collection of series in the chart. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.Chart_Series)] + ChartSeriesCollection Series { get; } + + /// + /// Resets the source data for the chart. + /// + /// 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, Columns. See Excel.ChartSeriesBy for details. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.Chart_SetData)] + // Note: while sourceData can accept either a Range object or a string (necessary for REST), we will ONLY allow Range objects in JS. + // Otherwise, desktop code and WAC behavior diverges, given their different treatement of multi-range areas (WAC disallows them), table expansion (desktop does, WAC doesn't), etc. + void SetData(object sourceData, [Optional]ChartSeriesBy seriesBy); + + /// + /// Positions the chart relative to cells on the worksheet. + /// + /// 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. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.Chart_SetPosition)] + void SetPosition(object startCell, [Optional]object endCell); + + /// + /// Represents the title of the specified chart, including the text, visibility, position and formating of the title. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.Chart_Title)] + [JsonStringify()] + ChartTitle Title { get; } + + /// + /// Represents 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). + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.Chart_Top)] + double Top { get; set; } + + /// + /// Represents the width, in points, of the chart object. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.Chart_Width)] + double Width { get; set; } + + /// + /// Encapsulates the format properties for the chart area. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.Chart_Format)] + [JsonStringify()] + ChartAreaFormat Format { get; } + + /// + /// 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. + /// + /// (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 to the specified dimensions (if both height and width are set)." + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.Chart_GetImage)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "Image")] + System.IO.Stream GetImage([Optional]int width, [Optional]int height, [Optional]ImageFittingMode fittingMode); + + /// + /// The worksheet containing the current chart. Read-only. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.Chart_Worksheet)] + Worksheet Worksheet { get; } + } + + /// + /// Encapsulates the format properties for the overall chart area. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IChartAreaFormat", InterfaceId = "8D3ACDD2-720E-4F0D-B318-8EAA58356A9F", CoClassName = "ChartAreaFormat")] + public interface ChartAreaFormat + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAreaFormat_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Represents the fill format of an object, which includes background formatting information. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAreaFormat_Fill)] + [JsonStringify()] + ChartFill Fill { get; } + + /// + /// Represents the font attributes (font name, font size, color, etc.) for the current object. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAreaFormat_Font)] + [JsonStringify()] + ChartFont Font { get; } + } + + /// + /// Represents a collection of chart series. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IChartSeriesCollection", InterfaceId = "6FC3E0B3-4A68-4EEE-A181-477EB069BAC1", CoClassName = "ChartSeriesCollection")] + public interface ChartSeriesCollection : IEnumerable + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartSeriesCollection_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Returns the number of series in the collection. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartSeriesCollection_Count)] + int Count { get; } + + /// + /// Add a new series to the collection. + /// + /// Name of the series. + /// Index value of the series to be added. Zero-indexed. + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartSeriesCollection_Add)] + ChartSeries Add([Optional] string name, [Optional] int? index); + + /// + /// Returns the number of series in the collection. + /// + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartSeriesCollection_GetCount)] + [ClientCallableOperation(OperationType = OperationType.Read)] + int GetCount(); + + /// + /// Retrieves a series based on its position in the collection.c + /// + /// Index value of the object to be retrieved. Zero-indexed. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartSeriesCollection_ItemAt)] + [ClientCallableOperation(OperationType = OperationType.Read)] + ChartSeries GetItemAt(int index); + + + } + + /// + /// Represents a series in a chart. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IChartSeries", InterfaceId = "54454749-3FDB-401D-B5E6-6667F7F80F11", CoClassName = "ChartSeries")] + public interface ChartSeries + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartSeries_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Represents the formatting of a chart series, which includes fill and line formatting. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartSeries_Format)] + [JsonStringify()] + ChartSeriesFormat Format { get; } + + /// + /// Represents the name of a series in a chart. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartSeries_Name)] + string Name { get; set; } + + /// + /// Represents a collection of all points in the series. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartSeries_Points)] + ChartPointsCollection Points { get; } + + /// + /// Represents a collection of Trendlines in the series. Read-only. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartSeries_Trendlines)] + ChartTrendlineCollection Trendlines { get; } + + /// + /// Deletes the chart series. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartSeries_Delete)] + void Delete(); + + /// + /// Set values of X axis for a chart series. Only works for scatter charts. + /// + /// The Range object corresponding to the source data. + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartSeries_SetXAxisValues)] + void SetXAxisValues([TypeScriptType("Excel.Range")]object sourceData); + + /// + /// Set values for a chart series. For scatter chart, it means Y axis values. + /// + /// The Range object corresponding to the source data. + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartSeries_SetValues)] + void SetValues([TypeScriptType("Excel.Range")]object sourceData); + + /// + /// Set bubble sizes for a chart series. Only works for bubble charts. + /// + /// The Range object corresponding to the source data. + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartSeries_SetBubbleSizes)] + void SetBubbleSizes([TypeScriptType("Excel.Range")]object sourceData); + } + + /// + /// encapsulates the format properties for the chart series + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IChartSeriesFormat", InterfaceId = "1D3D150E-E2B2-498C-B53C-57F55E9C6CF6", CoClassName = "ChartSeriesFormat")] + public interface ChartSeriesFormat + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartSeriesFormat_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Represents the fill format of a chart series, which includes background formating information. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartSeriesFormat_Fill)] + [JsonStringify()] + ChartFill Fill { get; } + + /// + /// Represents line formatting. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartSeriesFormat_Line)] + [JsonStringify()] + ChartLineFormat Line { get; } + } + + /// + /// A collection of all the chart points within a series inside a chart. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IChartPointsCollection", InterfaceId = "1BDB22BF-3690-4E75-9406-1BF54DB0A127", CoClassName = "ChartPointsCollection")] + public interface ChartPointsCollection : IEnumerable + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartPointsCollection_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Returns the number of chart points in the series. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartPointsCollection_Count)] + int Count { get; } + + /// + /// Returns the number of chart points in the series. + /// + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartPointsCollection_GetCount)] + [ClientCallableOperation(OperationType = OperationType.Read)] + int GetCount(); + + /// + /// Retrieve a point based on its position within the series. + /// + /// Index value of the object to be retrieved. Zero-indexed. + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartPointsCollection_ItemAt)] + [ClientCallableOperation(OperationType = OperationType.Read)] + ChartPoint GetItemAt(int index); + + + } + + /// + /// Represents a point of a series in a chart. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IChartPoint", InterfaceId = "76E71D2A-FB56-4CC8-9375-AFA5C1052E9C", CoClassName = "ChartPoint")] + public interface ChartPoint + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartPoint_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Encapsulates the format properties chart point. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartPoint_Format)] + [JsonStringify()] + ChartPointFormat Format { get; } + + /// + /// Returns the value of a chart point. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartPoint_Value)] + object Value { get; } + } + + /// + /// Represents formatting object for chart points. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IChartPointFormat", InterfaceId = "D907B031-B51A-4CE6-B903-004554FBD2D2", CoClassName = "ChartPointFormat")] + public interface ChartPointFormat + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartPointFormat_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Represents the fill format of a chart, which includes background formating information. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAreaFormat_Fill)] + [JsonStringify()] + ChartFill Fill { get; } + + /// + /// Represents the border format of a chart point, which includes border formating information. Read-only + /// + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartPointFormat_Border)] + ChartBorder Border { get; } + } + + /// + /// Represents the chart axes. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IChartAxes", InterfaceId = "a1635994-4bf2-4358-9a13-924c8ebf53aa", CoClassName = "ChartAxes")] + public interface ChartAxes + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxes_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Represents the category axis in a chart. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxes_Category)] + [JsonStringify()] + ChartAxis CategoryAxis { get; } + + /// + /// Represents the series axis of a 3-dimensional chart. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxes_Series)] + [JsonStringify()] + ChartAxis SeriesAxis { get; } + + /// + /// Represents the value axis in an axis. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxes_Value)] + [JsonStringify()] + ChartAxis ValueAxis { get; } + } + + /// + /// Represents a single axis in a chart. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IChartAxis", InterfaceId = "f6beb340-c24b-4087-8127-521e79dc326a", CoClassName = "ChartAxis")] + public interface ChartAxis + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxis_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Represents the formatting of a chart object, which includes line and font formatting. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxis_Format)] + [JsonStringify()] + ChartAxisFormat Format { get; } + + /// + /// Returns a gridlines object that represents the major gridlines for the specified axis. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxis_MajorGridlines)] + [JsonStringify()] + ChartGridlines MajorGridlines { get; } + + /// + /// 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. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxis_MajorUnit)] + object MajorUnit { get; set; } + + /// + /// 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. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxis_Maximum)] + object Maximum { get; set; } + + /// + /// 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. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxis_Minimum)] + object Minimum { get; set; } + + /// + /// Returns a Gridlines object that represents the minor gridlines for the specified axis. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxis_MinorGridlines)] + [JsonStringify()] + ChartGridlines MinorGridlines { get; } + + /// + /// 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. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxis_MinorUnit)] + object MinorUnit { get; set; } + + /// + /// Represents the axis title. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxis_Title)] + [JsonStringify()] + ChartAxisTitle Title { get; } + + /// + /// Represents the axis display unit. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxis_DisplayUnit)] + ChartAxisDisplayUnit DisplayUnit { get; set; } + + /// + /// Represents whether the axis display unit label is visible. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxis_ShowDisplayUnitLabel)] + bool ShowDisplayUnitLabel { get; set; } + + /// + /// Represents the custom axis display unit value. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxis_CustomDisplayUnit)] + double CustomDisplayUnit { get; set; } + + + /// + /// Represents the axis type. Read-only. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDcispatchIds.ChartAxis_Type)] + AxisType Type { get; } + + /// + /// Returns or sets the major unit scale value for the category axis when the CategoryType property is set to TimeScale. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxis_MajorUnitScale)] + XlTimeUnit MajorUnitScale { get; set; } + + /// + /// Returns or sets the minor unit scale value for the category axis when the CategoryType property is set to TimeScale. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxis_MinorUnitScale)] + XlTimeUnit MinorUnitScale { get; set; } + + /// + /// Returns or sets the base unit for the specified category axis. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxis_BaseUnit)] + XlTimeUnit BaseUnit { get; set; } + + /// + /// Returns or sets all the category names for the specified axis, as a text array. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxis_CategoryNames)] + string[] CategoryNames { get; set; } + + /// + /// Returns or sets the category axis type. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxis_CategoryType)] + XlCategoryType CategoryType { get; set; } + } + + /// + /// Encapsulates the format properties for the chart axis. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IChartAxisFormat", InterfaceId = "3ECEE01A-4340-4F99-82AB-EF9B65646F30", CoClassName = "ChartAxisFormat")] + public interface ChartAxisFormat + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxisFormat_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Represents the font attributes (font name, font size, color, etc.) for a chart axis element. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxisFormat_Font)] + [JsonStringify()] + ChartFont Font { get; } + + /// + /// Represents chart line formatting. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxisFormat_Line)] + [JsonStringify()] + ChartLineFormat Line { get; } + } + + /// + /// Represents the title of a chart axis. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IChartAxisTitle", InterfaceId = "ecedd0b6-a619-46f1-bf98-09c97aadd9df", CoClassName = "ChartAxisTitle")] + public interface ChartAxisTitle + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxisTitle_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Represents the formatting of chart axis title. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxisTitle_Format)] + [JsonStringify()] + ChartAxisTitleFormat Format { get; } + + /// + /// Represents the axis title. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxisTitle_Text)] + string Text { get; set; } + + /// + /// A boolean that specifies the visibility of an axis title. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxisTitle_Visible)] + bool Visible { get; set; } + } + + /// + /// Represents the chart axis title formatting. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IChartAxisTitleFormat", InterfaceId = "4CE21BA4-E4C0-4F10-A968-61AFFE7C372F", CoClassName = "ChartAxisTitleFormat")] + public interface ChartAxisTitleFormat + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxisTitleFormat_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Represents the font attributes, such as font name, font size, color, etc. of chart axis title object. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartAxisTitleFormat_Font)] + [JsonStringify()] + ChartFont Font { get; } + } + + /// + /// Represents a collection of all the data labels on a chart point. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IChartDataLabels", InterfaceId = "9fe05b7b-dd28-489d-aab5-7497e4d5c346", CoClassName = "ChartDataLabels")] + public interface ChartDataLabels + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartDataLabels_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Represents the format of chart data labels, which includes fill and font formatting. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartDataLabels_Format)] + [JsonStringify()] + ChartDataLabelFormat Format { get; } + + /// + /// DataLabelPosition value that represents the position of the data label. See Excel.ChartDataLabelPosition for details. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartDataLabels_Position)] + ChartDataLabelPosition? Position { get; set; } + + /// + /// Boolean value representing if the data label value is visible or not. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartDataLabels_ShowValue)] + bool? ShowValue { get; set; } + + /// + /// Boolean value representing if the data label series name is visible or not. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartDataLabels_ShowSeriesName)] + bool? ShowSeriesName { get; set; } + + /// + /// Boolean value representing if the data label category name is visible or not. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartDataLabels_ShowCategoryName)] + bool? ShowCategoryName { get; set; } + + /// + /// Boolean value representing if the data label legend key is visible or not. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartDataLabels_ShowLegendKey)] + bool? ShowLegendKey { get; set; } + + /// + /// Boolean value representing if the data label percentage is visible or not. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartDataLabels_ShowPercentage)] + bool? ShowPercentage { get; set; } + + /// + /// Boolean value representing if the data label bubble size is visible or not. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartDataLabels_ShowBubbleSize)] + bool? ShowBubbleSize { get; set; } + + /// + /// String representing the separator used for the data labels on a chart. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartDataLabels_Separator)] + string Separator { get; set; } + } + + /// + /// Encapsulates the format properties for the chart data labels. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IChartDataLabelFormat", InterfaceId = "B2BD0519-4F5B-43AC-9584-AD507172CC6F", CoClassName = "ChartDataLabelFormat")] + public interface ChartDataLabelFormat + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartDataLabelFormat_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Represents the font attributes (font name, font size, color, etc.) for a chart data label. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartDataLabelFormat_Font)] + [JsonStringify()] + ChartFont Font { get; } + + /// + /// Represents the fill format of the current chart data label. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartDataLabelFormat_Fill)] + [JsonStringify()] + ChartFill Fill { get; } + } + + /// + /// Represents major or minor gridlines on a chart axis. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IChartGridlines", InterfaceId = "7af19b5b-5665-4759-a78e-397318ff75e2", CoClassName = "ChartGridlines")] + public interface ChartGridlines + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartGridlines_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Boolean value representing if the axis gridlines are visible or not. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartGridlines_Visible)] + bool Visible { get; set; } + + /// + /// Represents the formatting of chart gridlines. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartGridlines_Format)] + [JsonStringify()] + ChartGridlinesFormat Format { get; } + } + + + /// + /// Encapsulates the format properties for chart gridlines. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IChartGridlinesFormat", InterfaceId = "DD906913-5D3B-4AC1-88ED-3F2DBC98CB04", CoClassName = "ChartGridlinesFormat")] + public interface ChartGridlinesFormat + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartGridlinesFormat_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Represents chart line formatting. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartGridlinesFormat_Line)] + [JsonStringify()] + ChartLineFormat Line { get; } + } + + /// + /// Represents the legend in a chart. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IChartLegend", InterfaceId = "a5c915bf-d752-4b33-95e0-5f84c6e9a46a", CoClassName = "ChartLegend")] + public interface ChartLegend + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartLegend_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Represents the formatting of a chart legend, which includes fill and font formatting. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartLegend_Format)] + [JsonStringify()] + ChartLegendFormat Format { get; } + + /// + /// A boolean value the represents the visibility of a ChartLegend object. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartLegend_Visible)] + bool Visible { get; set; } + + /// + /// Represents the position of the legend on the chart. See Excel.ChartLegendPosition for details. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartLegend_Position)] + ChartLegendPosition? Position { get; set; } + + /// + /// Boolean value for whether the chart legend should overlap with the main body of the chart. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartLegend_Overlay)] + bool? Overlay { get; set; } + } + + /// + /// Encapsulates the format properties of a chart legend. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IChartLegendFormat", InterfaceId = "B2BD0519-4F5B-43AC-9584-AD507172CC6F", CoClassName = "ChartLegendFormat")] + public interface ChartLegendFormat + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartLegendFormat_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Represents the font attributes such as font name, font size, color, etc. of a chart legend. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartLegendFormat_Font)] + [JsonStringify()] + ChartFont Font { get; } + + /// + /// Represents the fill format of an object, which includes background formating information. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartLegendFormat_Fill)] + [JsonStringify()] + ChartFill Fill { get; } + } + + /// + /// Represents a chart title object of a chart. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IChartTitle", InterfaceId = "953ac91f-9c3a-480c-bdec-15d446ad0b82", CoClassName = "ChartTitle")] + public interface ChartTitle + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartTitle_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Represents the formatting of a chart title, which includes fill and font formatting. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartTitle_Format)] + [JsonStringify()] + ChartTitleFormat Format { get; } + + /// + /// Boolean value representing if the chart title will overlay the chart or not. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartTitle_Overlay)] + bool? Overlay { get; set; } + + /// + /// Represents the title text of a chart. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartTitle_Text)] + string Text { get; set; } + + /// + /// A boolean value the represents the visibility of a chart title object. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartTitle_Visible)] + bool Visible { get; set; } + + /// + /// Get the characters of a chart title. Line break '\n' also counts one charater. + /// + /// The start index of the sub string + /// The length of the sub string + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartTitle_GetSubstring)] + [ClientCallableOperation(OperationType = OperationType.Read)] + ChartFormatString GetSubstring(int start, int length); + + /// + /// Represents the horizontal alignment for chart title. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartTitle_HorizontalAlignment)] + ChartTextHorizontalAlignment? HorizontalAlignment { get; set; } + } + + /// + /// Represents the characters in chart object like chart title, chart axis title, etc. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComType(Name = "IChartFormatString", InterfaceId = "B1AB4E90-1A7D-4BEF-897E-FEB990ABC4B7", CoClassName = "ChartFormatString")] + public interface ChartFormatString + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartFormatString_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Represents the font attributes, such as font name, font size, color, etc. of chart characters object. Read-only. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartFormatString_Font)] + ChartFont Font { get; } + } + + /// + /// Provides access to the office art formatting for chart title. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IChartTitleFormat", InterfaceId = "ACA6BCFA-EFDD-4B81-9478-B1508EC42CB9", CoClassName = "ChartTitleFormat")] + public interface ChartTitleFormat + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartTitleFormat_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Represents the font attributes (font name, font size, color, etc.) for an object. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartTitleFormat_Font)] + [JsonStringify()] + ChartFont Font { get; } + + /// + /// Represents the fill format of an object, which includes background formating information. Read-only. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartTitleFormat_Fill)] + [JsonStringify()] + ChartFill Fill { get; } + } + + /// + /// Represents the fill formatting for a chart element. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IChartFill", InterfaceId = "3147230c-d46d-40ea-b3d8-11970eb8a0af", CoClassName = "ChartFill")] + public interface ChartFill + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartFill_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Clear the fill color of a chart element. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartFill_Clear)] + void Clear(); + + /// + /// Sets the fill formatting of a chart element to a uniform color. + /// + /// HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartFill_SolidColor)] + void SetSolidColor(string color); + } + + /// + /// Represents the border formatting for a chart element. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComType(Name = "IChartBorder", InterfaceId = "acdf7ab0-69e6-4c93-9a52-74e16a42b36a", CoClassName="ChartBorder")] + public interface ChartBorder + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartBorder_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Clear the border color of a chart element. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartBorder_Clear)] + void Clear(); + + /// + /// Sets the border formatting of a chart element to a uniform color. + /// + /// HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartBorder_SolidColor)] + void SetSolidColor(string color); + } + + /// + /// Enapsulates the formatting options for line elements. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IChartLineFormat", InterfaceId = "0E0D5F3D-DB8D-46CC-B268-BA1D3D190A38", CoClassName = "ChartLineFormat")] + public interface ChartLineFormat + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartLineFormat_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Clear the line format of a chart element. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartLineFormat_Clear)] + void Clear(); + + /// + /// HTML color code representing the color of lines in the chart. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartLineFormat_Color)] + string Color { get; set; } + } + + /// + /// This object represents the font attributes (font name, font size, color, etc.) for a chart object. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComType(Name = "IChartFont", InterfaceId = "d62d7af0-54f2-4c16-9e0b-8d5a0ff611b2", CoClassName = "ChartFont")] + public interface ChartFont + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartFont_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Represents the bold status of font. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartFont_Bold)] + bool? Bold { get; set; } + + /// + /// HTML color code representation of the text color. E.g. #FF0000 represents Red. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartFont_Color)] + string Color { get; set; } + + /// + /// Represents the italic status of the font. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartFont_Italic)] + bool? Italic { get; set; } + + /// + /// Font name (e.g. "Calibri") + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartFont_Name)] + string Name { get; set; } + + /// + /// Size of the font (e.g. 11) + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartFont_Size)] + double? Size { get; set; } + + /// + /// Type of underline applied to the font. See Excel.ChartUnderlineStyle for details. + /// + [ApiSet(Version = 1.1)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartFont_Underline)] + ChartUnderlineStyle? Underline { get; set; } + } + + /// + /// This object represents the attributes for a chart trendline object. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComType(Name = "IChartTrendline", InterfaceId = "B0AB4E90-1A7D-4BEF-897E-FEB990ABC4B7", CoClassName = "ChartTrendline")] + public interface ChartTrendline + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartTrendline_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Represents the formatting of a chart trendline. Read-only. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartTrendline_Format)] + [JsonStringify()] + ChartTrendlineFormat Format { get; } + + /// + /// Represents the Type of a chart trendline. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartTrendline_Type)] + TrendlineType Type { get; set; } + + /// + /// Represents the PolynomialOrder of a chart trendline, specific for trendline with Polynomial type. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartTrendline_PolynomialOrder)] + int? PolynomialOrder { get; set; } + + /// + /// Represents the MovingAveragePeriod of a chart trendline, specific for trendline with MovingAverage type. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartTrendline_MovingAveragePeriod)] + int? MovingAveragePeriod { get; set; } + } + + /// + /// Represents a collection of Chart Trendlines. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComType(Name = "IChartTrendlineCollection", InterfaceId = "E8291097-2B13-414B-AC8D-5C2CD460BCEF", CoClassName = "ChartTrendlineCollection")] + public interface ChartTrendlineCollection : IEnumerable + { + /// + /// Returns the number of trendlines in the collection. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartTrendlineCollection_GetCount)] + [ClientCallableOperation(OperationType = OperationType.Read)] + int GetCount(); + + /// + /// Adds a new trendline to trendline collection. + /// + /// TrendlineType. + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartTrendlineCollection_Add)] + ChartTrendline Add([Optional] TrendlineType type); + + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartTrendlineCollection_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + } + + + /// + /// Encapsulates the format properties for chart trendline. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComType(Name = "IChartTrendlineFormat", InterfaceId = "DD906913-5D3B-4AC1-88ED-3F2DBC98CB03", CoClassName = "ChartTrendlineFormat")] + public interface ChartTrendlineFormat + { + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartTrendlineFormat_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Represents chart line formatting. Read-only. + /// + [ApiSet(Version = 1.9)] + [ClientCallableComMember(DispatchId = ChartDispatchIds.ChartTrendlineFormat_Line)] + [JsonStringify()] + ChartLineFormat Line { get; } + } + + #endregion Charts + +#region Sort + internal static class SortDispatchIds + { + internal const int RangeSort_Apply = 1; + internal const int RangeSort_OnAccess = 2; + + internal const int SortField_Key = 1; + internal const int SortField_SortOn = 2; + internal const int SortField_Ascending = 3; + internal const int SortField_Color = 4; + internal const int SortField_DataOption = 5; + internal const int SortField_Icon = 6; + + internal const int TableSort_Apply = 1; + internal const int TableSort_MatchCase = 2; + internal const int TableSort_Method = 3; + internal const int TableSort_OnAccess = 4; + internal const int TableSort_Clear = 5; + internal const int TableSort_Reapply = 6; + internal const int TableSort_Fields = 7; + } + + /// + /// Manages sorting operations on Range objects. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComType(Name = "IRangeSort", InterfaceId = "8D69987D-B7AD-4AF7-B297-529C21A39ACC", CoClassName = "RangeSort")] + public interface RangeSort + { + + [ClientCallableComMember(DispatchId = SortDispatchIds.RangeSort_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Perform a sort operation. + /// + /// The list of conditions to sort on. + /// Whether to have the casing impact string ordering. + /// Whether the range has a header. + /// Whether the operation is sorting rows or columns. + /// The ordering method used for Chinese characters. + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = SortDispatchIds.RangeSort_Apply)] + void Apply(SortField[] fields, [Optional] bool matchCase, [Optional] bool hasHeaders, [Optional] SortOrientation orientation, [Optional] SortMethod method); + } + + /// + /// Manages sorting operations on Table objects. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComType(Name = "ITableSort", InterfaceId = "2FA61C80-F2B7-46A2-8713-AD13E8C3DC4E", CoClassName = "TableSort")] + public interface TableSort + { + [ClientCallableComMember(DispatchId = SortDispatchIds.TableSort_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Perform a sort operation. + /// + /// The list of conditions to sort on. + /// Whether to have the casing impact string ordering. + /// The ordering method used for Chinese characters. + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = SortDispatchIds.TableSort_Apply)] + void Apply(SortField[] fields, [Optional] bool matchCase, [Optional] SortMethod method); + + /// + /// Represents whether the casing impacted the last sort of the table. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = SortDispatchIds.TableSort_MatchCase)] + bool MatchCase { get; } + + /// + /// Represents Chinese character ordering method last used to sort the table. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = SortDispatchIds.TableSort_Method)] + SortMethod Method { get; } + + /// + /// 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. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = SortDispatchIds.TableSort_Clear)] + void Clear(); + + /// + /// Reapplies the current sorting parameters to the table. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = SortDispatchIds.TableSort_Reapply)] + void Reapply(); + + /// + /// Represents the current conditions used to last sort the table. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = SortDispatchIds.TableSort_Fields)] + SortField[] Fields { get; } + } + + /// + /// Represents a condition in a sorting operation. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComType(Name = "ISortField", InterfaceId = "DFE7801F-F972-476C-A4ED-1E6E11D59148", CoClassName = "SortField", CoClassId = "9EB4FF82-6464-49F8-908A-A744F934AB17")] + public struct SortField + { + /// + /// Represents the column (or row, depending on the sort orientation) that the condition is on. Represented as an offset from the first column (or row). + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = SortDispatchIds.SortField_Key)] + int Key { get; set; } + + /// + /// Represents the type of sorting of this condition. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = SortDispatchIds.SortField_SortOn)] + [Optional] + SortOn SortOn { get; set; } + + /// + /// Represents whether the sorting is done in an ascending fashion. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = SortDispatchIds.SortField_Ascending)] + [Optional] + bool Ascending { get; set; } + + /// + /// Represents the color that is the target of the condition if the sorting is on font or cell color. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = SortDispatchIds.SortField_Color)] + [Optional] + string Color { get; set; } + + /// + /// Represents additional sorting options for this field. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = SortDispatchIds.SortField_DataOption)] + [Optional] + SortDataOption DataOption { get; set; } + + /// + /// Represents the icon that is the target of the condition if the sorting is on the cell's icon. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = SortDispatchIds.SortField_Icon)] + [Optional] + Icon Icon { get; set; } + } +#endregion Sort + +#region Filter + internal static class FilterDispatchIds + { + internal const int Filter_Apply = 1; + internal const int Filter_OnAccess = 2; + internal const int Filter_Clear = 3; + internal const int Filter_Criteria = 4; + internal const int Filter_BottomItems = 5; + internal const int Filter_BottomPercent = 6; + internal const int Filter_CellColor = 7; + internal const int Filter_Dynamic = 8; + internal const int Filter_FontColor = 9; + internal const int Filter_Values = 10; + internal const int Filter_TopItems = 11; + internal const int Filter_TopPercent = 12; + internal const int Filter_Icon = 13; + internal const int Filter_Custom = 14; + + internal const int FilterCriteria_Criterion1 = 1; + internal const int FilterCriteria_Criterion2 = 2; + internal const int FilterCriteria_Color = 3; + internal const int FilterCriteria_Operator = 4; + internal const int FilterCriteria_Icon = 5; + internal const int FilterCriteria_DynamicCriteria = 6; + internal const int FilterCriteria_Values = 7; + internal const int FilterCriteria_FilterOn = 8; + + internal const int FilterDatetime_Date = 1; + internal const int FilterDatetime_Specificity = 2; + } + + /// + /// Manages the filtering of a table's column. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComType(Name = "IFilter", InterfaceId = "44E193B3-7AE0-4F97-9A63-D79033780ECF", CoClassName = "Filter")] + public interface Filter + { + [ClientCallableComMember(DispatchId = FilterDispatchIds.Filter_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Apply the given filter criteria on the given column. + /// + /// The criteria to apply. + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = FilterDispatchIds.Filter_Apply)] + void Apply(FilterCriteria criteria); + + /// + /// Apply a "Bottom Item" filter to the column for the given number of elements. + /// + /// The number of elements from the bottom to show. + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = FilterDispatchIds.Filter_BottomItems)] + void ApplyBottomItemsFilter(int count); + + /// + /// Apply a "Bottom Percent" filter to the column for the given percentage of elements. + /// + /// The percentage of elements from the bottom to show. + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = FilterDispatchIds.Filter_BottomPercent)] + void ApplyBottomPercentFilter(int percent); + + /// + /// Apply a "Cell Color" filter to the column for the given color. + /// + /// The background color of the cells to show. + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = FilterDispatchIds.Filter_CellColor)] + void ApplyCellColorFilter(string color); + + /// + /// Apply a "Dynamic" filter to the column. + /// + /// The dynamic criteria to apply. + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = FilterDispatchIds.Filter_Dynamic)] + void ApplyDynamicFilter(DynamicFilterCriteria criteria); + + /// + /// Apply a "Font Color" filter to the column for the given color. + /// + /// The font color of the cells to show. + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = FilterDispatchIds.Filter_FontColor)] + void ApplyFontColorFilter(string color); + + /// + /// Apply a "Values" filter to the column for the given values. + /// + /// The list of values to show. + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = FilterDispatchIds.Filter_Values)] + void ApplyValuesFilter(object[] values); + + /// + /// Apply a "Top Item" filter to the column for the given number of elements. + /// + /// The number of elements from the top to show. + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = FilterDispatchIds.Filter_TopItems)] + void ApplyTopItemsFilter(int count); + + /// + /// Apply a "Top Percent" filter to the column for the given percentage of elements. + /// + /// The percentage of elements from the top to show. + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = FilterDispatchIds.Filter_TopPercent)] + void ApplyTopPercentFilter(int percent); + + /// + /// Apply a "Icon" filter to the column for the given icon. + /// + /// The icons of the cells to show. + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = FilterDispatchIds.Filter_Icon)] + void ApplyIconFilter(Icon icon); + + /// + /// Apply a "Icon" filter to the column for the given criteria strings. + /// + /// The first criteria string. + /// The second criteria string. + /// The operator that describes how the two criteria are joined. + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = FilterDispatchIds.Filter_Custom)] + void ApplyCustomFilter(string criteria1, [Optional]string criteria2, [Optional]FilterOperator oper); + + /// + /// Clear the filter on the given column. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = FilterDispatchIds.Filter_Clear)] + void Clear(); + + /// + /// The currently applied filter on the given column. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = FilterDispatchIds.Filter_Criteria)] + [JsonStringify()] + FilterCriteria Criteria { get; } + } + + /// + /// Represents the filtering criteria applied to a column. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComType(Name = "IFilterCriteria", InterfaceId = "BB994BE3-DDDA-4497-9906-8D22855491E8", CoClassName = "FilterCriteria", CoClassId = "9B468C31-9E41-467C-9E5F-24F20B7CB729")] + public struct FilterCriteria + { + /// + /// The first criterion used to filter data. Used as an operator in the case of "custom" filtering. + /// For example ">50" for number 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" + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = FilterDispatchIds.FilterCriteria_Criterion1)] + [Optional] + string Criterion1 { get; set; } + + /// + /// The second criterion used to filter data. Only used as an operator in the case of "custom" filtering. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = FilterDispatchIds.FilterCriteria_Criterion2)] + [Optional] + string Criterion2 { get; set; } + + /// + /// The HTML color string used to filter cells. Used with "cellColor" and "fontColor" filtering. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = FilterDispatchIds.FilterCriteria_Color)] + [Optional] + string Color { get; set; } + + /// + /// The operator used to combine criterion 1 and 2 when using "custom" filtering. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = FilterDispatchIds.FilterCriteria_Operator)] + [Optional] + FilterOperator Operator { get; set; } + + /// + /// The icon used to filter cells. Used with "icon" filtering. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = FilterDispatchIds.FilterCriteria_Icon)] + [Optional] + Icon Icon { get; set; } + + /// + /// The dynamic criteria from the Excel.DynamicFilterCriteria set to apply on this column. Used with "dynamic" filtering. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = FilterDispatchIds.FilterCriteria_DynamicCriteria)] + [Optional] + DynamicFilterCriteria DynamicCriteria { get; set; } + + /// + /// The set of values to be used as part of "values" filtering. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = FilterDispatchIds.FilterCriteria_Values)] + [Optional] + [TypeScriptType("Array")] + [KnownType(typeof(FilterDatetime))] + object[] Values { get; set; } + + /// + /// The property used by the filter to determine whether the values should stay visible. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = FilterDispatchIds.FilterCriteria_FilterOn)] + FilterOn FilterOn { get; set; } + } + + /// + /// Represents how to filter a date when filtering on values. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComType(Name = "IFilterDatetime", InterfaceId = "2F73B0F2-4627-4622-8494-640AF24FB44B", CoClassName = "FilterDatetime", CoClassId = "FFAB0D93-6B73-4F3F-8974-4932D35736E2")] + public struct FilterDatetime + { + /// + /// The date in ISO8601 format used to filter data. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = FilterDispatchIds.FilterDatetime_Date)] + string Date { get; set; } + + /// + /// 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 2009. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = FilterDispatchIds.FilterDatetime_Specificity)] + FilterDatetimeSpecificity Specificity { get; set; } + } + + #endregion Filter + +#region Images + internal static class ImagesDispatchIds + { + internal const int Icon_Set = 1; + internal const int Icon_Index = 2; + } + + /// + /// Represents a cell icon. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComType(Name = "IIcon", InterfaceId = "4FFBA2EE-8527-449C-9C81-739E2795182E", CoClassName = "Icon", CoClassId = "BB897B2C-9B30-4FCA-96B1-E7FFC576FC48")] + public struct Icon + { + /// + /// Represents the set that the icon is part of. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = ImagesDispatchIds.Icon_Set)] + IconSet Set { get; set; } + + /// + /// Represents the index of the icon in the given set. + /// + [ApiSet(Version = 1.2)] + [ClientCallableComMember(DispatchId = ImagesDispatchIds.Icon_Index)] + int Index { get; set; } + } +#endregion Images + +#region Custom XML Parts + internal static class CustomXmlDispatchIds + { + internal const int CustomXmlPart_OnAccess = 1; + internal const int CustomXmlPart_Delete = 2; + internal const int CustomXmlPart_Id = 3; + internal const int CustomXmlPart_NamespaceUri = 4; + internal const int CustomXmlPart_GetXml = 5; + internal const int CustomXmlPart_SetXml = 6; + internal const int CustomXmlPart_InsertElement = 7; + internal const int CustomXmlPart_UpdateElement = 8; + internal const int CustomXmlPart_DeleteElement = 9; + internal const int CustomXmlPart_Query = 10; + internal const int CustomXmlPart_InsertAttribute = 11; + internal const int CustomXmlPart_UpdateAttribute = 12; + internal const int CustomXmlPart_DeleteAttribute = 13; + + internal const int CustomXmlPartCollection_OnAccess = 1; + internal const int CustomXmlPartCollection_Indexer = 2; + internal const int CustomXmlPartCollection_Add = 3; + internal const int CustomXmlPartCollection_GetByNamespace = 4; + internal const int CustomXmlPartCollection_GetCount = 5; + internal const int CustomXmlPartCollection_GetItemOrNullObject = 6; + + internal const int CustomXmlPartScopedCollection_OnAccess = 1; + internal const int CustomXmlPartScopedCollection_Indexer = 2; + internal const int CustomXmlPartScopedCollection_GetCount = 3; + internal const int CustomXmlPartScopedCollection_GetItemOrNullObject = 4; + internal const int CustomXmlPartScopedCollection_GetOnlyItem = 5; + internal const int CustomXmlPartScopedCollection_GetOnlyItemOrNullObject = 6; + } + + /// + /// 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. + /// + [ApiSet(Version = 1.5)] + [ClientCallableType(UseItemAsIndexerNameInODataId = true)] + [ClientCallableComType(Name = "ICustomXmlPartScopedCollection", InterfaceId = "2C27E984-EF91-4F48-9A4C-BC96DEF777CE", CoClassName = "CustomXmlPartScopedCollection", SupportEnumeration = true)] + public interface CustomXmlPartScopedCollection : IEnumerable + { + [ClientCallableComMember(DispatchId = CustomXmlDispatchIds.CustomXmlPartScopedCollection_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Gets a custom XML part based on its ID. + /// + /// ID of the object to be retrieved. + [ApiSet(Version = 1.5)] + [ClientCallableComMember(DispatchId = CustomXmlDispatchIds.CustomXmlPartScopedCollection_Indexer)] + CustomXmlPart this[string id] { get; } + + /// + /// Gets the number of CustomXML parts in this collection. + /// + [ApiSet(Version = 1.5)] + [ClientCallableComMember(DispatchId = CustomXmlDispatchIds.CustomXmlPartScopedCollection_GetCount)] + [ClientCallableOperation(OperationType = OperationType.Read)] + int GetCount(); + + /// + /// Gets a custom XML part based on its ID. + /// If the CustomXmlPart does not exist, the return object's isNull property will be true. + /// + /// ID of the object to be retrieved. + [ApiSet(Version = 1.5)] + [ClientCallableComMember(DispatchId = CustomXmlDispatchIds.CustomXmlPartScopedCollection_GetItemOrNullObject)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "")] + CustomXmlPart GetItemOrNullObject(string id); + + /// + /// If the collection contains exactly one item, this method returns it. + /// Otherwise, this method produces an error. + /// + [ApiSet(Version = 1.5)] + [ClientCallableComMember(DispatchId = CustomXmlDispatchIds.CustomXmlPartScopedCollection_GetOnlyItem)] + [ClientCallableOperation(OperationType = OperationType.Read)] + CustomXmlPart GetOnlyItem(); + + /// + /// If the collection contains exactly one item, this method returns it. + /// Otherwise, this method returns Null. + /// + [ApiSet(Version = 1.5)] + [ClientCallableComMember(DispatchId = CustomXmlDispatchIds.CustomXmlPartScopedCollection_GetOnlyItemOrNullObject)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "")] + CustomXmlPart GetOnlyItemOrNullObject(); + } + + /// + /// A collection of custom XML parts. + /// + [ApiSet(Version = 1.5)] + [ClientCallableComType(Name = "ICustomXmlPartCollection", InterfaceId = "BD3EE512-94FF-4981-9C3A-18F379FAEE41", CoClassName = "CustomXmlPartCollection", SupportEnumeration = true)] + public interface CustomXmlPartCollection : IEnumerable + { + [ClientCallableComMember(DispatchId = CustomXmlDispatchIds.CustomXmlPartCollection_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Gets a custom XML part based on its ID. + /// + /// ID of the object to be retrieved. + [ApiSet(Version = 1.5)] + [ClientCallableComMember(DispatchId = CustomXmlDispatchIds.CustomXmlPartCollection_Indexer)] + CustomXmlPart this[string id] { get; } + + /// + /// Adds a new custom XML part to the workbook. + /// + /// XML content. Must be a valid XML fragment. + [ApiSet(Version = 1.5)] + [ClientCallableComMember(DispatchId = CustomXmlDispatchIds.CustomXmlPartCollection_Add)] + CustomXmlPart Add(string xml); + + /// + /// Gets a new scoped collection of custom XML parts whose namespaces match the given namespace. + /// + /// + [ApiSet(Version = 1.5)] + [ClientCallableComMember(DispatchId = CustomXmlDispatchIds.CustomXmlPartCollection_GetByNamespace)] + [ClientCallableOperation(OperationType = OperationType.Read)] + CustomXmlPartScopedCollection GetByNamespace(string namespaceUri); + + /// + /// Gets the number of CustomXml parts in the collection. + /// + [ApiSet(Version = 1.5)] + [ClientCallableComMember(DispatchId = CustomXmlDispatchIds.CustomXmlPartCollection_GetCount)] + [ClientCallableOperation(OperationType = OperationType.Read)] + int GetCount(); + + /// + /// Gets a custom XML part based on its ID. + /// If the CustomXmlPart does not exist, the return object's isNull property will be true. + /// + /// ID of the object to be retrieved. + [ApiSet(Version = 1.5)] + [ClientCallableComMember(DispatchId = CustomXmlDispatchIds.CustomXmlPartCollection_GetItemOrNullObject)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "")] + CustomXmlPart GetItemOrNullObject(string id); + } + + /// + /// Represents a custom XML part object in a workbook. + /// + [ApiSet(Version = 1.5)] + [ClientCallableType(DeleteOperationName = "Delete")] + [ClientCallableComType(Name = "ICustomXmlPart", InterfaceId = "2694275E-2EA7-40C8-B98A-EF84C5E22580", CoClassName = "CustomXmlPart")] + public interface CustomXmlPart + { + [ClientCallableComMember(DispatchId = CustomXmlDispatchIds.CustomXmlPart_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Deletes the custom XML part. + /// + [ClientCallableComMember(DispatchId = CustomXmlDispatchIds.CustomXmlPart_Delete)] + [ApiSet(Version = 1.5)] + void Delete(); + + /// + /// The custom XML part's ID. Read-only. + /// + [ClientCallableComMember(DispatchId = CustomXmlDispatchIds.CustomXmlPart_Id)] + [ApiSet(Version = 1.5)] + string Id { get; } + + /// + /// The custom XML part's namespace URI. Read-only. + /// + [ClientCallableComMember(DispatchId = CustomXmlDispatchIds.CustomXmlPart_NamespaceUri)] + [ApiSet(Version = 1.5)] + string NamespaceUri { get; } + + /// + /// Gets the custom XML part's full XML content. + /// + [ClientCallableComMember(DispatchId = CustomXmlDispatchIds.CustomXmlPart_GetXml)] + [ClientCallableOperation(OperationType = OperationType.Read)] + [ApiSet(Version = 1.5)] + string GetXml(); + + /// + /// Sets the custom XML part's full XML content. + /// + /// XML content for the part. + [ClientCallableComMember(DispatchId = CustomXmlDispatchIds.CustomXmlPart_SetXml)] + [ApiSet(Version = 1.5)] + void SetXml(string xml); + + } + #endregion + + #region PivotTable + internal static class PivotTableDispatchIds + { + internal const int PivotTable_OnAccess = 1; + internal const int PivotTable_Name = 2; + internal const int PivotTable_Refresh = 3; + internal const int PivotTable_Worksheet = 4; + internal const int PivotTable_Id = 5; + + internal const int PivotTableCollection_OnAccess = 1; + internal const int PivotTableCollection_Indexer = 2; + internal const int PivotTableCollection_GetItemOrNullObject = 3; + internal const int PivotTableCollection_RefreshAll = 4; + internal const int PivotTableCollection_GetCount = 5; + } + + /// + /// Represents a collection of all the PivotTables that are part of the workbook or worksheet. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComType(Name = "IPivotTableCollection", InterfaceId = "96495551-83E1-4F20-8B30-EEF756BB1F8D", CoClassName = "PivotTableCollection", SupportEnumeration = true, ExtensibleObject = true)] + public interface PivotTableCollection : IEnumerable + { + [ClientCallableComMember(DispatchId = PivotTableDispatchIds.PivotTableCollection_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Gets a PivotTable by name. + /// + /// Name of the PivotTable to be retrieved. + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = PivotTableDispatchIds.PivotTableCollection_Indexer)] + + PivotTable this[string name] { get; } + /// + /// Gets a PivotTable by name. If the PivotTable does not exist, will return a null object. + /// + /// Name of the PivotTable to be retrieved. + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = PivotTableDispatchIds.PivotTableCollection_GetItemOrNullObject)] + [ClientCallableOperation(OperationType = OperationType.Read, RESTfulName = "")] + + PivotTable GetItemOrNullObject(string name); + /// + /// Refreshes all the pivot tables in the collection. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = PivotTableDispatchIds.PivotTableCollection_RefreshAll)] + void RefreshAll(); + + /// + /// Gets the number of pivot tables in the collection. + /// + [ApiSet(Version = 1.4)] + [ClientCallableComMember(DispatchId = PivotTableDispatchIds.PivotTableCollection_GetCount)] + [ClientCallableOperation(OperationType = OperationType.Read)] + int GetCount(); + } + + /// + /// Represents an Excel PivotTable. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComType(Name = "IPivotTable", InterfaceId = "1A57CB0A-F84A-4618-B0CC-75CB240CE106", CoClassName = "PivotTable", ExtensibleObject = true)] + public interface PivotTable + { + [ClientCallableComMember(DispatchId = PivotTableDispatchIds.PivotTable_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Id of the PivotTable. + /// + [ApiSet(Version = 1.5)] + [ClientCallableComMember(DispatchId = PivotTableDispatchIds.PivotTable_Id)] + string Id { get; } + + /// + /// Name of the PivotTable. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = PivotTableDispatchIds.PivotTable_Name)] + string Name { get; set; } + /// + /// Refreshes the PivotTable. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = PivotTableDispatchIds.PivotTable_Refresh)] + void Refresh(); + /// + /// The worksheet containing the current PivotTable. Read-only. + /// + [ApiSet(Version = 1.3)] + [ClientCallableComMember(DispatchId = PivotTableDispatchIds.PivotTable_Worksheet)] + Worksheet Worksheet { get; } + } +#endregion PivotTable + +#region Conditional Formats + internal static class ConditionalFormatDispatchIds + { + internal const int ConditionalFormat_Range = 1; + internal const int ConditionalFormat_Reverse = 2; + internal const int ConditionalFormat_StopIfTrue = 3; + internal const int ConditionalFormat_Priority = 4; + internal const int ConditionalFormat_Type = 5; + internal const int ConditionalFormat_DataBarOrNullObject = 6; + internal const int ConditionalFormat_DataBar = 7; + internal const int ConditionalFormat_CustomOrNullObject = 8; + internal const int ConditionalFormat_Custom = 9; + internal const int ConditionalFormat_Delete = 10; + internal const int ConditionalFormat_OnAccess = 11; + internal const int ConditionalFormat_RangeOrNull = 12; + internal const int ConditionalFormat_Icon = 13; + internal const int ConditionalFormat_IconOrNullObject = 14; + internal const int ConditionalFormat_ColorScale = 15; + internal const int ConditionalFormat_ColorScaleOrNullObject = 16; + internal const int ConditionalFormat_TopBottom = 17; + internal const int ConditionalFormat_TopBottomOrNullObject = 18; + internal const int ConditionalFormat_PresetCriteria = 19; + internal const int ConditionalFormat_PresetCriteriaOrNullObject = 20; + internal const int ConditionalFormat_Text = 21; + internal const int ConditionalFormat_TextOrNullObject = 22; + internal const int ConditionalFormat_CellValue = 23; + internal const int ConditionalFormat_CellValueOrNullObject = 24; + + internal const int ConditionalFormatCollection_GetCount = 1; + internal const int ConditionalFormatCollection_ItemAt = 2; + internal const int ConditionalFormatCollection_ClearAll = 3; + internal const int ConditionalFormatCollection_Add = 4; + internal const int ConditionalFormatCollection_OnAccess = 5; + + internal const int ConditionalFormatDataBar_ShowDataBarOnly = 1; + internal const int ConditionalFormatDataBar_BarDirection = 2; + internal const int ConditionalFormatDataBar_BorderColor = 3; + internal const int ConditionalFormatDataBar_AxisFormat = 4; + internal const int ConditionalFormatDataBar_AxisColor = 5; + internal const int ConditionalFormatDataBar_PositiveFormat = 6; + internal const int ConditionalFormatDataBar_NegativeFormat = 7; + internal const int ConditionalFormatDataBar_LowerBoundRule = 8; + internal const int ConditionalFormatDataBar_UpperBoundRule = 9; + internal const int ConditionalFormatDataBar_OnAccess = 10; + + internal const int ConditionalFormatDataBarPositiveFormat_Color = 1; + internal const int ConditionalFormatDataBarPositiveFormat_IsGradient = 2; + internal const int ConditionalFormatDataBarPositiveFormat_BorderColor = 3; + internal const int ConditionalFormatDataBarPositiveFormat_OnAccess = 4; + + internal const int ConditionalFormatDataBarNegativeFormat_Color = 1; + internal const int ConditionalFormatDataBarNegativeFormat_IsSameColor = 2; + internal const int ConditionalFormatDataBarNegativeFormat_BorderColor = 3; + internal const int ConditionalFormatDataBarNegativeFormat_IsSameBorderColor = 4; + internal const int ConditionalFormatDataBarNegativeFormat_OnAccess = 5; + + internal const int ConditionalFormatDataBarRule_Type = 1; + internal const int ConditionalFormatDataBarRule_Formula = 2; + internal const int ConditionalFormatDataBarRule_FormulaLocal = 3; + internal const int ConditionalFormatDataBarRule_FormulaR1C1 = 4; + + internal const int ConditionalRangeBorder_SideIndex = 1; + internal const int ConditionalRangeBorder_LineStyle = 2; + internal const int ConditionalRangeBorder_Color = 3; + internal const int ConditionalRangeBorder_OnAccess = 4; + internal const int ConditionalRangeBorder_Id = 5; + + internal const int ConditionalRangeBorderCollection_Indexer = 1; + internal const int ConditionalRangeBorderCollection_Count = 2; + internal const int ConditionalRangeBorderCollection_ItemAt = 3; + internal const int ConditionalRangeBorderCollection_OnAccess = 4; + internal const int ConditionalRangeBorderCollection_Top = 5; + internal const int ConditionalRangeBorderCollection_Bottom = 6; + internal const int ConditionalRangeBorderCollection_Left = 7; + internal const int ConditionalRangeBorderCollection_Right = 8; + + internal const int ConditionalRangeFill_Color = 1; + internal const int ConditionalRangeFill_Clear = 2; + internal const int ConditionalRangeFill_OnAccess = 3; + + internal const int ConditionalRangeFont_Color = 1; + internal const int ConditionalRangeFont_Italic = 2; + internal const int ConditionalRangeFont_Bold = 3; + internal const int ConditionalRangeFont_Underline = 4; + internal const int ConditionalRangeFont_OnAccess = 5; + internal const int ConditionalRangeFont_Strikethrough = 6; + internal const int ConditionalRangeFont_Clear = 7; + + internal const int ConditionalRangeFormat_Fill = 1; + internal const int ConditionalRangeFormat_Font = 2; + internal const int ConditionalRangeFormat_Borders = 3; + internal const int ConditionalRangeFormat_OnAccess = 4; + internal const int ConditionalRangeFormat_NumberFormat = 5; + + internal const int ConditionalFormatRule_Formula = 1; + internal const int ConditionalFormatRule_FormulaLocal = 2; + internal const int ConditionalFormatRule_FormulaR1C1 = 3; + internal const int ConditionalFormatRule_OnAccess = 4; + + internal const int ConditionalFormatCustom_Rule = 1; + internal const int ConditionalFormatCustom_OnAccess = 2; + internal const int ConditionalFormatCustom_Format = 3; + + internal const int ConditionalFormatIcon_ReverseIconOrder = 1; + internal const int ConditionalFormatIcon_ShowIconOnly = 2; + internal const int ConditionalFormatIcon_Style = 3; + internal const int ConditionalFormatIcon_Criterion = 4; + internal const int ConditionalFormatIcon_OnAccess = 5; + + internal const int ConditionalFormatIconCriterion_Type = 1; + internal const int ConditionalFormatIconCriterion_Formula = 2; + internal const int ConditionalFormatIconCriterion_Operator = 3; + internal const int ConditionalFormatIconCriterion_CustomIcon = 4; + + internal const int ConditionalFormatColorScale_OnAccess = 1; + internal const int ConditionalFormatColorScale_ThreeColorScale = 2; + internal const int ConditionalFormatColorScale_Criteria = 3; + + internal const int ConditionalFormatColorScaleCriteria_Minimum = 1; + internal const int ConditionalFormatColorScaleCriteria_Midpoint = 2; + internal const int ConditionalFormatColorScaleCriteria_Maximum = 3; + + internal const int ConditionalFormatColorScaleCriterion_Type = 1; + internal const int ConditionalFormatColorScaleCriterion_Formula = 2; + internal const int ConditionalFormatColorScaleCriterion_Color = 3; + + internal const int ConditionalFormatTopBottom_OnAccess = 1; + internal const int ConditionalFormatTopBottom_Rule = 2; + internal const int ConditionalFormatTopBottom_Format = 3; + + internal const int ConditionalFormatTopBottomRule_Criteria = 1; + internal const int ConditionalFormatTopBottomRule_Rank = 2; + + internal const int ConditionalFormatPreset_OnAccess = 1; + internal const int ConditionalFormatPreset_Rule = 2; + internal const int ConditionalFormatPreset_Format = 3; + + internal const int ConditionalFormatPresetRule_Criteria = 1; + + internal const int ConditionalFormatText_OnAccess = 1; + internal const int ConditionalFormatText_Rule = 2; + internal const int ConditionalFormatText_Format = 3; + + internal const int ConditionalFormatTextRule_Operator = 1; + internal const int ConditionalFormatTextRule_Text = 2; + + internal const int ConditionalFormatCellValue_OnAccess = 1; + internal const int ConditionalFormatCellValue_Format = 2; + internal const int ConditionalFormatCellValue_Rule = 3; + + internal const int ConditionalFormatCellValueRule_Operator = 1; + internal const int ConditionalFormatCellValueRule_Formula1 = 2; + internal const int ConditionalFormatCellValueRule_Formula2 = 3; + } + + /// + /// Represents a collection of all the conditional formats that are overlap the range. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComType(Name = "IConditionalFormatCollection", InterfaceId = "34AF8E2C-34B7-4D06-9FF0-08DEB81C7F44", CoClassName = "ConditionalFormatCollection", SupportEnumeration = true)] + public interface ConditionalFormatCollection : IEnumerable + { + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatCollection_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Returns a conditional format at the given index. + /// + /// Index of the conditional formats to be retrieved. + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatCollection_ItemAt)] + [ClientCallableOperation(OperationType = OperationType.Read)] + ConditionalFormat GetItemAt(int index); + + /// + /// Returns the number of conditional formats in the workbook. Read-only. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatCollection_GetCount)] + [ClientCallableOperation(OperationType = OperationType.Read)] + int GetCount(); + + /// + /// Clears all conditional formats active on the current specified range. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatCollection_ClearAll)] + void ClearAll(); + + /// + /// Adds a new conditional format to the collection at the first/top priority. + /// + /// The type of conditional format being added. See Excel.ConditionalFormatType for details. + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatCollection_Add)] + ConditionalFormat Add(ConditionalFormatType type); + } + + /// + /// An object encapsulating a conditional format's range, format, rule, and other properties. + /// + [ClientCallableComType(Name = "IConditionalFormat", InterfaceId = "FED46BE7-0681-4176-A45B-2053C49BC9A8", CoClassName = "ConditionalFormat")] + [ApiSet(Version = 1.6)] + public interface ConditionalFormat + { + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormat_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Returns the range the conditonal format is applied to or a null object if the range is discontiguous. Read-only. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormat_Range)] + [ClientCallableOperation(OperationType = OperationType.Read, InvalidateReturnObjectPathAfterRequest = true)] + Range GetRange(); + + /// + /// Returns the range the conditonal format is applied to or a null object if the range is discontiguous. Read-only. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormat_RangeOrNull)] + [ClientCallableOperation(OperationType = OperationType.Read, InvalidateReturnObjectPathAfterRequest = true, RESTfulName = "")] + Range GetRangeOrNullObject(); + + /// + /// If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell. + /// Null on databars, icon sets, and colorscales as there's no concept of StopIfTrue for these + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormat_StopIfTrue)] + bool? StopIfTrue { get; set; } + + /// + /// 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 than bounds will get and set to the maximum (or minimum if negative) priority. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormat_Priority)] + int Priority { get; set; } + + /// + /// A type of conditional format. Only one can be set at a time. Read-Only. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormat_Type)] + ConditionalFormatType Type { get; } + + /// + /// Returns the data bar properties if the current conditional format is a data bar. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormat_DataBar)] + [JsonStringify()] + DataBarConditionalFormat DataBar { get; } + + /// + /// Returns the data bar properties if the current conditional format is a data bar. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormat_DataBarOrNullObject)] + [JsonStringify()] + [ClientCallableProperty(ExcludedFromRest = true)] + DataBarConditionalFormat DataBarOrNullObject { get; } + + /// + /// Returns the custom conditional format properties if the current conditional format is a custom type. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormat_Custom)] + [JsonStringify()] + CustomConditionalFormat Custom { get; } + + /// + /// Returns the custom conditional format properties if the current conditional format is a custom type. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormat_CustomOrNullObject)] + [ClientCallableProperty(ExcludedFromRest = true)] + [JsonStringify()] + CustomConditionalFormat CustomOrNullObject { get; } + + /// + /// Returns the IconSet conditional format properties if the current conditional format is an IconSet type. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormat_Icon)] + [JsonStringify()] + IconSetConditionalFormat IconSet { get; } + + /// + /// Returns the IconSet conditional format properties if the current conditional format is an IconSet type. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormat_IconOrNullObject)] + [ClientCallableProperty(ExcludedFromRest = true)] + [JsonStringify()] + IconSetConditionalFormat IconSetOrNullObject { get; } + + /// + /// Returns the ColorScale conditional format properties if the current conditional format is an ColorScale type. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormat_ColorScale)] + [JsonStringify()] + ColorScaleConditionalFormat ColorScale { get; } + + /// + /// Returns the ColorScale conditional format properties if the current conditional format is an ColorScale type. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormat_ColorScaleOrNullObject)] + [ClientCallableProperty(ExcludedFromRest = true)] + [JsonStringify()] + ColorScaleConditionalFormat ColorScaleOrNullObject { get; } + + /// + /// Returns the Top/Bottom conditional format properties if the current conditional format is an TopBottom type. + /// For example to format the top 10% or bottom 10 items. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormat_TopBottom)] + [JsonStringify()] + TopBottomConditionalFormat TopBottom { get; } + + /// + /// Returns the Top/Bottom conditional format properties if the current conditional format is an TopBottom type. + /// For example to format the top 10% or bottom 10 items. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormat_TopBottomOrNullObject)] + [ClientCallableProperty(ExcludedFromRest = true)] + [JsonStringify()] + TopBottomConditionalFormat TopBottomOrNullObject { get; } + + /// + /// Returns the preset criteria conditional format such as above average/below average/unique values/contains blank/nonblank/error/noerror properties. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormat_PresetCriteria)] + [JsonStringify()] + PresetCriteriaConditionalFormat Preset { get; } + + /// + /// Returns the preset criteria conditional format such as above average/below average/unique values/contains blank/nonblank/error/noerror properties. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormat_PresetCriteriaOrNullObject)] + [ClientCallableProperty(ExcludedFromRest = true)] + [JsonStringify()] + PresetCriteriaConditionalFormat PresetOrNullObject { get; } + + /// + /// 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". + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormat_Text)] + [JsonStringify()] + TextConditionalFormat TextComparison { get; } + + /// + /// 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". + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormat_TextOrNullObject)] + [ClientCallableProperty(ExcludedFromRest = true)] + [JsonStringify()] + TextConditionalFormat TextComparisonOrNullObject { get; } + + /// + /// Returns the cell value conditional format properties if the current conditional format is a CellValue type. + /// For example to format all cells between 5 and 10. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormat_CellValue)] + [JsonStringify()] + CellValueConditionalFormat CellValue { get; } + + /// + /// Returns the cell value conditional format properties if the current conditional format is a CellValue type. + /// For example to format all cells between 5 and 10. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormat_CellValueOrNullObject)] + [ClientCallableProperty(ExcludedFromRest = true)] + [JsonStringify()] + CellValueConditionalFormat CellValueOrNullObject { get; } + + /// + /// Deletes this conditional format. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormat_Delete)] + void Delete(); + } + + /// + /// Represents an Excel Conditional Data Bar Type. + /// + [ClientCallableComType(Name = "IDataBarConditionalFormat", InterfaceId = "3378CAB4-80C2-448B-A896-A3BAC8887923", CoClassName = "DataBarConditionalFormat")] + [ApiSet(Version = 1.6)] + public interface DataBarConditionalFormat + { + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatDataBar_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// If true, hides the values from the cells where the data bar is applied. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatDataBar_ShowDataBarOnly)] + bool ShowDataBarOnly { get; set; } + + /// + /// Representation of how the axis is determined for an Excel data bar. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatDataBar_AxisFormat)] + ConditionalDataBarAxisFormat AxisFormat { get; set; } + + /// + /// HTML color code representing the color of the Axis line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). + /// "" (empty string) if no axis is present or set. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatDataBar_AxisColor)] + string AxisColor { get; set; } + + /// + /// Represents the direction that the data bar graphic should be based on. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatDataBar_BarDirection)] + ConditionalDataBarDirection BarDirection { get; set; } + + /// + /// Representation of all values to the right of the axis in an Excel data bar. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatDataBar_PositiveFormat)] + [JsonStringify()] + ConditionalDataBarPositiveFormat PositiveFormat { get; } + + /// + /// Representation of all values to the left of the axis in an Excel data bar. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatDataBar_NegativeFormat)] + [JsonStringify()] + ConditionalDataBarNegativeFormat NegativeFormat { get; } + + /// + /// The rule for what consistutes the lower bound (and how to calculate it, if applicable) for a data bar. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatDataBar_LowerBoundRule)] + [JsonStringify()] + ConditionalDataBarRule LowerBoundRule { get; set; } + + /// + /// The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatDataBar_UpperBoundRule)] + [JsonStringify()] + ConditionalDataBarRule UpperBoundRule { get; set; } + } + + /// + /// Represents a conditional format DataBar Format for the positive side of the data bar. + /// + [ClientCallableComType(Name = "IConditionalDataBarPositiveFormat", InterfaceId = "0702CE16-E69F-45E4-A08A-25C6558957BA", CoClassName = "ConditionalDataBarPositiveFormat")] + [ApiSet(Version = 1.6)] + public interface ConditionalDataBarPositiveFormat + { + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatDataBarPositiveFormat_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). + /// "" (empty string) if no border is present or set. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatDataBarPositiveFormat_BorderColor)] + string BorderColor { get; set; } + + /// + /// HTML color code representing the fill color, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatDataBarPositiveFormat_Color)] + string FillColor { get; set; } + + /// + /// Boolean representation of whether or not the DataBar has a gradient. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatDataBarPositiveFormat_IsGradient)] + bool GradientFill { get; set; } + } + + /// + /// Represents a conditional format DataBar Format for the negative side of the data bar. + /// + [ClientCallableComType(Name = "IConditionalDataBarNegativeFormat", InterfaceId = "631DC6F5-9973-45AD-829C-5339028C37C3", CoClassName = "ConditionalDataBarNegativeFormat")] + [ApiSet(Version = 1.6)] + public interface ConditionalDataBarNegativeFormat + { + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatDataBarNegativeFormat_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). + /// "Empty String" if no border is present or set. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatDataBarNegativeFormat_BorderColor)] + string BorderColor { get; set; } + + /// + /// Boolean representation of whether or not the negative DataBar has the same border color as the positive DataBar. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatDataBarNegativeFormat_IsSameBorderColor)] + bool MatchPositiveBorderColor { get; set; } + + /// + /// HTML color code representing the fill color, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatDataBarNegativeFormat_Color)] + string FillColor { get; set; } + + /// + /// Boolean representation of whether or not the negative DataBar has the same fill color as the positive DataBar. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatDataBarNegativeFormat_IsSameColor)] + bool MatchPositiveFillColor { get; set; } + } + + /// + /// Represents a rule-type for a Data Bar. + /// + [ClientCallableComType(Name = "IConditionalDataBarRule", InterfaceId = "DECA24F4-4C74-482A-978A-6CC56137A302", CoClassName = "ConditionalDataBarRule", CoClassId = "4CCC8780-5D06-4DD5-BD5D-834DE3AEC7F6")] + [ApiSet(Version = 1.6)] + public struct ConditionalDataBarRule + { + /// + /// The type of rule for the databar. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatDataBarRule_Type)] + ConditionalFormatRuleType Type { get; set; } + + /// + /// The formula, if required, to evaluate the databar rule on. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatDataBarRule_Formula)] + [TypeScriptType("string")] + [Optional] + object Formula { get; set; } + } + + /// + /// Represents a custom conditional format type. + /// + [ClientCallableComType(Name = "ICustomConditionalFormat", InterfaceId = "593C6A29-E4E4-4C0B-AE80-FA808764AB71", CoClassName = "CustomConditionalFormat")] + [ApiSet(Version = 1.6)] + public interface CustomConditionalFormat + { + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatCustom_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Represents the Rule object on this conditional format. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatCustom_Rule)] + [JsonStringify()] + ConditionalFormatRule Rule { get; } + + /// + /// Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatCustom_Format)] + [JsonStringify()] + ConditionalRangeFormat Format { get; } + } + + /// + /// Represents a rule, for all traditional rule/format pairings. + /// + [ClientCallableComType(Name = "IConditionalFormatRule", InterfaceId = "55EF76CF-A73F-465D-9F43-EDEE79B6AF95", CoClassName = "ConditionalFormatRule")] + [ApiSet(Version = 1.6)] + public interface ConditionalFormatRule + { + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatRule_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// The formula, if required, to evaluate the conditional format rule on. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatRule_Formula)] + [TypeScriptType("string")] + object Formula { get; set; } + + /// + /// The formula, if required, to evaluate the conditional format rule on in the user's language. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatRule_FormulaLocal)] + [TypeScriptType("string")] + object FormulaLocal { get; set; } + + /// + /// The formula, if required, to evaluate the conditional format rule on in R1C1-style notation. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatRule_FormulaR1C1)] + [TypeScriptType("string")] + object FormulaR1C1 { get; set; } + } + + /// + /// Represents an IconSet criteria for conditional formatting. + /// + [ClientCallableComType(Name = "IIconSetConditionalFormat", InterfaceId = "994D36C1-E273-43C3-9FCA-D8915C73DFE0", CoClassName = "IconSetConditionalFormat")] + [ApiSet(Version = 1.6)] + public interface IconSetConditionalFormat + { + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatIcon_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + /// + /// If true, reverses the icon orders for the IconSet. Note that this cannot be set if custom icons are used. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatIcon_ReverseIconOrder)] + bool ReverseIconOrder { get; set; } + + /// + /// If true, hides the values and only shows icons. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatIcon_ShowIconOnly)] + bool ShowIconOnly { get; set; } + + /// + /// If set, displays the IconSet option for the conditional format. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatIcon_Style)] + IconSet Style { get; set; } + + /// + /// An array of Criteria and IconSets 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. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatIcon_Criterion)] + [JsonStringify()] + ConditionalIconCriterion[] Criteria { get; set; } + } + + /// + /// Represents an Icon Criterion which contains a type, value, an Operator, and an optional custom icon, if not using an iconset. + /// + [ClientCallableComType(Name = "IConditionalIconCriterion", InterfaceId = "64CF970B-7712-4BEC-B86E-77AF4B31C989", CoClassName = "ConditionalIconCriterion", CoClassId = "0BBB2E5F-7309-4B25-BB52-2A32D1CC1823")] + [ApiSet(Version = 1.6)] + public struct ConditionalIconCriterion + { + /// + /// What the icon conditional formula should be based on. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatIconCriterion_Type)] + ConditionalFormatIconRuleType Type { get; set; } + + /// + /// A number or a formula depending on the type. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatIconCriterion_Formula)] + [TypeScriptType("string")] + object Formula { get; set; } + + /// + /// GreaterThan or GreaterThanOrEqual for each of the rule type for the Icon conditional format. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatIconCriterion_Operator)] + ConditionalIconCriterionOperator Operator { get; set; } + + /// + /// The custom icon for the current criterion if different from the default IconSet, else null will be returned. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatIconCriterion_CustomIcon)] + [Optional] + Icon CustomIcon { get; set; } + } + + /// + /// Represents an IconSet criteria for conditional formatting. + /// + [ClientCallableComType(Name = "IColorScaleConditionalFormat", InterfaceId = "53F51B37-F896-4CD8-9884-33EB4D84BC61", CoClassName = "ColorScaleConditionalFormat")] + [ApiSet(Version = 1.6)] + public interface ColorScaleConditionalFormat + { + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatColorScale_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// If true the color scale will have three points (minimum, midpoint, maximum), otherwise it will have two (minimum, maximum). + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatColorScale_ThreeColorScale)] + bool ThreeColorScale { get; } + + /// + /// The criteria of the color scale. Midpoint is optional when using a two point color scale. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatColorScale_Criteria)] + ConditionalColorScaleCriteria Criteria { get; set; } + } + + /// + /// Represents the criteria of the color scale. + /// + [ClientCallableComType(Name = "IConditionalColorScaleCriteria", InterfaceId = "A65ADE8C-F780-40AD-B906-4DE17DC68084", CoClassName = "ConditionalColorScaleCriteria", CoClassId = "06773272-6E84-4E06-924E-C53CE87C3352")] + [ApiSet(Version = 1.6)] + public struct ConditionalColorScaleCriteria + { + /// + /// The minimum point Color Scale Criterion. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatColorScaleCriteria_Minimum)] + [JsonStringify()] + ConditionalColorScaleCriterion Minimum { get; set; } + + /// + /// The midpoint Color Scale Criterion if the color scale is a 3-color scale. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatColorScaleCriteria_Midpoint)] + [JsonStringify()] + [Optional] + ConditionalColorScaleCriterion Midpoint { get; set; } + + /// + /// The maximum point Color Scale Criterion. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatColorScaleCriteria_Maximum)] + [JsonStringify()] + ConditionalColorScaleCriterion Maximum { get; set; } + } + + /// + /// Represents a Color Scale Criterion which contains a type, value and a color. + /// + [ClientCallableComType(Name = "IConditionalColorScaleCriterion", InterfaceId = "A00727E4-EB84-4CA9-9D0E-AEEBAF3B9F4E", CoClassName = "ConditionalColorScaleCriterion", CoClassId = "A62AA145-0310-43F4-944C-89D8A59B7303")] + [ApiSet(Version = 1.6)] + public struct ConditionalColorScaleCriterion + { + /// + /// What the icon conditional formula should be based on. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatColorScaleCriterion_Type)] + ConditionalFormatColorCriterionType Type { get; set; } + + /// + /// A number, a formula, or null (if Type is LowestValue). + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatColorScaleCriterion_Formula)] + [TypeScriptType("string")] + [Optional] + object Formula { get; set; } + + /// + /// HTML color code representation of the color scale color. E.g. #FF0000 represents Red. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatColorScaleCriterion_Color)] + [Optional] + string Color { get; set; } + } + + /// + /// Represents a Top/Bottom conditional format. + /// + [ClientCallableComType(Name = "ITopBottomConditionalFormat", InterfaceId = "3C5F4D98-3AED-47F3-BDA2-2D5BEBCFFF2C", CoClassName = "TopBottomConditionalFormat")] + [ApiSet(Version = 1.6)] + public interface TopBottomConditionalFormat + { + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatTopBottom_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// The criteria of the Top/Bottom conditional format. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatTopBottom_Rule)] + ConditionalTopBottomRule Rule { get; set; } + + /// + /// Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatTopBottom_Format)] + [JsonStringify()] + ConditionalRangeFormat Format { get; } + } + + /// + /// Represents the rule of the top/bottom conditional format. + /// + [ClientCallableComType(Name = "IConditionalTopBottomRule", InterfaceId = "876FF0AE-2803-4F1F-8FB0-E15184F1BF6D", CoClassName = "ConditionalTopBottomRule", CoClassId = "1DF7829B-9D8D-40CF-A26A-640D368A67A5")] + [ApiSet(Version = 1.6)] + public struct ConditionalTopBottomRule + { + /// + /// Format values based on the top or bottom rank. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatTopBottomRule_Criteria)] + ConditionalTopBottomCriterionType Type { get; set; } + + /// + /// The rank between 1 and 1000 for numeric ranks or 1 and 100 for percent ranks. + /// + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatTopBottomRule_Rank)] + [ApiSet(Version = 1.6)] + int Rank { get; set; } + } + + /// + /// Represents the the preset criteria conditional format such as above average/below average/unique values/contains blank/nonblank/error/noerror. + /// + [ClientCallableComType(Name = "IPresetCriteriaConditionalFormat", InterfaceId = "AF50DA3F-D7BB-406E-BF67-4FEDF67F2006", CoClassName = "PresetCriteriaConditionalFormat")] + [ApiSet(Version = 1.6)] + public interface PresetCriteriaConditionalFormat + { + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatPreset_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// The rule of the conditional format. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatPreset_Rule)] + ConditionalPresetCriteriaRule Rule { get; set; } + + /// + /// Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatPreset_Format)] + [JsonStringify()] + ConditionalRangeFormat Format { get; } + } + + /// + /// Represents the Preset Criteria Conditional Format Rule + /// + [ClientCallableComType(Name = "IConditionalPresetCriteriaRule", InterfaceId = "BCDC2688-54B9-4530-8F3A-0EC2B6589792", CoClassName = "ConditionalPresetCriteriaRule", CoClassId = "11DD755D-A947-4374-9DA7-16470F0F6B7C")] + [ApiSet(Version = 1.6)] + public struct ConditionalPresetCriteriaRule + { + /// + /// The criterion of the conditional format. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatPresetRule_Criteria)] + ConditionalFormatPresetCriterion Criterion { get; set; } + } + + /// + /// Represents a specific text conditional format. + /// + [ClientCallableComType(Name = "ITextConditionalFormat", InterfaceId = "3CA62D72-357B-4530-9311-332E960B1F96", CoClassName = "TextConditionalFormat")] + [ApiSet(Version = 1.6)] + public interface TextConditionalFormat + { + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatText_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// The rule of the conditional format. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatText_Rule)] + ConditionalTextComparisonRule Rule { get; set; } + + /// + /// Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatText_Format)] + [JsonStringify()] + ConditionalRangeFormat Format { get; } + } + + /// + /// Represents a Cell Value Conditional Format Rule + /// + [ClientCallableComType(Name = "IConditionalTextComparisonRule", InterfaceId = "6799F838-7DC4-4D64-A890-F125C802F8DD", CoClassName = "ConditionalTextComparisonRule", CoClassId = "E5BA2981-8CAE-459E-940D-8A5724284203")] + [ApiSet(Version = 1.6)] + public struct ConditionalTextComparisonRule + { + /// + /// The operator of the text conditional format. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatTextRule_Operator)] + ConditionalTextOperator Operator { get; set; } + + /// + /// The Text value of conditional format. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatTextRule_Text)] + string Text { get; set; } + } + + /// + /// Represents a cell value conditional format. + /// + [ClientCallableComType(Name = "ICellValueConditionalFormat", InterfaceId = "7C6B942D-81C8-46A5-BE5C-B8B51A0ED747", CoClassName = "CellValueConditionalFormat")] + [ApiSet(Version = 1.6)] + public interface CellValueConditionalFormat + { + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatCellValue_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Represents the Rule object on this conditional format. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatCellValue_Rule)] + ConditionalCellValueRule Rule { get; set; } + + /// + /// Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatCellValue_Format)] + [JsonStringify()] + ConditionalRangeFormat Format { get; } + } + + /// + /// Represents a Cell Value Conditional Format Rule + /// + [ClientCallableComType(Name = "IConditionalCellValueRule", InterfaceId = "921BEFA9-AE08-4DF3-B27D-4B86DBC34DA3", CoClassName = "ConditionalCellValueRule", CoClassId = "06ACBCDE-DB8F-4F59-AAD6-E7C4DB98484C")] + [ApiSet(Version = 1.6)] + public struct ConditionalCellValueRule + { + /// + /// The operator of the text conditional format. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatCellValueRule_Operator)] + ConditionalCellValueOperator Operator { get; set; } + + /// + /// The formula, if required, to evaluate the conditional format rule on. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatCellValueRule_Formula1)] + [TypeScriptType("string")] + object Formula1 { get; set; } + + /// + /// The formula, if required, to evaluate the conditional format rule on. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalFormatCellValueRule_Formula2)] + [TypeScriptType("string")] + [Optional] + object Formula2 { get; set; } + } + + /// + /// A format object encapsulating the conditional formats range's font, fill, borders, and other properties. + /// + [ClientCallableComType(Name = "IConditionalRangeFormat", InterfaceId = "2501401A-42DC-4123-AA48-06AE9F2AB9EE", CoClassName = "ConditionalRangeFormat")] + [ApiSet(Version = 1.6)] + public interface ConditionalRangeFormat + { + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeFormat_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Returns the fill object defined on the overall conditional format range. Read-only. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeFormat_Fill)] + ConditionalRangeFill Fill { get; } + + /// + /// Collection of border objects that apply to the overall conditional format range. Read-only. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeFormat_Borders)] + ConditionalRangeBorderCollection Borders { get; } + + /// + /// Returns the font object defined on the overall conditional format range. Read-only. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeFormat_Font)] + ConditionalRangeFont Font { get; } + + + /// + /// Represents Excel's number format code for the given range. Cleared if null is passed in. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeFormat_NumberFormat)] + object NumberFormat { get; set; } + } + + /// + /// This object represents the font attributes (font style,, color, etc.) for an object. + /// + [ClientCallableComType(Name = "IConditionalRangeFont", InterfaceId = "2AA0159D-35F2-432B-8DA6-D8C7182F90F1", CoClassName = "ConditionalRangeFont")] + [ApiSet(Version = 1.6)] + public interface ConditionalRangeFont + { + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeFont_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + + /// + /// Represents the bold status of font. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeFont_Bold)] + bool? Bold { get; set; } + + /// + /// HTML color code representation of the text color. E.g. #FF0000 represents Red. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeFont_Color)] + string Color { get; set; } + + /// + /// Represents the italic status of the font. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeFont_Italic)] + bool? Italic { get; set; } + + /// + /// Represents the strikethrough status of the font. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeFont_Strikethrough)] + bool? Strikethrough { get; set; } + + /// + /// Type of underline applied to the font. See Excel.ConditionalRangeFontUnderlineStyle for details. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeFont_Underline)] + ConditionalRangeFontUnderlineStyle? Underline { get; set; } + + /// + /// Resets the font formats. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeFont_Clear)] + void Clear(); + } + + /// + /// Represents the background of a conditional range object. + /// + [ClientCallableComType(Name = "IConditionalRangeFill", InterfaceId = "E2488882-675D-4392-8C80-01D6380406D9", CoClassName = "ConditionalRangeFill")] + [ApiSet(Version = 1.6)] + public interface ConditionalRangeFill + { + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeFill_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + /// + /// HTML color code representing the color of the fill, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeFill_Color)] + string Color { get; set; } + /// + /// Resets the fill. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeFill_Clear)] + void Clear(); + } + + /// + /// Represents the border of an object. + /// + [ClientCallableComType(Name = "IConditionalRangeBorder", InterfaceId = "BE3C21C2-66F4-454D-B1BB-7BBCFBA9604B", CoClassName = "ConditionalRangeBorder")] + [ApiSet(Version = 1.6)] + public interface ConditionalRangeBorder + { + /// + /// Represents border identifier. Read-only. + /// + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeBorder_Id)] + [ClientCallableProperty(ExcludedFromClientLibrary = true)] + [ApiSet(Version = 1.6)] + ConditionalRangeBorderIndex Id { get; } + + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeBorder_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + /// + /// HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeBorder_Color)] + string Color { get; set; } + /// + /// One of the constants of line style specifying the line style for the border. See Excel.BorderLineStyle for details. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeBorder_LineStyle)] + ConditionalRangeBorderLineStyle? Style { get; set; } + /// + /// Constant value that indicates the specific side of the border. See Excel.ConditionalRangeBorderIndex for details. Read-only. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeBorder_SideIndex)] + ConditionalRangeBorderIndex? SideIndex { get; } + } + + /// + /// Represents the border objects that make up range border. + /// + [ClientCallableComType(Name = "IConditionalRangeBorderCollection", InterfaceId = "E18F283E-6188-48FD-A364-C65973CF228C", CoClassName = "ConditionalRangeBorderCollection")] + [ApiSet(Version = 1.6)] + public interface ConditionalRangeBorderCollection : IEnumerable + { + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeBorderCollection_OnAccess)] + [ClientCallableOperation(OperationType = OperationType.Read)] + void _OnAccess(); + /// + /// Gets a border object using its name + /// + /// Index value of the border object to be retrieved. See Excel.ConditionalRangeBorderIndex for details. + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeBorderCollection_Indexer)] + ConditionalRangeBorder this[ConditionalRangeBorderIndex index] { get; } + /// + /// Number of border objects in the collection. Read-only. + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeBorderCollection_Count)] + int Count { get; } + /// + /// Gets a border object using its index + /// + /// Index value of the object to be retrieved. Zero-indexed. + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeBorderCollection_ItemAt)] + [ClientCallableOperation(OperationType = OperationType.Read)] + ConditionalRangeBorder GetItemAt(int index); + + /// + /// Gets the top border + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeBorderCollection_Top)] + ConditionalRangeBorder Top { get; } + + /// + /// Gets the top border + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeBorderCollection_Bottom)] + ConditionalRangeBorder Bottom { get; } + + /// + /// Gets the top border + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeBorderCollection_Left)] + ConditionalRangeBorder Left { get; } + + /// + /// Gets the top border + /// + [ApiSet(Version = 1.6)] + [ClientCallableComMember(DispatchId = ConditionalFormatDispatchIds.ConditionalRangeBorderCollection_Right)] + ConditionalRangeBorder Right { get; } + } + #endregion Conditional Formats + +} diff --git a/markdown/$changes.md b/markdown/$changes.md index 443d9db..e5e5f46 100644 --- a/markdown/$changes.md +++ b/markdown/$changes.md @@ -1,2 +1,31 @@ -|Object| What is new| Description|Feedback| -|:----|:----|:----|:----| +|Object| What is new| Description|Feedback| +|:----|:----|:----|:----| +|[chartAxis](../excel/chartaxis.md)|_Property_ > baseUnit|Returns or sets the base unit for the specified category axis. Possible values are: `Days` Specifies the unit of time for chart axes and data series, in days.,`Months` Specifies the unit of time for chart axes and data series, in months.,`Years` Specifies the unit of time for chart axes and data series, in years.|1.9| +|[chartAxis](../excel/chartaxis.md)|_Property_ > categoryNames|Returns or sets all the category names for the specified axis, as a text array.|1.9| +|[chartAxis](../excel/chartaxis.md)|_Property_ > categoryType|Returns or sets the category axis type. Possible values are: `Automatic` Specifies the type of the category axis. Excel controls the axis type.,`TextAxis` Specifies the type of the category axis. Axis groups data by an arbitrary set of categories.,`DateAxis` Specifies the type of the category axis. Axis groups data on a time scale.|1.9| +|[chartAxis](../excel/chartaxis.md)|_Property_ > customDisplayUnit|Represents the custom axis display unit value.|1.9| +|[chartAxis](../excel/chartaxis.md)|_Property_ > displayUnit|Represents the axis display unit. Possible values are: `None` Default option. This will reset display unit to the axis, and set unit label invisible.,`Hundreds` This will set the axis in units of hundreds.,`Thousands` This will set the axis in units of thousands.,`TenThousands` This will set the axis in units of tens of thousands.,`HundredThousands` This will set the axis in units of hundreds of thousands.,`Millions` This will set the axis in units of millions.,`TenMillions` This will set the axis in units of tens of millions.,`HundredMillons` This will set the axis in units of hundreds of millions.,`Billions` This will set the axis in units of billions.,`Trillions` This will set the axis in units of trillions.,`Custom` This will set the axis in units of custom value.|1.9| +|[chartAxis](../excel/chartaxis.md)|_Property_ > majorUnitScale|Returns or sets the major unit scale value for the category axis when the CategoryType property is set to TimeScale. Possible values are: `Days` Specifies the unit of time for chart axes and data series, in days.,`Months` Specifies the unit of time for chart axes and data series, in months.,`Years` Specifies the unit of time for chart axes and data series, in years.|1.9| +|[chartAxis](../excel/chartaxis.md)|_Property_ > minorUnitScale|Returns or sets the minor unit scale value for the category axis when the CategoryType property is set to TimeScale. Possible values are: `Days` Specifies the unit of time for chart axes and data series, in days.,`Months` Specifies the unit of time for chart axes and data series, in months.,`Years` Specifies the unit of time for chart axes and data series, in years.|1.9| +|[chartAxis](../excel/chartaxis.md)|_Property_ > showDisplayUnitLabel|Represents whether the axis display unit label is visible.|1.9| +|[chartAxis](../excel/chartaxis.md)|_Property_ > type|Represents the axis type. Read-only. Possible values are: `Category` Specifies the axis type. Axis displays categories.,`Value` Specifies the axis type. Axis displays values.,`SeriesAxis` Specifies the axis type. Axis displays data series.|1.9| +|[chartBorder](../excel/chartborder.md)|_Method_ > [clear()](../excel/chartborder.md#clear)|Clear the border color of a chart element.|1.9| +|[chartBorder](../excel/chartborder.md)|_Method_ > [setSolidColor(color: string)](../excel/chartborder.md#setsolidcolorcolor-string)|Sets the border formatting of a chart element to a uniform color.|1.9| +|[chartFormatString](../excel/chartformatstring.md)|_Relationship_ > font|Represents the font attributes, such as font name, font size, color, etc. of chart characters object. Read-only.|1.9| +|[chartPointFormat](../excel/chartpointformat.md)|_Relationship_ > border|Represents the border format of a chart point, which includes border formating information. Read-only Read-only.|1.9| +|[chartSeries](../excel/chartseries.md)|_Relationship_ > trendlines|Represents a collection of Trendlines in the series. Read-only.|1.9| +|[chartSeries](../excel/chartseries.md)|_Method_ > [delete()](../excel/chartseries.md#delete)|Deletes the chart series.|1.9| +|[chartSeries](../excel/chartseries.md)|_Method_ > [setBubbleSizes(sourceData: Range)](../excel/chartseries.md#setbubblesizessourcedata-range)|Set bubble sizes for a chart series. Only works for bubble charts.|1.9| +|[chartSeries](../excel/chartseries.md)|_Method_ > [setValues(sourceData: Range)](../excel/chartseries.md#setvaluessourcedata-range)|Set values for a chart series. For scatter chart, it means Y axis values.|1.9| +|[chartSeries](../excel/chartseries.md)|_Method_ > [setXAxisValues(sourceData: Range)](../excel/chartseries.md#setxaxisvaluessourcedata-range)|Set values of X axis for a chart series. Only works for scatter charts.|1.9| +|[chartSeriesCollection](../excel/chartseriescollection.md)|_Method_ > [add(name: string, index: number)](../excel/chartseriescollection.md#addname-string-index-number)|Add a new series to the collection.|1.9| +|[chartTitle](../excel/charttitle.md)|_Property_ > horizontalAlignment|Represents the horizontal alignment for chart title. Possible values are: Center, Left, Right, Justify, Distributed.|1.9| +|[chartTitle](../excel/charttitle.md)|_Method_ > [getSubstring(start: number, start: number)](../excel/charttitle.md#getsubstringstart-number-start-number)|Get the characters of a chart title. Line break '\n' also counts one charater.|1.9| +|[chartTrendline](../excel/charttrendline.md)|_Property_ > movingAveragePeriod|Represents the MovingAveragePeriod of a chart trendline, specific for trendline with MovingAverage type.|1.9| +|[chartTrendline](../excel/charttrendline.md)|_Property_ > polynomialOrder|Represents the PolynomialOrder of a chart trendline, specific for trendline with Polynomial type.|1.9| +|[chartTrendline](../excel/charttrendline.md)|_Property_ > type|Represents the Type of a chart trendline. Possible values are: Linear, Expontential, Logarithmic, MovingAvg, Polynomial, Power.|1.9| +|[chartTrendline](../excel/charttrendline.md)|_Relationship_ > format|Represents the formatting of a chart trendline. Read-only.|1.9| +|[chartTrendlineCollection](../excel/charttrendlinecollection.md)|_Property_ > items|A collection of chartTrendline objects. Read-only.|1.9| +|[chartTrendlineCollection](../excel/charttrendlinecollection.md)|_Method_ > [add(type: string)](../excel/charttrendlinecollection.md#addtype-string)|Adds a new trendline to trendline collection.|1.9| +|[chartTrendlineCollection](../excel/charttrendlinecollection.md)|_Method_ > [getCount()](../excel/charttrendlinecollection.md#getcount)|Returns the number of trendlines in the collection.|1.9| +|[chartTrendlineFormat](../excel/charttrendlineformat.md)|_Relationship_ > line|Represents chart line formatting. Read-only.|1.9| diff --git a/markdown/application.md b/markdown/application.md index 94ae8c8..443fa74 100644 --- a/markdown/application.md +++ b/markdown/application.md @@ -1,84 +1,84 @@ -# Application Object (JavaScript API for Excel) - -Represents the Excel application that manages the workbook. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|calculationMode|string|Returns the calculation mode used in the workbook. Read-only. Possible values are: `Automatic` Excel controls recalculation,`AutomaticExceptTables` Excel controls recalculation but ignores changes in tables.,`Manual` Calculation is done when the user requests it.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[calculate(calculationType: string)](#calculatecalculationtype-string)|void|Recalculate all currently opened workbooks in Excel.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[suspendApiCalculationUntilNextSync()](#suspendapicalculationuntilnextsync)|void|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.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### calculate(calculationType: string) -Recalculate all currently opened workbooks in Excel. - -#### Syntax -```js -applicationObject.calculate(calculationType); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|calculationType|string|Specifies the calculation type to use. Possible values are: `Recalculate` Default-option. Performs normal calculation by calculating all the formulas in the workbook,`Full` Forces a full calculation of the data,`FullRebuild` Forces a full calculation of the data and rebuilds the dependencies.| - -#### Returns -void - -#### Examples -```js -Excel.run(function (ctx) { - ctx.workbook.application.calculate('Full'); - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -### suspendApiCalculationUntilNextSync() -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. - -#### Syntax -```js -applicationObject.suspendApiCalculationUntilNextSync(); -``` - -#### Parameters -None - -#### Returns -void -### Property access examples -```js -Excel.run(function (ctx) { - var application = ctx.workbook.application; - application.load('calculationMode'); - return ctx.sync().then(function() { - console.log(application.calculationMode); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - +# Application Object (JavaScript API for Excel) + +Represents the Excel application that manages the workbook. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|calculationMode|string|Returns the calculation mode used in the workbook. Read-only. Possible values are: `Automatic` Excel controls recalculation,`AutomaticExceptTables` Excel controls recalculation but ignores changes in tables.,`Manual` Calculation is done when the user requests it.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[calculate(calculationType: string)](#calculatecalculationtype-string)|void|Recalculate all currently opened workbooks in Excel.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[suspendApiCalculationUntilNextSync()](#suspendapicalculationuntilnextsync)|void|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.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### calculate(calculationType: string) +Recalculate all currently opened workbooks in Excel. + +#### Syntax +```js +applicationObject.calculate(calculationType); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|calculationType|string|Specifies the calculation type to use. Possible values are: `Recalculate` Default-option. Performs normal calculation by calculating all the formulas in the workbook,`Full` Forces a full calculation of the data,`FullRebuild` Forces a full calculation of the data and rebuilds the dependencies.| + +#### Returns +void + +#### Examples +```js +Excel.run(function (ctx) { + ctx.workbook.application.calculate('Full'); + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +### suspendApiCalculationUntilNextSync() +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. + +#### Syntax +```js +applicationObject.suspendApiCalculationUntilNextSync(); +``` + +#### Parameters +None + +#### Returns +void +### Property access examples +```js +Excel.run(function (ctx) { + var application = ctx.workbook.application; + application.load('calculationMode'); + return ctx.sync().then(function() { + console.log(application.calculationMode); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + diff --git a/markdown/binding.md b/markdown/binding.md index bf220b0..ba5a96d 100644 --- a/markdown/binding.md +++ b/markdown/binding.md @@ -1,157 +1,157 @@ -# Binding Object (JavaScript API for Excel) - -Represents an Office.js binding that is defined in the workbook. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|id|string|Represents binding identifier. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|type|string|Returns the type of the binding. Read-only. Possible values are: Range, Table, Text.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[delete()](#delete)|void|Deletes the binding.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| -|[getRange()](#getrange)|[Range](range.md)|Returns the range represented by the binding. Will throw an error if binding is not of the correct type.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getTable()](#gettable)|[Table](table.md)|Returns the table represented by the binding. Will throw an error if binding is not of the correct type.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getText()](#gettext)|string|Returns the text represented by the binding. Will throw an error if binding is not of the correct type.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### delete() -Deletes the binding. - -#### Syntax -```js -bindingObject.delete(); -``` - -#### Parameters -None - -#### Returns -void - -### getRange() -Returns the range represented by the binding. Will throw an error if binding is not of the correct type. - -#### Syntax -```js -bindingObject.getRange(); -``` - -#### Parameters -None - -#### Returns -[Range](range.md) - -#### Examples -Below example uses binding object to get the associated range. - -```js -Excel.run(function (ctx) { - var binding = ctx.workbook.bindings.getItemAt(0); - var range = binding.getRange(); - range.load('cellCount'); - return ctx.sync().then(function() { - console.log(range.cellCount); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getTable() -Returns the table represented by the binding. Will throw an error if binding is not of the correct type. - -#### Syntax -```js -bindingObject.getTable(); -``` - -#### Parameters -None - -#### Returns -[Table](table.md) - -#### Examples -```js -Excel.run(function (ctx) { - var binding = ctx.workbook.bindings.getItemAt(0); - var table = binding.getTable(); - table.load('name'); - return ctx.sync().then(function() { - console.log(table.name); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getText() -Returns the text represented by the binding. Will throw an error if binding is not of the correct type. - -#### Syntax -```js -bindingObject.getText(); -``` - -#### Parameters -None - -#### Returns -string - -#### Examples - -```js -Excel.run(function (ctx) { - var binding = ctx.workbook.bindings.getItemAt(0); - var text = binding.getText(); - binding.load('text'); - return ctx.sync().then(function() { - console.log(text); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -### Property access examples - -```js -Excel.run(function (ctx) { - var binding = ctx.workbook.bindings.getItemAt(0); - binding.load('type'); - return ctx.sync().then(function() { - console.log(binding.type); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` +# Binding Object (JavaScript API for Excel) + +Represents an Office.js binding that is defined in the workbook. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|id|string|Represents binding identifier. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|type|string|Returns the type of the binding. Read-only. Possible values are: Range, Table, Text.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[delete()](#delete)|void|Deletes the binding.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| +|[getRange()](#getrange)|[Range](range.md)|Returns the range represented by the binding. Will throw an error if binding is not of the correct type.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getTable()](#gettable)|[Table](table.md)|Returns the table represented by the binding. Will throw an error if binding is not of the correct type.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getText()](#gettext)|string|Returns the text represented by the binding. Will throw an error if binding is not of the correct type.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### delete() +Deletes the binding. + +#### Syntax +```js +bindingObject.delete(); +``` + +#### Parameters +None + +#### Returns +void + +### getRange() +Returns the range represented by the binding. Will throw an error if binding is not of the correct type. + +#### Syntax +```js +bindingObject.getRange(); +``` + +#### Parameters +None + +#### Returns +[Range](range.md) + +#### Examples +Below example uses binding object to get the associated range. + +```js +Excel.run(function (ctx) { + var binding = ctx.workbook.bindings.getItemAt(0); + var range = binding.getRange(); + range.load('cellCount'); + return ctx.sync().then(function() { + console.log(range.cellCount); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getTable() +Returns the table represented by the binding. Will throw an error if binding is not of the correct type. + +#### Syntax +```js +bindingObject.getTable(); +``` + +#### Parameters +None + +#### Returns +[Table](table.md) + +#### Examples +```js +Excel.run(function (ctx) { + var binding = ctx.workbook.bindings.getItemAt(0); + var table = binding.getTable(); + table.load('name'); + return ctx.sync().then(function() { + console.log(table.name); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getText() +Returns the text represented by the binding. Will throw an error if binding is not of the correct type. + +#### Syntax +```js +bindingObject.getText(); +``` + +#### Parameters +None + +#### Returns +string + +#### Examples + +```js +Excel.run(function (ctx) { + var binding = ctx.workbook.bindings.getItemAt(0); + var text = binding.getText(); + binding.load('text'); + return ctx.sync().then(function() { + console.log(text); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +### Property access examples + +```js +Excel.run(function (ctx) { + var binding = ctx.workbook.bindings.getItemAt(0); + binding.load('type'); + return ctx.sync().then(function() { + console.log(binding.type); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` diff --git a/markdown/bindingcollection.md b/markdown/bindingcollection.md index 5e64b46..6863091 100644 --- a/markdown/bindingcollection.md +++ b/markdown/bindingcollection.md @@ -1,263 +1,263 @@ -# BindingCollection Object (JavaScript API for Excel) - -Represents the collection of all the binding objects that are part of the workbook. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|count|int|Returns the number of bindings in the collection. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|items|[Binding[]](binding.md)|A collection of binding objects. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[add(range: Range or string, bindingType: string, id: string)](#addrange-range-or-string-bindingtype-string-id-string)|[Binding](binding.md)|Add a new binding to a particular Range.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| -|[addFromNamedItem(name: string, bindingType: string, id: string)](#addfromnameditemname-string-bindingtype-string-id-string)|[Binding](binding.md)|Add a new binding based on a named item in the workbook.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| -|[addFromSelection(bindingType: string, id: string)](#addfromselectionbindingtype-string-id-string)|[Binding](binding.md)|Add a new binding based on the current selection.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| -|[getCount()](#getcount)|int|Gets the number of bindings in the collection.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|[getItem(id: string)](#getitemid-string)|[Binding](binding.md)|Gets a binding object by ID.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getItemAt(index: number)](#getitematindex-number)|[Binding](binding.md)|Gets a binding object based on its position in the items array.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getItemOrNullObject(id: string)](#getitemornullobjectid-string)|[Binding](binding.md)|Gets a binding object by ID. If the binding object does not exist, will return a null object.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### add(range: Range or string, bindingType: string, id: string) -Add a new binding to a particular Range. - -#### Syntax -```js -bindingCollectionObject.add(range, bindingType, id); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|range|Range or string|Range to bind the binding to. May be an Excel Range object, or a string. If string, must contain the full address, including the sheet name| -|bindingType|string|Type of binding. Possible values are: Range, Table, Text| -|id|string|Name of binding.| - -#### Returns -[Binding](binding.md) - -### addFromNamedItem(name: string, bindingType: string, id: string) -Add a new binding based on a named item in the workbook. - -#### Syntax -```js -bindingCollectionObject.addFromNamedItem(name, bindingType, id); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|name|string|Name from which to create binding.| -|bindingType|string|Type of binding. Possible values are: Range, Table, Text| -|id|string|Name of binding.| - -#### Returns -[Binding](binding.md) - -### addFromSelection(bindingType: string, id: string) -Add a new binding based on the current selection. - -#### Syntax -```js -bindingCollectionObject.addFromSelection(bindingType, id); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|bindingType|string|Type of binding. Possible values are: Range, Table, Text| -|id|string|Name of binding.| - -#### Returns -[Binding](binding.md) - -### getCount() -Gets the number of bindings in the collection. - -#### Syntax -```js -bindingCollectionObject.getCount(); -``` - -#### Parameters -None - -#### Returns -int - -### getItem(id: string) -Gets a binding object by ID. - -#### Syntax -```js -bindingCollectionObject.getItem(id); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|id|string|Id of the binding object to be retrieved.| - -#### Returns -[Binding](binding.md) - -#### Examples - -Create a table binding to monitor data changes in the table. When data is changed, the background color of the table will be changed to orange. - -```js -function addEventHandler() { - //Create Table1 -Excel.run(function (ctx) { - ctx.workbook.tables.add("Sheet1!A1:C4", true); - return ctx.sync().then(function() { - console.log("My Diet Data Inserted!"); - }) - .catch(function (error) { - console.log(JSON.stringify(error)); - }); -}); - //Create a new table binding for Table1 -Office.context.document.bindings.addFromNamedItemAsync("Table1", Office.CoercionType.Table, { id: "myBinding" }, function (asyncResult) { - if (asyncResult.status == "failed") { - console.log("Action failed with error: " + asyncResult.error.message); - } - else { - // If succeeded, then add event handler to the table binding. - Office.select("bindings#myBinding").addHandlerAsync(Office.EventType.BindingDataChanged, onBindingDataChanged); - } -}); -} - -// when data in the table is changed, this event will be triggered. -function onBindingDataChanged(eventArgs) { -Excel.run(function (ctx) { - // highlight the table in orange to indicate data has been changed. - ctx.workbook.bindings.getItem(eventArgs.binding.id).getTable().getDataBodyRange().format.fill.color = "Orange"; - return ctx.sync().then(function() { - console.log("The value in this table got changed!"); - }) - .catch(function (error) { - console.log(JSON.stringify(error)); - }); -}); -} - -``` - - - -#### Examples -```js -Excel.run(function (ctx) { - var lastPosition = ctx.workbook.bindings.count - 1; - var binding = ctx.workbook.bindings.getItemAt(lastPosition); - binding.load('type') - return ctx.sync().then(function() { - console.log(binding.type); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getItemAt(index: number) -Gets a binding object based on its position in the items array. - -#### Syntax -```js -bindingCollectionObject.getItemAt(index); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|index|number|Index value of the object to be retrieved. Zero-indexed.| - -#### Returns -[Binding](binding.md) - -#### Examples -```js -Excel.run(function (ctx) { - var lastPosition = ctx.workbook.bindings.count - 1; - var binding = ctx.workbook.bindings.getItemAt(lastPosition); - binding.load('type') - return ctx.sync().then(function() { - console.log(binding.type); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getItemOrNullObject(id: string) -Gets a binding object by ID. If the binding object does not exist, will return a null object. - -#### Syntax -```js -bindingCollectionObject.getItemOrNullObject(id); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|id|string|Id of the binding object to be retrieved.| - -#### Returns -[Binding](binding.md) -### Property access examples - -```js -Excel.run(function (ctx) { - var bindings = ctx.workbook.bindings; - bindings.load('items'); - return ctx.sync().then(function() { - for (var i = 0; i < bindings.items.length; i++) - { - console.log(bindings.items[i].id); - } - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` -Get the number of bindings - -```js -Excel.run(function (ctx) { - var bindings = ctx.workbook.bindings; - bindings.load('count'); - return ctx.sync().then(function() { - console.log("Bindings: Count= " + bindings.count); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` +# BindingCollection Object (JavaScript API for Excel) + +Represents the collection of all the binding objects that are part of the workbook. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|count|int|Returns the number of bindings in the collection. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|items|[Binding[]](binding.md)|A collection of binding objects. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[add(range: Range or string, bindingType: string, id: string)](#addrange-range-or-string-bindingtype-string-id-string)|[Binding](binding.md)|Add a new binding to a particular Range.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| +|[addFromNamedItem(name: string, bindingType: string, id: string)](#addfromnameditemname-string-bindingtype-string-id-string)|[Binding](binding.md)|Add a new binding based on a named item in the workbook.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| +|[addFromSelection(bindingType: string, id: string)](#addfromselectionbindingtype-string-id-string)|[Binding](binding.md)|Add a new binding based on the current selection.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| +|[getCount()](#getcount)|int|Gets the number of bindings in the collection.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|[getItem(id: string)](#getitemid-string)|[Binding](binding.md)|Gets a binding object by ID.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getItemAt(index: number)](#getitematindex-number)|[Binding](binding.md)|Gets a binding object based on its position in the items array.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getItemOrNullObject(id: string)](#getitemornullobjectid-string)|[Binding](binding.md)|Gets a binding object by ID. If the binding object does not exist, will return a null object.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### add(range: Range or string, bindingType: string, id: string) +Add a new binding to a particular Range. + +#### Syntax +```js +bindingCollectionObject.add(range, bindingType, id); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|range|Range or string|Range to bind the binding to. May be an Excel Range object, or a string. If string, must contain the full address, including the sheet name| +|bindingType|string|Type of binding. Possible values are: Range, Table, Text| +|id|string|Name of binding.| + +#### Returns +[Binding](binding.md) + +### addFromNamedItem(name: string, bindingType: string, id: string) +Add a new binding based on a named item in the workbook. + +#### Syntax +```js +bindingCollectionObject.addFromNamedItem(name, bindingType, id); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|name|string|Name from which to create binding.| +|bindingType|string|Type of binding. Possible values are: Range, Table, Text| +|id|string|Name of binding.| + +#### Returns +[Binding](binding.md) + +### addFromSelection(bindingType: string, id: string) +Add a new binding based on the current selection. + +#### Syntax +```js +bindingCollectionObject.addFromSelection(bindingType, id); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|bindingType|string|Type of binding. Possible values are: Range, Table, Text| +|id|string|Name of binding.| + +#### Returns +[Binding](binding.md) + +### getCount() +Gets the number of bindings in the collection. + +#### Syntax +```js +bindingCollectionObject.getCount(); +``` + +#### Parameters +None + +#### Returns +int + +### getItem(id: string) +Gets a binding object by ID. + +#### Syntax +```js +bindingCollectionObject.getItem(id); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|id|string|Id of the binding object to be retrieved.| + +#### Returns +[Binding](binding.md) + +#### Examples + +Create a table binding to monitor data changes in the table. When data is changed, the background color of the table will be changed to orange. + +```js +function addEventHandler() { + //Create Table1 +Excel.run(function (ctx) { + ctx.workbook.tables.add("Sheet1!A1:C4", true); + return ctx.sync().then(function() { + console.log("My Diet Data Inserted!"); + }) + .catch(function (error) { + console.log(JSON.stringify(error)); + }); +}); + //Create a new table binding for Table1 +Office.context.document.bindings.addFromNamedItemAsync("Table1", Office.CoercionType.Table, { id: "myBinding" }, function (asyncResult) { + if (asyncResult.status == "failed") { + console.log("Action failed with error: " + asyncResult.error.message); + } + else { + // If succeeded, then add event handler to the table binding. + Office.select("bindings#myBinding").addHandlerAsync(Office.EventType.BindingDataChanged, onBindingDataChanged); + } +}); +} + +// when data in the table is changed, this event will be triggered. +function onBindingDataChanged(eventArgs) { +Excel.run(function (ctx) { + // highlight the table in orange to indicate data has been changed. + ctx.workbook.bindings.getItem(eventArgs.binding.id).getTable().getDataBodyRange().format.fill.color = "Orange"; + return ctx.sync().then(function() { + console.log("The value in this table got changed!"); + }) + .catch(function (error) { + console.log(JSON.stringify(error)); + }); +}); +} + +``` + + + +#### Examples +```js +Excel.run(function (ctx) { + var lastPosition = ctx.workbook.bindings.count - 1; + var binding = ctx.workbook.bindings.getItemAt(lastPosition); + binding.load('type') + return ctx.sync().then(function() { + console.log(binding.type); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getItemAt(index: number) +Gets a binding object based on its position in the items array. + +#### Syntax +```js +bindingCollectionObject.getItemAt(index); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|index|number|Index value of the object to be retrieved. Zero-indexed.| + +#### Returns +[Binding](binding.md) + +#### Examples +```js +Excel.run(function (ctx) { + var lastPosition = ctx.workbook.bindings.count - 1; + var binding = ctx.workbook.bindings.getItemAt(lastPosition); + binding.load('type') + return ctx.sync().then(function() { + console.log(binding.type); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getItemOrNullObject(id: string) +Gets a binding object by ID. If the binding object does not exist, will return a null object. + +#### Syntax +```js +bindingCollectionObject.getItemOrNullObject(id); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|id|string|Id of the binding object to be retrieved.| + +#### Returns +[Binding](binding.md) +### Property access examples + +```js +Excel.run(function (ctx) { + var bindings = ctx.workbook.bindings; + bindings.load('items'); + return ctx.sync().then(function() { + for (var i = 0; i < bindings.items.length; i++) + { + console.log(bindings.items[i].id); + } + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` +Get the number of bindings + +```js +Excel.run(function (ctx) { + var bindings = ctx.workbook.bindings; + bindings.load('count'); + return ctx.sync().then(function() { + console.log("Bindings: Count= " + bindings.count); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` diff --git a/markdown/bindingdatachangedeventargs.md b/markdown/bindingdatachangedeventargs.md index 09c2383..e2db9ec 100644 --- a/markdown/bindingdatachangedeventargs.md +++ b/markdown/bindingdatachangedeventargs.md @@ -1,16 +1,16 @@ -# BindingDataChangedEventArgs Object (JavaScript API for Excel) - -Provides information about the binding that raised the DataChanged event. - -## Properties - -None - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|binding|[Binding](binding.md)|Gets the Binding object that represents the binding that raised the DataChanged event.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# BindingDataChangedEventArgs Object (JavaScript API for Excel) + +Provides information about the binding that raised the DataChanged event. + +## Properties + +None + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|binding|[Binding](binding.md)|Gets the Binding object that represents the binding that raised the DataChanged event.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/bindingselectionchangedeventargs.md b/markdown/bindingselectionchangedeventargs.md index 3982217..af93dad 100644 --- a/markdown/bindingselectionchangedeventargs.md +++ b/markdown/bindingselectionchangedeventargs.md @@ -1,23 +1,23 @@ -# BindingSelectionChangedEventArgs Object (JavaScript API for Excel) - -Provides information about the binding that raised the SelectionChanged event. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|columnCount|int|Gets the number of columns selected.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|rowCount|int|Gets the number of rows selected.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|startColumn|int|Gets the index of the first column of the selection (zero-based).|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|startRow|int|Gets the index of the first row of the selection (zero-based).|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|binding|[Binding](binding.md)|Gets the Binding object that represents the binding that raised the SelectionChanged event.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# BindingSelectionChangedEventArgs Object (JavaScript API for Excel) + +Provides information about the binding that raised the SelectionChanged event. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|columnCount|int|Gets the number of columns selected.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|rowCount|int|Gets the number of rows selected.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|startColumn|int|Gets the index of the first column of the selection (zero-based).|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|startRow|int|Gets the index of the first row of the selection (zero-based).|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|binding|[Binding](binding.md)|Gets the Binding object that represents the binding that raised the SelectionChanged event.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/cellvalueconditionalformat.md b/markdown/cellvalueconditionalformat.md index 197ead0..0f1e414 100644 --- a/markdown/cellvalueconditionalformat.md +++ b/markdown/cellvalueconditionalformat.md @@ -1,17 +1,17 @@ -# CellValueConditionalFormat Object (JavaScript API for Excel) - -Represents a cell value conditional format. - -## Properties - -None - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|format|[ConditionalRangeFormat](conditionalrangeformat.md)|Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|rule|[ConditionalCellValueRule](conditionalcellvaluerule.md)|Represents the Rule object on this conditional format.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# CellValueConditionalFormat Object (JavaScript API for Excel) + +Represents a cell value conditional format. + +## Properties + +None + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|format|[ConditionalRangeFormat](conditionalrangeformat.md)|Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|rule|[ConditionalCellValueRule](conditionalcellvaluerule.md)|Represents the Rule object on this conditional format.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/chart.md b/markdown/chart.md index c7cb908..b5980ad 100644 --- a/markdown/chart.md +++ b/markdown/chart.md @@ -1,236 +1,236 @@ -# Chart Object (JavaScript API for Excel) - -Represents a chart object in a workbook. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|height|double|Represents the height, in points, of the chart object.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|id|string|Gets a chart based on its position in the collection. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|left|double|The distance, in points, from the left side of the chart to the worksheet origin.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|name|string|Represents the name of a chart object.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|top|double|Represents 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).|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|width|double|Represents the width, in points, of the chart object.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|axes|[ChartAxes](chartaxes.md)|Represents chart axes. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|dataLabels|[ChartDataLabels](chartdatalabels.md)|Represents the datalabels on the chart. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|format|[ChartAreaFormat](chartareaformat.md)|Encapsulates the format properties for the chart area. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|legend|[ChartLegend](chartlegend.md)|Represents the legend for the chart. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|series|[ChartSeriesCollection](chartseriescollection.md)|Represents either a single series or collection of series in the chart. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|title|[ChartTitle](charttitle.md)|Represents the title of the specified chart, including the text, visibility, position and formating of the title. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|worksheet|[Worksheet](worksheet.md)|The worksheet containing the current chart. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[delete()](#delete)|void|Deletes the chart object.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getImage(height: number, width: number, fittingMode: string)](#getimageheight-number-width-number-fittingmode-string)|[System.IO.Stream](system.io.stream.md)|Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|[setData(sourceData: object, seriesBy: string)](#setdatasourcedata-object-seriesby-string)|void|Resets the source data for the chart.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[setPosition(startCell: object, endCell: object)](#setpositionstartcell-object-endcell-object)|void|Positions the chart relative to cells on the worksheet.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### delete() -Deletes the chart object. - -#### Syntax -```js -chartObject.delete(); -``` - -#### Parameters -None - -#### Returns -void - -#### Examples -```js -Excel.run(function (ctx) { - var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); - chart.delete(); - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -### getImage(height: number, width: number, fittingMode: string) -Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. - -#### Syntax -```js -chartObject.getImage(height, width, fittingMode); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|height|number|Optional. (Optional) The desired height of the resulting image.| -|width|number|Optional. (Optional) The desired width of the resulting image.| -|fittingMode|string|Optional. (Optional) The method used to scale the chart to the specified to the specified dimensions (if both height and width are set)." Possible values are: Fit, FitAndCenter, Fill| - -#### Returns -[System.IO.Stream](system.io.stream.md) - -#### Examples -```js -Excel.run(function (ctx) { - var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); - var image = chart.getImage(); - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - - - - -### setData(sourceData: object, seriesBy: string) -Resets the source data for the chart. - -#### Syntax -```js -chartObject.setData(sourceData, seriesBy); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|sourceData|object|The Range object corresponding to the source data.| -|seriesBy|string|Optional. Specifies the way columns or rows are used as data series on the chart. Can be one of the following: Auto (default), Rows, Columns. Possible values are: Auto, Columns, Rows| - -#### Returns -void - -#### Examples - -Set the `sourceData` to be "A1:B4" and `seriesBy` to be "Columns" - -```js -Excel.run(function (ctx) { - var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); - var sourceData = "A1:B4"; - chart.setData(sourceData, "Columns"); - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### setPosition(startCell: object, endCell: object) -Positions the chart relative to cells on the worksheet. - -#### Syntax -```js -chartObject.setPosition(startCell, endCell); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|startCell|object|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.| -|endCell|object|Optional. (Optional) The end cell. If specified, the chart's width and height will be set to fully cover up this cell/range.| - -#### Returns -void - -#### Examples - - -```js -Excel.run(function (ctx) { - var sheetName = "Charts"; - var rangeSelection = "A1:B4"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeSelection); - var sourceData = sheetName + "!" + "A1:B4"; - var chart = ctx.workbook.worksheets.getItem(sheetName).charts.add("pie", range, "auto"); - chart.width = 500; - chart.height = 300; - chart.setPosition("C2", null); - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -### Property access examples - -Get a chart named "Chart1" - -```js -Excel.run(function (ctx) { - var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); - chart.load('name'); - return ctx.sync().then(function() { - console.log(chart.name); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -Update a chart including renaming, positioning and resizing. - -```js -Excel.run(function (ctx) { - var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); - chart.name="New Name"; - chart.top = 100; - chart.left = 100; - chart.height = 200; - chart.width = 200; - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -Rename the chart to new name, resize the chart to 200 points in both height and weight. Move Chart1 to 100 points to the top and left. - -```js -Excel.run(function (ctx) { - var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); - chart.name="New Name"; - chart.top = 100; - chart.left = 100; - chart.height =200; - chart.width =200; - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - +# Chart Object (JavaScript API for Excel) + +Represents a chart object in a workbook. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|height|double|Represents the height, in points, of the chart object.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|id|string|Gets a chart based on its position in the collection. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|left|double|The distance, in points, from the left side of the chart to the worksheet origin.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|name|string|Represents the name of a chart object.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|top|double|Represents 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).|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|width|double|Represents the width, in points, of the chart object.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|axes|[ChartAxes](chartaxes.md)|Represents chart axes. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|dataLabels|[ChartDataLabels](chartdatalabels.md)|Represents the datalabels on the chart. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|format|[ChartAreaFormat](chartareaformat.md)|Encapsulates the format properties for the chart area. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|legend|[ChartLegend](chartlegend.md)|Represents the legend for the chart. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|series|[ChartSeriesCollection](chartseriescollection.md)|Represents either a single series or collection of series in the chart. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|title|[ChartTitle](charttitle.md)|Represents the title of the specified chart, including the text, visibility, position and formating of the title. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|worksheet|[Worksheet](worksheet.md)|The worksheet containing the current chart. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[delete()](#delete)|void|Deletes the chart object.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getImage(height: number, width: number, fittingMode: string)](#getimageheight-number-width-number-fittingmode-string)|[System.IO.Stream](system.io.stream.md)|Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|[setData(sourceData: object, seriesBy: string)](#setdatasourcedata-object-seriesby-string)|void|Resets the source data for the chart.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[setPosition(startCell: object, endCell: object)](#setpositionstartcell-object-endcell-object)|void|Positions the chart relative to cells on the worksheet.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### delete() +Deletes the chart object. + +#### Syntax +```js +chartObject.delete(); +``` + +#### Parameters +None + +#### Returns +void + +#### Examples +```js +Excel.run(function (ctx) { + var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + chart.delete(); + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +### getImage(height: number, width: number, fittingMode: string) +Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. + +#### Syntax +```js +chartObject.getImage(height, width, fittingMode); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|height|number|Optional. (Optional) The desired height of the resulting image.| +|width|number|Optional. (Optional) The desired width of the resulting image.| +|fittingMode|string|Optional. (Optional) The method used to scale the chart to the specified to the specified dimensions (if both height and width are set)." Possible values are: Fit, FitAndCenter, Fill| + +#### Returns +[System.IO.Stream](system.io.stream.md) + +#### Examples +```js +Excel.run(function (ctx) { + var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + var image = chart.getImage(); + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + + + + +### setData(sourceData: object, seriesBy: string) +Resets the source data for the chart. + +#### Syntax +```js +chartObject.setData(sourceData, seriesBy); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|sourceData|object|The Range object corresponding to the source data.| +|seriesBy|string|Optional. Specifies the way columns or rows are used as data series on the chart. Can be one of the following: Auto (default), Rows, Columns. Possible values are: Auto, Columns, Rows| + +#### Returns +void + +#### Examples + +Set the `sourceData` to be "A1:B4" and `seriesBy` to be "Columns" + +```js +Excel.run(function (ctx) { + var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + var sourceData = "A1:B4"; + chart.setData(sourceData, "Columns"); + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### setPosition(startCell: object, endCell: object) +Positions the chart relative to cells on the worksheet. + +#### Syntax +```js +chartObject.setPosition(startCell, endCell); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|startCell|object|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.| +|endCell|object|Optional. (Optional) The end cell. If specified, the chart's width and height will be set to fully cover up this cell/range.| + +#### Returns +void + +#### Examples + + +```js +Excel.run(function (ctx) { + var sheetName = "Charts"; + var rangeSelection = "A1:B4"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeSelection); + var sourceData = sheetName + "!" + "A1:B4"; + var chart = ctx.workbook.worksheets.getItem(sheetName).charts.add("pie", range, "auto"); + chart.width = 500; + chart.height = 300; + chart.setPosition("C2", null); + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +### Property access examples + +Get a chart named "Chart1" + +```js +Excel.run(function (ctx) { + var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + chart.load('name'); + return ctx.sync().then(function() { + console.log(chart.name); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +Update a chart including renaming, positioning and resizing. + +```js +Excel.run(function (ctx) { + var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + chart.name="New Name"; + chart.top = 100; + chart.left = 100; + chart.height = 200; + chart.width = 200; + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +Rename the chart to new name, resize the chart to 200 points in both height and weight. Move Chart1 to 100 points to the top and left. + +```js +Excel.run(function (ctx) { + var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + chart.name="New Name"; + chart.top = 100; + chart.left = 100; + chart.height =200; + chart.width =200; + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + diff --git a/markdown/chartareaformat.md b/markdown/chartareaformat.md index f17d9e5..233eb50 100644 --- a/markdown/chartareaformat.md +++ b/markdown/chartareaformat.md @@ -1,17 +1,17 @@ -# ChartAreaFormat Object (JavaScript API for Excel) - -Encapsulates the format properties for the overall chart area. - -## Properties - -None - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|fill|[ChartFill](chartfill.md)|Represents the fill format of an object, which includes background formatting information. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|font|[ChartFont](chartfont.md)|Represents the font attributes (font name, font size, color, etc.) for the current object. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# ChartAreaFormat Object (JavaScript API for Excel) + +Encapsulates the format properties for the overall chart area. + +## Properties + +None + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|fill|[ChartFill](chartfill.md)|Represents the fill format of an object, which includes background formatting information. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|font|[ChartFont](chartfont.md)|Represents the font attributes (font name, font size, color, etc.) for the current object. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/chartaxes.md b/markdown/chartaxes.md index e5013c6..c48a30e 100644 --- a/markdown/chartaxes.md +++ b/markdown/chartaxes.md @@ -1,18 +1,18 @@ -# ChartAxes Object (JavaScript API for Excel) - -Represents the chart axes. - -## Properties - -None - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|categoryAxis|[ChartAxis](chartaxis.md)|Represents the category axis in a chart. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|seriesAxis|[ChartAxis](chartaxis.md)|Represents the series axis of a 3-dimensional chart. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|valueAxis|[ChartAxis](chartaxis.md)|Represents the value axis in an axis. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# ChartAxes Object (JavaScript API for Excel) + +Represents the chart axes. + +## Properties + +None + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|categoryAxis|[ChartAxis](chartaxis.md)|Represents the category axis in a chart. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|seriesAxis|[ChartAxis](chartaxis.md)|Represents the series axis of a 3-dimensional chart. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|valueAxis|[ChartAxis](chartaxis.md)|Represents the value axis in an axis. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/chartaxis.md b/markdown/chartaxis.md index 39500a7..9a79087 100644 --- a/markdown/chartaxis.md +++ b/markdown/chartaxis.md @@ -1,67 +1,76 @@ -# ChartAxis Object (JavaScript API for Excel) - -Represents a single axis in a chart. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|majorUnit|object|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.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|maximum|object|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.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|minimum|object|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.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|minorUnit|object|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.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|format|[ChartAxisFormat](chartaxisformat.md)|Represents the formatting of a chart object, which includes line and font formatting. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|majorGridlines|[ChartGridlines](chartgridlines.md)|Returns a gridlines object that represents the major gridlines for the specified axis. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|minorGridlines|[ChartGridlines](chartgridlines.md)|Returns a Gridlines object that represents the minor gridlines for the specified axis. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|title|[ChartAxisTitle](chartaxistitle.md)|Represents the axis title. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - - -## Method Details - -### Property access examples -Get the `maximum` of Chart Axis from Chart1 - -```js -Excel.run(function (ctx) { - var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); - var axis = chart.axes.valueAxis; - axis.load('maximum'); - return ctx.sync().then(function() { - console.log(axis.maximum); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -Set the `maximum`, `minimum`, `majorunit`, `minorunit` of valueaxis. - -```js -Excel.run(function (ctx) { - var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); - chart.axes.valueAxis.maximum = 5; - chart.axes.valueAxis.minimum = 0; - chart.axes.valueAxis.majorUnit = 1; - chart.axes.valueAxis.minorUnit = 0.2; - return ctx.sync().then(function() { - console.log("Axis Settings Changed"); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` +# ChartAxis Object (JavaScript API for Excel) + +Represents a single axis in a chart. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|baseUnit|string|Returns or sets the base unit for the specified category axis. Possible values are: `Days`, `Months`, `Years`.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| +|categoryNames|string[]|Returns or sets all the category names for the specified axis, as a text array.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| +|categoryType|string|Returns or sets the category axis type. Possible values are: `Automatic`, `TextAxis`, `DateAxis`. `Automatic` specifies Excel controls the axis type.`TextAxis` specifies Axis groups data by an arbitrary set of categories.`DateAxis` specifies Axis groups data on a time scale.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| +|customDisplayUnit|double|Represents the custom value of axis display unit.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| +|displayUnit|string|Represents the axis display unit. Possible values are: `None`, `Hundreds`, `Thousands`, `TenThousands`，`HundredThousands`, `Millions`, `TenMillions`, `HundredMillons`, `Billions`, `Trillions`, `Custom`. `None` means to set default option. `Custom` means to set the axis in units of custom value.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| +|majorUnit|object|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.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|majorUnitScale|string|Returns or sets the major unit scale value for the category axis when the categoryType property is set to dateAxis. Possible values are: `Days`, `Months`, `Years`.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| +|maximum|object|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.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|minimum|object|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.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|minorUnit|object|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.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|minorUnitScale|string|Returns or sets the minor unit scale value for the category axis when the categoryType property is set to dateAxis. Possible values are: `Days`, `Months`, `Years`.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| +|showDisplayUnitLabel|bool|Represents whether the axis display unit label is visible.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| +|type|string|Represents the axis type. Read-only. Possible values are: `Category`, `Value`, `SeriesAxis`. `Category` means Axis displays categories. `Value` means Axis displays values. `SeriesAxis` means Axis displays data series.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|format|[ChartAxisFormat](chartaxisformat.md)|Represents the formatting of a chart object, which includes line and font formatting. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|majorGridlines|[ChartGridlines](chartgridlines.md)|Returns a gridlines object that represents the major gridlines for the specified axis. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|minorGridlines|[ChartGridlines](chartgridlines.md)|Returns a Gridlines object that represents the minor gridlines for the specified axis. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|title|[ChartAxisTitle](chartaxistitle.md)|Represents the axis title. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + + +## Method Details + +### Property access examples +Get the `maximum` of Chart Axis from Chart1 + +```js +Excel.run(function (ctx) { + var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + var axis = chart.axes.valueAxis; + axis.load('maximum'); + return ctx.sync().then(function() { + console.log(axis.maximum); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +Set the `maximum`, `minimum`, `majorunit`, `minorunit` of valueaxis. + +```js +Excel.run(function (ctx) { + var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + chart.axes.valueAxis.maximum = 5; + chart.axes.valueAxis.minimum = 0; + chart.axes.valueAxis.majorUnit = 1; + chart.axes.valueAxis.minorUnit = 0.2; + return ctx.sync().then(function() { + console.log("Axis Settings Changed"); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` diff --git a/markdown/chartaxisformat.md b/markdown/chartaxisformat.md index d4cce33..2590528 100644 --- a/markdown/chartaxisformat.md +++ b/markdown/chartaxisformat.md @@ -1,17 +1,17 @@ -# ChartAxisFormat Object (JavaScript API for Excel) - -Encapsulates the format properties for the chart axis. - -## Properties - -None - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|font|[ChartFont](chartfont.md)|Represents the font attributes (font name, font size, color, etc.) for a chart axis element. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|line|[ChartLineFormat](chartlineformat.md)|Represents chart line formatting. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# ChartAxisFormat Object (JavaScript API for Excel) + +Encapsulates the format properties for the chart axis. + +## Properties + +None + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|font|[ChartFont](chartfont.md)|Represents the font attributes (font name, font size, color, etc.) for a chart axis element. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|line|[ChartLineFormat](chartlineformat.md)|Represents chart line formatting. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/chartaxistitle.md b/markdown/chartaxistitle.md index e0ac7df..8e671f3 100644 --- a/markdown/chartaxistitle.md +++ b/markdown/chartaxistitle.md @@ -1,59 +1,59 @@ -# ChartAxisTitle Object (JavaScript API for Excel) - -Represents the title of a chart axis. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|text|string|Represents the axis title.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|visible|bool|A boolean that specifies the visibility of an axis title.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|format|[ChartAxisTitleFormat](chartaxistitleformat.md)|Represents the formatting of chart axis title. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - - -## Method Details - -### Property access examples -Get the `text` of Chart Axis Title from the value axis of Chart1. - -```js -Excel.run(function (ctx) { - var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); - var title = chart.axes.valueAxis.title; - title.load('text'); - return ctx.sync().then(function() { - console.log(title.text); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -Add "Values" as the title for the value Axis - -```js -Excel.run(function (ctx) { - var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); - chart.axes.valueAxis.title.text = "Values"; - return ctx.sync().then(function() { - console.log("Axis Title Added "); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` +# ChartAxisTitle Object (JavaScript API for Excel) + +Represents the title of a chart axis. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|text|string|Represents the axis title.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|visible|bool|A boolean that specifies the visibility of an axis title.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|format|[ChartAxisTitleFormat](chartaxistitleformat.md)|Represents the formatting of chart axis title. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + + +## Method Details + +### Property access examples +Get the `text` of Chart Axis Title from the value axis of Chart1. + +```js +Excel.run(function (ctx) { + var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + var title = chart.axes.valueAxis.title; + title.load('text'); + return ctx.sync().then(function() { + console.log(title.text); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +Add "Values" as the title for the value Axis + +```js +Excel.run(function (ctx) { + var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + chart.axes.valueAxis.title.text = "Values"; + return ctx.sync().then(function() { + console.log("Axis Title Added "); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` diff --git a/markdown/chartaxistitleformat.md b/markdown/chartaxistitleformat.md index 9154b7b..2d1e263 100644 --- a/markdown/chartaxistitleformat.md +++ b/markdown/chartaxistitleformat.md @@ -1,16 +1,16 @@ -# ChartAxisTitleFormat Object (JavaScript API for Excel) - -Represents the chart axis title formatting. - -## Properties - -None - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|font|[ChartFont](chartfont.md)|Represents the font attributes, such as font name, font size, color, etc. of chart axis title object. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# ChartAxisTitleFormat Object (JavaScript API for Excel) + +Represents the chart axis title formatting. + +## Properties + +None + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|font|[ChartFont](chartfont.md)|Represents the font attributes, such as font name, font size, color, etc. of chart axis title object. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/chartborder.md b/markdown/chartborder.md new file mode 100644 index 0000000..6e1a404 --- /dev/null +++ b/markdown/chartborder.md @@ -0,0 +1,51 @@ +# ChartBorder Object (JavaScript API for Excel) + +Represents the border formatting for a chart element. + +## Properties + +None + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[clear()](#clear)|void|Clear the border color of a chart element.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| +|[setSolidColor(color: string)](#setsolidcolorcolor-string)|void|Sets the border formatting of a chart element to a uniform color.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### clear() +Clear the border color of a chart element. + +#### Syntax +```js +chartBorderObject.clear(); +``` + +#### Parameters +None + +#### Returns +void + +### setSolidColor(color: string) +Sets the border formatting of a chart element to a uniform color. + +#### Syntax +```js +chartBorderObject.setSolidColor(color); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|color|string|HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").| + +#### Returns +void diff --git a/markdown/chartcollection.md b/markdown/chartcollection.md index 27d446f..60a0977 100644 --- a/markdown/chartcollection.md +++ b/markdown/chartcollection.md @@ -1,241 +1,241 @@ -# ChartCollection Object (JavaScript API for Excel) - -A collection of all the chart objects on a worksheet. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|count|int|Returns the number of charts in the worksheet. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|items|[Chart[]](chart.md)|A collection of chart objects. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[add(type: string, sourceData: object, seriesBy: string)](#addtype-string-sourcedata-object-seriesby-string)|[Chart](chart.md)|Creates a new chart.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getCount()](#getcount)|int|Returns the number of charts in the worksheet.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|[getItem(name: string)](#getitemname-string)|[Chart](chart.md)|Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getItemAt(index: number)](#getitematindex-number)|[Chart](chart.md)|Gets a chart based on its position in the collection.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getItemOrNullObject(name: string)](#getitemornullobjectname-string)|[Chart](chart.md)|Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### add(type: string, sourceData: object, seriesBy: string) -Creates a new chart. - -#### Syntax -```js -chartCollectionObject.add(type, sourceData, seriesBy); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|type|string|Represents the type of a chart. Possible values are: ColumnClustered, ColumnStacked, ColumnStacked100, BarClustered, BarStacked, BarStacked100, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, PieOfPie, etc.| -|sourceData|object|The Range object corresponding to the source data.| -|seriesBy|string|Optional. Specifies the way columns or rows are used as data series on the chart. Possible values are: Auto, Columns, Rows| - -#### Returns -[Chart](chart.md) - -#### Examples - -Add a chart of `chartType` "ColumnClustered" on worksheet "Charts" with `sourceData` from Range "A1:B4" and `seriresBy` is set to be "auto". - -```js -Excel.run(function (ctx) { - var rangeSelection = "A1:B4"; - var range = ctx.workbook.worksheets.getItem(sheetName) - .getRange(rangeSelection); - var chart = ctx.workbook.worksheets.getItem(sheetName) - .charts.add("ColumnClustered", range, "auto"); return ctx.sync().then(function() { - console.log("New Chart Added"); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getCount() -Returns the number of charts in the worksheet. - -#### Syntax -```js -chartCollectionObject.getCount(); -``` - -#### Parameters -None - -#### Returns -int - -### getItem(name: string) -Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned. - -#### Syntax -```js -chartCollectionObject.getItem(name); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|name|string|Name of the chart to be retrieved.| - -#### Returns -[Chart](chart.md) - -#### Examples - -```js -Excel.run(function (ctx) { - var chartname = 'Chart1'; - var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem(chartname); - return ctx.sync().then(function() { - console.log(chart.height); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -#### Examples - -```js -Excel.run(function (ctx) { - var chartId = 'SamplChartId'; - var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem(chartId); - return ctx.sync().then(function() { - console.log(chart.height); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - - -#### Examples - -```js -Excel.run(function (ctx) { - var lastPosition = ctx.workbook.worksheets.getItem("Sheet1").charts.count - 1; - var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItemAt(lastPosition); - return ctx.sync().then(function() { - console.log(chart.name); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getItemAt(index: number) -Gets a chart based on its position in the collection. - -#### Syntax -```js -chartCollectionObject.getItemAt(index); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|index|number|Index value of the object to be retrieved. Zero-indexed.| - -#### Returns -[Chart](chart.md) - -#### Examples - -```js -Excel.run(function (ctx) { - var lastPosition = ctx.workbook.worksheets.getItem("Sheet1").charts.count - 1; - var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItemAt(lastPosition); - return ctx.sync().then(function() { - console.log(chart.name); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getItemOrNullObject(name: string) -Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned. - -#### Syntax -```js -chartCollectionObject.getItemOrNullObject(name); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|name|string|Name of the chart to be retrieved.| - -#### Returns -[Chart](chart.md) -### Property access examples - -```js -Excel.run(function (ctx) { - var charts = ctx.workbook.worksheets.getItem("Sheet1").charts; - charts.load('items'); - return ctx.sync().then(function() { - for (var i = 0; i < charts.items.length; i++) - { - console.log(charts.items[i].name); - } - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -Get the number of charts - -```js -Excel.run(function (ctx) { - var charts = ctx.workbook.worksheets.getItem("Sheet1").charts; - charts.load('count'); - return ctx.sync().then(function() { - console.log("charts: Count= " + charts.count); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - +# ChartCollection Object (JavaScript API for Excel) + +A collection of all the chart objects on a worksheet. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|count|int|Returns the number of charts in the worksheet. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|items|[Chart[]](chart.md)|A collection of chart objects. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[add(type: string, sourceData: object, seriesBy: string)](#addtype-string-sourcedata-object-seriesby-string)|[Chart](chart.md)|Creates a new chart.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getCount()](#getcount)|int|Returns the number of charts in the worksheet.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|[getItem(name: string)](#getitemname-string)|[Chart](chart.md)|Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getItemAt(index: number)](#getitematindex-number)|[Chart](chart.md)|Gets a chart based on its position in the collection.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getItemOrNullObject(name: string)](#getitemornullobjectname-string)|[Chart](chart.md)|Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### add(type: string, sourceData: object, seriesBy: string) +Creates a new chart. + +#### Syntax +```js +chartCollectionObject.add(type, sourceData, seriesBy); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|type|string|Represents the type of a chart. Possible values are: ColumnClustered, ColumnStacked, ColumnStacked100, BarClustered, BarStacked, BarStacked100, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, PieOfPie, etc.| +|sourceData|object|The Range object corresponding to the source data.| +|seriesBy|string|Optional. Specifies the way columns or rows are used as data series on the chart. Possible values are: Auto, Columns, Rows| + +#### Returns +[Chart](chart.md) + +#### Examples + +Add a chart of `chartType` "ColumnClustered" on worksheet "Charts" with `sourceData` from Range "A1:B4" and `seriresBy` is set to be "auto". + +```js +Excel.run(function (ctx) { + var rangeSelection = "A1:B4"; + var range = ctx.workbook.worksheets.getItem(sheetName) + .getRange(rangeSelection); + var chart = ctx.workbook.worksheets.getItem(sheetName) + .charts.add("ColumnClustered", range, "auto"); return ctx.sync().then(function() { + console.log("New Chart Added"); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getCount() +Returns the number of charts in the worksheet. + +#### Syntax +```js +chartCollectionObject.getCount(); +``` + +#### Parameters +None + +#### Returns +int + +### getItem(name: string) +Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned. + +#### Syntax +```js +chartCollectionObject.getItem(name); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|name|string|Name of the chart to be retrieved.| + +#### Returns +[Chart](chart.md) + +#### Examples + +```js +Excel.run(function (ctx) { + var chartname = 'Chart1'; + var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem(chartname); + return ctx.sync().then(function() { + console.log(chart.height); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +#### Examples + +```js +Excel.run(function (ctx) { + var chartId = 'SamplChartId'; + var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem(chartId); + return ctx.sync().then(function() { + console.log(chart.height); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + + +#### Examples + +```js +Excel.run(function (ctx) { + var lastPosition = ctx.workbook.worksheets.getItem("Sheet1").charts.count - 1; + var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItemAt(lastPosition); + return ctx.sync().then(function() { + console.log(chart.name); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getItemAt(index: number) +Gets a chart based on its position in the collection. + +#### Syntax +```js +chartCollectionObject.getItemAt(index); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|index|number|Index value of the object to be retrieved. Zero-indexed.| + +#### Returns +[Chart](chart.md) + +#### Examples + +```js +Excel.run(function (ctx) { + var lastPosition = ctx.workbook.worksheets.getItem("Sheet1").charts.count - 1; + var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItemAt(lastPosition); + return ctx.sync().then(function() { + console.log(chart.name); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getItemOrNullObject(name: string) +Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned. + +#### Syntax +```js +chartCollectionObject.getItemOrNullObject(name); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|name|string|Name of the chart to be retrieved.| + +#### Returns +[Chart](chart.md) +### Property access examples + +```js +Excel.run(function (ctx) { + var charts = ctx.workbook.worksheets.getItem("Sheet1").charts; + charts.load('items'); + return ctx.sync().then(function() { + for (var i = 0; i < charts.items.length; i++) + { + console.log(charts.items[i].name); + } + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +Get the number of charts + +```js +Excel.run(function (ctx) { + var charts = ctx.workbook.worksheets.getItem("Sheet1").charts; + charts.load('count'); + return ctx.sync().then(function() { + console.log("charts: Count= " + charts.count); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + diff --git a/markdown/chartdatalabelformat.md b/markdown/chartdatalabelformat.md index 90f41bb..d06fd76 100644 --- a/markdown/chartdatalabelformat.md +++ b/markdown/chartdatalabelformat.md @@ -1,17 +1,17 @@ -# ChartDataLabelFormat Object (JavaScript API for Excel) - -Encapsulates the format properties for the chart data labels. - -## Properties - -None - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|fill|[ChartFill](chartfill.md)|Represents the fill format of the current chart data label. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|font|[ChartFont](chartfont.md)|Represents the font attributes (font name, font size, color, etc.) for a chart data label. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# ChartDataLabelFormat Object (JavaScript API for Excel) + +Encapsulates the format properties for the chart data labels. + +## Properties + +None + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|fill|[ChartFill](chartfill.md)|Represents the fill format of the current chart data label. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|font|[ChartFont](chartfont.md)|Represents the font attributes (font name, font size, color, etc.) for a chart data label. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/chartdatalabels.md b/markdown/chartdatalabels.md index ae63eec..d4b8c23 100644 --- a/markdown/chartdatalabels.md +++ b/markdown/chartdatalabels.md @@ -1,50 +1,50 @@ -# ChartDataLabels Object (JavaScript API for Excel) - -Represents a collection of all the data labels on a chart point. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|position|string|DataLabelPosition value that represents the position of the data label. Possible values are: None, Center, InsideEnd, InsideBase, OutsideEnd, Left, Right, Top, Bottom, BestFit, Callout.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|separator|string|String representing the separator used for the data labels on a chart.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|showBubbleSize|bool|Boolean value representing if the data label bubble size is visible or not.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|showCategoryName|bool|Boolean value representing if the data label category name is visible or not.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|showLegendKey|bool|Boolean value representing if the data label legend key is visible or not.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|showPercentage|bool|Boolean value representing if the data label percentage is visible or not.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|showSeriesName|bool|Boolean value representing if the data label series name is visible or not.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|showValue|bool|Boolean value representing if the data label value is visible or not.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|format|[ChartDataLabelFormat](chartdatalabelformat.md)|Represents the format of chart data labels, which includes fill and font formatting. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - - -## Method Details - -### Property access examples - -Make Series Name shown in Datalabels and set the `position` of datalabels to be "top"; - -```js -Excel.run(function (ctx) { - var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); - chart.datalabels.showValue = true; - chart.datalabels.position = "top"; - chart.datalabels.showSeriesName = true; - return ctx.sync().then(function() { - console.log("Datalabels Shown"); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` +# ChartDataLabels Object (JavaScript API for Excel) + +Represents a collection of all the data labels on a chart point. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|position|string|DataLabelPosition value that represents the position of the data label. Possible values are: None, Center, InsideEnd, InsideBase, OutsideEnd, Left, Right, Top, Bottom, BestFit, Callout.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|separator|string|String representing the separator used for the data labels on a chart.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|showBubbleSize|bool|Boolean value representing if the data label bubble size is visible or not.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|showCategoryName|bool|Boolean value representing if the data label category name is visible or not.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|showLegendKey|bool|Boolean value representing if the data label legend key is visible or not.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|showPercentage|bool|Boolean value representing if the data label percentage is visible or not.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|showSeriesName|bool|Boolean value representing if the data label series name is visible or not.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|showValue|bool|Boolean value representing if the data label value is visible or not.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|format|[ChartDataLabelFormat](chartdatalabelformat.md)|Represents the format of chart data labels, which includes fill and font formatting. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + + +## Method Details + +### Property access examples + +Make Series Name shown in Datalabels and set the `position` of datalabels to be "top"; + +```js +Excel.run(function (ctx) { + var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + chart.datalabels.showValue = true; + chart.datalabels.position = "top"; + chart.datalabels.showSeriesName = true; + return ctx.sync().then(function() { + console.log("Datalabels Shown"); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` diff --git a/markdown/chartfill.md b/markdown/chartfill.md index 7349aa4..8bf528c 100644 --- a/markdown/chartfill.md +++ b/markdown/chartfill.md @@ -1,91 +1,91 @@ -# ChartFill Object (JavaScript API for Excel) - -Represents the fill formatting for a chart element. - -## Properties - -None - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[clear()](#clear)|void|Clear the fill color of a chart element.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[setSolidColor(color: string)](#setsolidcolorcolor-string)|void|Sets the fill formatting of a chart element to a uniform color.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### clear() -Clear the fill color of a chart element. - -#### Syntax -```js -chartFillObject.clear(); -``` - -#### Parameters -None - -#### Returns -void - -#### Examples - -Clear the line format of the major Gridlines on value axis of the Chart named "Chart1" - -```js -Excel.run(function (ctx) { - var gridlines = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").axes.valueAxis.majorGridlines; - gridlines.format.line.clear(); - return ctx.sync().then(function() { - console.log("Chart Major Gridlines Format Cleared"); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -### setSolidColor(color: string) -Sets the fill formatting of a chart element to a uniform color. - -#### Syntax -```js -chartFillObject.setSolidColor(color); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|color|string|HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").| - -#### Returns -void - -#### Examples - -Set BackGround Color of Chart1 to be red. - -```js -Excel.run(function (ctx) { - var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); - - chart.format.fill.setSolidColor("#FF0000"); - - return ctx.sync().then(function() { - console.log("Chart1 Background Color Changed."); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` +# ChartFill Object (JavaScript API for Excel) + +Represents the fill formatting for a chart element. + +## Properties + +None + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[clear()](#clear)|void|Clear the fill color of a chart element.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[setSolidColor(color: string)](#setsolidcolorcolor-string)|void|Sets the fill formatting of a chart element to a uniform color.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### clear() +Clear the fill color of a chart element. + +#### Syntax +```js +chartFillObject.clear(); +``` + +#### Parameters +None + +#### Returns +void + +#### Examples + +Clear the line format of the major Gridlines on value axis of the Chart named "Chart1" + +```js +Excel.run(function (ctx) { + var gridlines = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").axes.valueAxis.majorGridlines; + gridlines.format.line.clear(); + return ctx.sync().then(function() { + console.log("Chart Major Gridlines Format Cleared"); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +### setSolidColor(color: string) +Sets the fill formatting of a chart element to a uniform color. + +#### Syntax +```js +chartFillObject.setSolidColor(color); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|color|string|HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").| + +#### Returns +void + +#### Examples + +Set BackGround Color of Chart1 to be red. + +```js +Excel.run(function (ctx) { + var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + + chart.format.fill.setSolidColor("#FF0000"); + + return ctx.sync().then(function() { + console.log("Chart1 Background Color Changed."); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` diff --git a/markdown/chartfont.md b/markdown/chartfont.md index 671ff29..a53c073 100644 --- a/markdown/chartfont.md +++ b/markdown/chartfont.md @@ -1,68 +1,68 @@ -# ChartFont Object (JavaScript API for Excel) - -This object represents the font attributes (font name, font size, color, etc.) for a chart object. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|bold|bool|Represents the bold status of font.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|color|string|HTML color code representation of the text color. E.g. #FF0000 represents Red.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|italic|bool|Represents the italic status of the font.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|name|string|Font name (e.g. "Calibri")|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|size|double|Size of the font (e.g. 11)|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|underline|string|Type of underline applied to the font. Possible values are: None, Single.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods -None - - -## Method Details - -### Property access examples - -Use chart title as an example. - -```js -Excel.run(function (ctx) { - var title = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").title; - title.format.font.name = "Calibri"; - title.format.font.size = 12; - title.format.font.color = "#FF0000"; - title.format.font.italic = false; - title.format.font.bold = true; - title.format.font.underline = "None"; - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -Set chart title to be Calbri, size 10, bold and in red. - -```js -Excel.run(function (ctx) { - var title = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").title; - title.format.font.name = "Calibri"; - title.format.font.size = 12; - title.format.font.color = "#FF0000"; - title.format.font.italic = false; - title.format.font.bold = true; - title.format.font.underline = "None"; - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` +# ChartFont Object (JavaScript API for Excel) + +This object represents the font attributes (font name, font size, color, etc.) for a chart object. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|bold|bool|Represents the bold status of font.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|color|string|HTML color code representation of the text color. E.g. #FF0000 represents Red.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|italic|bool|Represents the italic status of the font.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|name|string|Font name (e.g. "Calibri")|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|size|double|Size of the font (e.g. 11)|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|underline|string|Type of underline applied to the font. Possible values are: None, Single.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods +None + + +## Method Details + +### Property access examples + +Use chart title as an example. + +```js +Excel.run(function (ctx) { + var title = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").title; + title.format.font.name = "Calibri"; + title.format.font.size = 12; + title.format.font.color = "#FF0000"; + title.format.font.italic = false; + title.format.font.bold = true; + title.format.font.underline = "None"; + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +Set chart title to be Calbri, size 10, bold and in red. + +```js +Excel.run(function (ctx) { + var title = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").title; + title.format.font.name = "Calibri"; + title.format.font.size = 12; + title.format.font.color = "#FF0000"; + title.format.font.italic = false; + title.format.font.bold = true; + title.format.font.underline = "None"; + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` diff --git a/markdown/chartformatstring.md b/markdown/chartformatstring.md new file mode 100644 index 0000000..2242403 --- /dev/null +++ b/markdown/chartformatstring.md @@ -0,0 +1,16 @@ +# ChartFormatString Object (JavaScript API for Excel) + +Represents the characters in chart object that contains text, like chart title, chart axis title, etc. + +## Properties + +None + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|font|[ChartFont](chartfont.md)|Represents the font properties of chartFormatString object. Read-only.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/chartgridlines.md b/markdown/chartgridlines.md index 811aee0..9472b7e 100644 --- a/markdown/chartgridlines.md +++ b/markdown/chartgridlines.md @@ -1,59 +1,59 @@ -# ChartGridlines Object (JavaScript API for Excel) - -Represents major or minor gridlines on a chart axis. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|visible|bool|Boolean value representing if the axis gridlines are visible or not.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|format|[ChartGridlinesFormat](chartgridlinesformat.md)|Represents the formatting of chart gridlines. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - - -## Method Details - -### Property access examples - -Get the `visible` of Major Gridlines on value axis of Chart1 - -```js -Excel.run(function (ctx) { - var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); - var majGridlines = chart.axes.valueaxis.majorGridlines; - majGridlines.load('visible'); - return ctx.sync().then(function() { - console.log(majGridlines.visible); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -Set to show major gridlines on valueAxis of Chart1 - -```js -Excel.run(function (ctx) { - var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); - chart.axes.valueAxis.majorGridlines.visible = true; - return ctx.sync().then(function() { - console.log("Axis Gridlines Added "); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` +# ChartGridlines Object (JavaScript API for Excel) + +Represents major or minor gridlines on a chart axis. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|visible|bool|Boolean value representing if the axis gridlines are visible or not.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|format|[ChartGridlinesFormat](chartgridlinesformat.md)|Represents the formatting of chart gridlines. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + + +## Method Details + +### Property access examples + +Get the `visible` of Major Gridlines on value axis of Chart1 + +```js +Excel.run(function (ctx) { + var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + var majGridlines = chart.axes.valueaxis.majorGridlines; + majGridlines.load('visible'); + return ctx.sync().then(function() { + console.log(majGridlines.visible); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +Set to show major gridlines on valueAxis of Chart1 + +```js +Excel.run(function (ctx) { + var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + chart.axes.valueAxis.majorGridlines.visible = true; + return ctx.sync().then(function() { + console.log("Axis Gridlines Added "); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` diff --git a/markdown/chartgridlinesformat.md b/markdown/chartgridlinesformat.md index d7896e5..dad4d71 100644 --- a/markdown/chartgridlinesformat.md +++ b/markdown/chartgridlinesformat.md @@ -1,16 +1,16 @@ -# ChartGridlinesFormat Object (JavaScript API for Excel) - -Encapsulates the format properties for chart gridlines. - -## Properties - -None - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|line|[ChartLineFormat](chartlineformat.md)|Represents chart line formatting. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# ChartGridlinesFormat Object (JavaScript API for Excel) + +Encapsulates the format properties for chart gridlines. + +## Properties + +None + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|line|[ChartLineFormat](chartlineformat.md)|Represents chart line formatting. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/chartlegend.md b/markdown/chartlegend.md index f52e274..3d27b2c 100644 --- a/markdown/chartlegend.md +++ b/markdown/chartlegend.md @@ -1,63 +1,63 @@ -# ChartLegend Object (JavaScript API for Excel) - -Represents the legend in a chart. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|overlay|bool|Boolean value for whether the chart legend should overlap with the main body of the chart.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|position|string|Represents the position of the legend on the chart. Possible values are: Top, Bottom, Left, Right, Corner, Custom.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|visible|bool|A boolean value the represents the visibility of a ChartLegend object.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|format|[ChartLegendFormat](chartlegendformat.md)|Represents the formatting of a chart legend, which includes fill and font formatting. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - - -## Method Details - -### Property access examples - -Get the `position` of Chart Legend from Chart1 - -```js -Excel.run(function (ctx) { - var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); - var legend = chart.legend; - legend.load('position'); - return ctx.sync().then(function() { - console.log(legend.position); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -Set to show legend of Chart1 and make it on top of the chart. - -```js -Excel.run(function (ctx) { - var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); - chart.legend.visible = true; - chart.legend.position = "top"; - chart.legend.overlay = false; - return ctx.sync().then(function() { - console.log("Legend Shown "); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` +# ChartLegend Object (JavaScript API for Excel) + +Represents the legend in a chart. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|overlay|bool|Boolean value for whether the chart legend should overlap with the main body of the chart.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|position|string|Represents the position of the legend on the chart. Possible values are: Top, Bottom, Left, Right, Corner, Custom.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|visible|bool|A boolean value the represents the visibility of a ChartLegend object.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|format|[ChartLegendFormat](chartlegendformat.md)|Represents the formatting of a chart legend, which includes fill and font formatting. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + + +## Method Details + +### Property access examples + +Get the `position` of Chart Legend from Chart1 + +```js +Excel.run(function (ctx) { + var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + var legend = chart.legend; + legend.load('position'); + return ctx.sync().then(function() { + console.log(legend.position); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +Set to show legend of Chart1 and make it on top of the chart. + +```js +Excel.run(function (ctx) { + var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + chart.legend.visible = true; + chart.legend.position = "top"; + chart.legend.overlay = false; + return ctx.sync().then(function() { + console.log("Legend Shown "); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` diff --git a/markdown/chartlegendformat.md b/markdown/chartlegendformat.md index 6ffc7a0..0955f86 100644 --- a/markdown/chartlegendformat.md +++ b/markdown/chartlegendformat.md @@ -1,17 +1,17 @@ -# ChartLegendFormat Object (JavaScript API for Excel) - -Encapsulates the format properties of a chart legend. - -## Properties - -None - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|fill|[ChartFill](chartfill.md)|Represents the fill format of an object, which includes background formating information. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|font|[ChartFont](chartfont.md)|Represents the font attributes such as font name, font size, color, etc. of a chart legend. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# ChartLegendFormat Object (JavaScript API for Excel) + +Encapsulates the format properties of a chart legend. + +## Properties + +None + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|fill|[ChartFill](chartfill.md)|Represents the fill format of an object, which includes background formating information. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|font|[ChartFont](chartfont.md)|Represents the font attributes such as font name, font size, color, etc. of a chart legend. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/chartlineformat.md b/markdown/chartlineformat.md index 6dec6b5..6b86a0a 100644 --- a/markdown/chartlineformat.md +++ b/markdown/chartlineformat.md @@ -1,75 +1,75 @@ -# ChartLineFormat Object (JavaScript API for Excel) - -Enapsulates the formatting options for line elements. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|color|string|HTML color code representing the color of lines in the chart.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[clear()](#clear)|void|Clear the line format of a chart element.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### clear() -Clear the line format of a chart element. - -#### Syntax -```js -chartLineFormatObject.clear(); -``` - -#### Parameters -None - -#### Returns -void - -#### Examples - -Clear the line format of the major gridlines on value axis of the Chart named "Chart1" - -```js -Excel.run(function (ctx) { - var gridlines = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").axes.valueAxis.majorGridlines; - gridlines.format.line.clear(); - return ctx.sync().then(function() { - console.log("Chart Major Gridlines Format Cleared"); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` -### Property access examples - -Set chart major gridlines on value axis to be red. - -```js -Excel.run(function (ctx) { - var gridlines = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").axes.valueAxis.majorGridlines; - gridlines.format.line.color = "#FF0000"; - return ctx.sync().then(function () { - console.log("Chart Gridlines Color Updated"); - }); -}).catch(function (error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` +# ChartLineFormat Object (JavaScript API for Excel) + +Enapsulates the formatting options for line elements. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|color|string|HTML color code representing the color of lines in the chart.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[clear()](#clear)|void|Clear the line format of a chart element.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### clear() +Clear the line format of a chart element. + +#### Syntax +```js +chartLineFormatObject.clear(); +``` + +#### Parameters +None + +#### Returns +void + +#### Examples + +Clear the line format of the major gridlines on value axis of the Chart named "Chart1" + +```js +Excel.run(function (ctx) { + var gridlines = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").axes.valueAxis.majorGridlines; + gridlines.format.line.clear(); + return ctx.sync().then(function() { + console.log("Chart Major Gridlines Format Cleared"); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` +### Property access examples + +Set chart major gridlines on value axis to be red. + +```js +Excel.run(function (ctx) { + var gridlines = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").axes.valueAxis.majorGridlines; + gridlines.format.line.color = "#FF0000"; + return ctx.sync().then(function () { + console.log("Chart Gridlines Color Updated"); + }); +}).catch(function (error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` diff --git a/markdown/chartpoint.md b/markdown/chartpoint.md index e56f25d..18e4ea5 100644 --- a/markdown/chartpoint.md +++ b/markdown/chartpoint.md @@ -1,18 +1,18 @@ -# ChartPoint Object (JavaScript API for Excel) - -Represents a point of a series in a chart. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|value|object|Returns the value of a chart point. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|format|[ChartPointFormat](chartpointformat.md)|Encapsulates the format properties chart point. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# ChartPoint Object (JavaScript API for Excel) + +Represents a point of a series in a chart. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|value|object|Returns the value of a chart point. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|format|[ChartPointFormat](chartpointformat.md)|Encapsulates the format properties chart point. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/chartpointformat.md b/markdown/chartpointformat.md index ee8dc62..ec415e3 100644 --- a/markdown/chartpointformat.md +++ b/markdown/chartpointformat.md @@ -1,16 +1,17 @@ -# ChartPointFormat Object (JavaScript API for Excel) - -Represents formatting object for chart points. - -## Properties - -None - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|fill|[ChartFill](chartfill.md)|Represents the fill format of a chart, which includes background formating information. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# ChartPointFormat Object (JavaScript API for Excel) + +Represents formatting object for chart points. + +## Properties + +None + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|border|[ChartBorder](chartborder.md)|Represents the border format of a chart point, which includes border formating information. Read-only.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| +|fill|[ChartFill](chartfill.md)|Represents the fill format of a chart, which includes background formating information. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/chartpointscollection.md b/markdown/chartpointscollection.md index 5765975..9219912 100644 --- a/markdown/chartpointscollection.md +++ b/markdown/chartpointscollection.md @@ -1,108 +1,108 @@ -# ChartPointsCollection Object (JavaScript API for Excel) - -A collection of all the chart points within a series inside a chart. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|count|int|Returns the number of chart points in the series. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|items|[ChartPoint[]](chartpoint.md)|A collection of chartPoints objects. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[getCount()](#getcount)|int|Returns the number of chart points in the series.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|[getItemAt(index: number)](#getitematindex-number)|[ChartPoint](chartpoint.md)|Retrieve a point based on its position within the series.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### getCount() -Returns the number of chart points in the series. - -#### Syntax -```js -chartPointsCollectionObject.getCount(); -``` - -#### Parameters -None - -#### Returns -int - -### getItemAt(index: number) -Retrieve a point based on its position within the series. - -#### Syntax -```js -chartPointsCollectionObject.getItemAt(index); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|index|number|Index value of the object to be retrieved. Zero-indexed.| - -#### Returns -[ChartPoint](chartpoint.md) - -#### Examples -Set the border color for the first points in the points collection - -```js -Excel.run(function (ctx) { - var points = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series.getItemAt(0).points; - points.getItemAt(0).format.fill.setSolidColor("8FBC8F"); - return ctx.sync().then(function() { - console.log("Point Border Color Changed"); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -```### Property access examples - -Get the names of points in the points collection - -```js -Excel.run(function (ctx) { - var pointsCollection = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series.getItemAt(0).points; - pointsCollection.load('items'); - return ctx.sync().then(function() { - console.log("Points Collection loaded"); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -Get the number of points - -```js -Excel.run(function (ctx) { - var pointsCollection = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series.getItemAt(0).points; - pointsCollection.load('count'); - return ctx.sync().then(function() { - console.log("points: Count= " + pointsCollection.count); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` +# ChartPointsCollection Object (JavaScript API for Excel) + +A collection of all the chart points within a series inside a chart. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|count|int|Returns the number of chart points in the series. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|items|[ChartPoint[]](chartpoint.md)|A collection of chartPoints objects. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[getCount()](#getcount)|int|Returns the number of chart points in the series.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|[getItemAt(index: number)](#getitematindex-number)|[ChartPoint](chartpoint.md)|Retrieve a point based on its position within the series.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### getCount() +Returns the number of chart points in the series. + +#### Syntax +```js +chartPointsCollectionObject.getCount(); +``` + +#### Parameters +None + +#### Returns +int + +### getItemAt(index: number) +Retrieve a point based on its position within the series. + +#### Syntax +```js +chartPointsCollectionObject.getItemAt(index); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|index|number|Index value of the object to be retrieved. Zero-indexed.| + +#### Returns +[ChartPoint](chartpoint.md) + +#### Examples +Set the border color for the first points in the points collection + +```js +Excel.run(function (ctx) { + var points = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series.getItemAt(0).points; + points.getItemAt(0).format.fill.setSolidColor("8FBC8F"); + return ctx.sync().then(function() { + console.log("Point Border Color Changed"); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +```### Property access examples + +Get the names of points in the points collection + +```js +Excel.run(function (ctx) { + var pointsCollection = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series.getItemAt(0).points; + pointsCollection.load('items'); + return ctx.sync().then(function() { + console.log("Points Collection loaded"); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +Get the number of points + +```js +Excel.run(function (ctx) { + var pointsCollection = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series.getItemAt(0).points; + pointsCollection.load('count'); + return ctx.sync().then(function() { + console.log("points: Count= " + pointsCollection.count); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` diff --git a/markdown/chartseries.md b/markdown/chartseries.md index 4ada4d9..a71e453 100644 --- a/markdown/chartseries.md +++ b/markdown/chartseries.md @@ -1,42 +1,110 @@ -# ChartSeries Object (JavaScript API for Excel) - -Represents a series in a chart. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|name|string|Represents the name of a series in a chart.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|format|[ChartSeriesFormat](chartseriesformat.md)|Represents the formatting of a chart series, which includes fill and line formatting. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|points|[ChartPointsCollection](chartpointscollection.md)|Represents a collection of all points in the series. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - - -## Method Details - -### Property access examples - -Rename the 1st series of Chart1 to "New Series Name" - -```js -Excel.run(function (ctx) { - var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); - chart.series.getItemAt(0).name = "New Series Name"; - return ctx.sync().then(function() { - console.log("Series1 Renamed"); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` +# ChartSeries Object (JavaScript API for Excel) + +Represents a series in a chart. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|name|string|Represents the name of a series in a chart.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|format|[ChartSeriesFormat](chartseriesformat.md)|Represents the formatting of a chart series, which includes fill and line formatting. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|points|[ChartPointsCollection](chartpointscollection.md)|Represents a collection of all points in the series. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|trendlines|[ChartTrendlineCollection](charttrendlinecollection.md)|Represents a collection of Trendlines in the series. Read-only.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[delete()](#delete)|void|Deletes the chart series.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| +|[setBubbleSizes(sourceData: Range)](#setbubblesizessourcedata-range)|void|Set bubble sizes for a chart series. Only works for bubble charts.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| +|[setValues(sourceData: Range)](#setvaluessourcedata-range)|void|Set values for a chart series. For scatter chart, it means Y axis values.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| +|[setXAxisValues(sourceData: Range)](#setxaxisvaluessourcedata-range)|void|Set values of X axis for a chart series. Only works for scatter charts.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### delete() +Deletes the chart series. + +#### Syntax +```js +chartSeriesObject.delete(); +``` + +#### Parameters +None + +#### Returns +void + +### setBubbleSizes(sourceData: Range) +Set bubble sizes for a chart series. Only works for bubble charts. + +#### Syntax +```js +chartSeriesObject.setBubbleSizes(sourceData); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|sourceData|Range|The Range object corresponding to the source data.| + +#### Returns +void + +### setValues(sourceData: Range) +Set values for a chart series. For scatter chart, it means Y axis values. + +#### Syntax +```js +chartSeriesObject.setValues(sourceData); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|sourceData|Range|The Range object corresponding to the source data.| + +#### Returns +void + +### setXAxisValues(sourceData: Range) +Set values of X axis for a chart series. Only works for scatter charts. + +#### Syntax +```js +chartSeriesObject.setXAxisValues(sourceData); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|sourceData|Range|The Range object corresponding to the source data.| + +#### Returns +void +### Property access examples + +Rename the 1st series of Chart1 to "New Series Name" + +```js +Excel.run(function (ctx) { + var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + chart.series.getItemAt(0).name = "New Series Name"; + return ctx.sync().then(function() { + console.log("Series1 Renamed"); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` diff --git a/markdown/chartseriescollection.md b/markdown/chartseriescollection.md index e85bad8..c77769b 100644 --- a/markdown/chartseriescollection.md +++ b/markdown/chartseriescollection.md @@ -1,114 +1,132 @@ -# ChartSeriesCollection Object (JavaScript API for Excel) - -Represents a collection of chart series. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|count|int|Returns the number of series in the collection. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|items|[ChartSeries[]](chartseries.md)|A collection of chartSeries objects. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[getCount()](#getcount)|int|Returns the number of series in the collection.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|[getItemAt(index: number)](#getitematindex-number)|[ChartSeries](chartseries.md)|Retrieves a series based on its position in the collection|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### getCount() -Returns the number of series in the collection. - -#### Syntax -```js -chartSeriesCollectionObject.getCount(); -``` - -#### Parameters -None - -#### Returns -int - -### getItemAt(index: number) -Retrieves a series based on its position in the collection - -#### Syntax -```js -chartSeriesCollectionObject.getItemAt(index); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|index|number|Index value of the object to be retrieved. Zero-indexed.| - -#### Returns -[ChartSeries](chartseries.md) - -#### Examples - -Get the name of the first series in the series collection. - -```js -Excel.run(function (ctx) { - var seriesCollection = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series; - seriesCollection.load('items'); - return ctx.sync().then(function() { - console.log(seriesCollection.items[0].name); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -### Property access examples -Getting the names of series in the series collection. - -```js -Excel.run(function (ctx) { - var seriesCollection = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series; - seriesCollection.load('items'); - return ctx.sync().then(function() { - for (var i = 0; i < seriesCollection.items.length; i++) - { - console.log(seriesCollection.items[i].name); - } - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -Get the number of chart series in collection. - -```js -Excel.run(function (ctx) { - var seriesCollection = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series; - seriesCollection.load('count'); - return ctx.sync().then(function() { - console.log("series: Count= " + seriesCollection.count); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - +# ChartSeriesCollection Object (JavaScript API for Excel) + +Represents a collection of chart series. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|count|int|Returns the number of series in the collection. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|items|[ChartSeries[]](chartseries.md)|A collection of chartSeries objects. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[add(name: string, index: number)](#addname-string-index-number)|[ChartSeries](chartseries.md)|Add a new series to the collection.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| +|[getCount()](#getcount)|int|Returns the number of series in the collection.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|[getItemAt(index: number)](#getitematindex-number)|[ChartSeries](chartseries.md)|Retrieves a series based on its position in the collection.c|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### add(name: string, index: number) +Add a new series to the collection. + +#### Syntax +```js +chartSeriesCollectionObject.add(name, index); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|name|string|Optional. Name of the series.| +|index|number|Optional. Index value of the series to be added. Zero-indexed.| + +#### Returns +[ChartSeries](chartseries.md) + +### getCount() +Returns the number of series in the collection. + +#### Syntax +```js +chartSeriesCollectionObject.getCount(); +``` + +#### Parameters +None + +#### Returns +int + +### getItemAt(index: number) +Retrieves a series based on its position in the collection.c + +#### Syntax +```js +chartSeriesCollectionObject.getItemAt(index); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|index|number|Index value of the object to be retrieved. Zero-indexed.| + +#### Returns +[ChartSeries](chartseries.md) + +#### Examples + +Get the name of the first series in the series collection. + +```js +Excel.run(function (ctx) { + var seriesCollection = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series; + seriesCollection.load('items'); + return ctx.sync().then(function() { + console.log(seriesCollection.items[0].name); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +### Property access examples +Getting the names of series in the series collection. + +```js +Excel.run(function (ctx) { + var seriesCollection = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series; + seriesCollection.load('items'); + return ctx.sync().then(function() { + for (var i = 0; i < seriesCollection.items.length; i++) + { + console.log(seriesCollection.items[i].name); + } + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +Get the number of chart series in collection. + +```js +Excel.run(function (ctx) { + var seriesCollection = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series; + seriesCollection.load('count'); + return ctx.sync().then(function() { + console.log("series: Count= " + seriesCollection.count); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + diff --git a/markdown/chartseriesformat.md b/markdown/chartseriesformat.md index 64df339..750d787 100644 --- a/markdown/chartseriesformat.md +++ b/markdown/chartseriesformat.md @@ -1,17 +1,18 @@ -# ChartSeriesFormat Object (JavaScript API for Excel) - -encapsulates the format properties for the chart series - -## Properties - -None - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|fill|[ChartFill](chartfill.md)|Represents the fill format of a chart series, which includes background formating information. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|line|[ChartLineFormat](chartlineformat.md)|Represents line formatting. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# ChartSeriesFormat Object (JavaScript API for Excel) + +encapsulates the format properties for the chart series + +## Properties + +None + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|border|[ChartBorder](chartborder.md)|Represents the border format of a chart series, which includes border formating information. Read-only.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| +|fill|[ChartFill](chartfill.md)|Represents the fill format of a chart series, which includes background formating information. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|line|[ChartLineFormat](chartlineformat.md)|Represents line formatting. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/charttitle.md b/markdown/charttitle.md index e266a7d..3b66676 100644 --- a/markdown/charttitle.md +++ b/markdown/charttitle.md @@ -1,66 +1,86 @@ -# ChartTitle Object (JavaScript API for Excel) - -Represents a chart title object of a chart. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|overlay|bool|Boolean value representing if the chart title will overlay the chart or not.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|text|string|Represents the title text of a chart.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|visible|bool|A boolean value the represents the visibility of a chart title object.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|format|[ChartTitleFormat](charttitleformat.md)|Represents the formatting of a chart title, which includes fill and font formatting. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - - -## Method Details - -### Property access examples - -Get the `text` of Chart Title from Chart1. - -```js -Excel.run(function (ctx) { -var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); - -var title = chart.title; -title.load('text'); -return ctx.sync().then(function() { - console.log(title.text); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -}); -``` - -Set the `text` of Chart Title to "My Chart" and Make it show on top of the chart without overlaying. - -```js -Excel.run(function (ctx) { -var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); - -chart.title.text= "My Chart"; -chart.title.visible=true; -chart.title.overlay=true; - -return ctx.sync().then(function() { - console.log("Char Title Changed"); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -}); -``` +# ChartTitle Object (JavaScript API for Excel) + +Represents a chart title object of a chart. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|horizontalAlignment|string|Represents the horizontal alignment for chart title. Possible values are: Center, Left, Right, Justify, Distributed.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| +|overlay|bool|Boolean value representing if the chart title will overlay the chart or not.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|text|string|Represents the title text of a chart.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|visible|bool|A boolean value the represents the visibility of a chart title object.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|format|[ChartTitleFormat](charttitleformat.md)|Represents the formatting of a chart title, which includes fill and font formatting. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[getSubstring(start: number, length: number)](#getsubstringstart-number-start-number)|[ChartFormatString](chartformatstring.md)|Get the characters of a chart title. Line break '\n' also counts one charater.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### getSubstring(start: number, start: number) +Get the characters of a chart title. Line break '\n' also counts one charater. + +#### Syntax +```js +chartTitleObject.getSubstring(start, start); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|start|number|The start index of the sub string| +|length|number|The length of the sub string| + +#### Returns +[ChartFormatString](chartformatstring.md) +### Property access examples + +Get the `text` of Chart Title from Chart1. + +```js +Excel.run(function (ctx) { +var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + +var title = chart.title; +title.load('text'); +return ctx.sync().then(function() { + console.log(title.text); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +}); +``` + +Set the `text` of Chart Title to "My Chart" and Make it show on top of the chart without overlaying. + +```js +Excel.run(function (ctx) { +var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + +chart.title.text= "My Chart"; +chart.title.visible=true; +chart.title.overlay=true; + +return ctx.sync().then(function() { + console.log("Char Title Changed"); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +}); +``` diff --git a/markdown/charttitleformat.md b/markdown/charttitleformat.md index da0eae0..b78cd81 100644 --- a/markdown/charttitleformat.md +++ b/markdown/charttitleformat.md @@ -1,17 +1,17 @@ -# ChartTitleFormat Object (JavaScript API for Excel) - -Provides access to the office art formatting for chart title. - -## Properties - -None - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|fill|[ChartFill](chartfill.md)|Represents the fill format of an object, which includes background formating information. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|font|[ChartFont](chartfont.md)|Represents the font attributes (font name, font size, color, etc.) for an object. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# ChartTitleFormat Object (JavaScript API for Excel) + +Provides access to the office art formatting for chart title. + +## Properties + +None + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|fill|[ChartFill](chartfill.md)|Represents the fill format of an object, which includes background formating information. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|font|[ChartFont](chartfont.md)|Represents the font attributes (font name, font size, color, etc.) for an object. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/charttrendline.md b/markdown/charttrendline.md new file mode 100644 index 0000000..d3ef4b3 --- /dev/null +++ b/markdown/charttrendline.md @@ -0,0 +1,22 @@ +# ChartTrendline Object (JavaScript API for Excel) + +This object represents the attributes for a chart trendline object. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|movingAveragePeriod|int|Represents the period of a chart trendline, only for trendline with MovingAverage type.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| +|polynomialOrder|int|Represents the order of a chart trendline, only for trendline with Polynomial type.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| +|type|string|Represents the type of a chart trendline. Possible values are: Linear, Expontential, Logarithmic, MovingAverage, Polynomial, Power.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|format|[ChartTrendlineFormat](charttrendlineformat.md)|Represents the formatting of a chart trendline. Read-only.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/charttrendlinecollection.md b/markdown/charttrendlinecollection.md new file mode 100644 index 0000000..5e4d3dd --- /dev/null +++ b/markdown/charttrendlinecollection.md @@ -0,0 +1,55 @@ +# ChartTrendlineCollection Object (JavaScript API for Excel) + +Represents a collection of Chart Trendlines. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|items|[ChartTrendline[]](charttrendline.md)|A collection of chartTrendline objects. Read-only.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[add(type: string)](#addtype-string)|[ChartTrendline](charttrendline.md)|Adds a new trendline to trendline collection.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| +|[getCount()](#getcount)|int|Returns the number of trendlines in the collection.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### add(type: string) +Adds a new trendline to trendline collection. + +#### Syntax +```js +chartTrendlineCollectionObject.add(type); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|type|string|Optional. Specifies the trendline type. Possible values are: Linear, Expontential, Logarithmic, MovingAvg, Polynomial, Power| + +#### Returns +[ChartTrendline](charttrendline.md) + +### getCount() +Returns the number of trendlines in the collection. + +#### Syntax +```js +chartTrendlineCollectionObject.getCount(); +``` + +#### Parameters +None + +#### Returns +int diff --git a/markdown/charttrendlineformat.md b/markdown/charttrendlineformat.md new file mode 100644 index 0000000..10bdbf4 --- /dev/null +++ b/markdown/charttrendlineformat.md @@ -0,0 +1,16 @@ +# ChartTrendlineFormat Object (JavaScript API for Excel) + +Encapsulates the format properties for chart trendline. + +## Properties + +None + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|line|[ChartLineFormat](chartlineformat.md)|Represents chart line formatting. Read-only.|[1.9](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/colorscaleconditionalformat.md b/markdown/colorscaleconditionalformat.md index af41de7..5456408 100644 --- a/markdown/colorscaleconditionalformat.md +++ b/markdown/colorscaleconditionalformat.md @@ -1,20 +1,20 @@ -# ColorScaleConditionalFormat Object (JavaScript API for Excel) - -Represents an IconSet criteria for conditional formatting. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|threeColorScale|bool|If true the color scale will have three points (minimum, midpoint, maximum), otherwise it will have two (minimum, maximum). Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|criteria|[ConditionalColorScaleCriteria](conditionalcolorscalecriteria.md)|The criteria of the color scale. Midpoint is optional when using a two point color scale.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# ColorScaleConditionalFormat Object (JavaScript API for Excel) + +Represents an IconSet criteria for conditional formatting. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|threeColorScale|bool|If true the color scale will have three points (minimum, midpoint, maximum), otherwise it will have two (minimum, maximum). Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|criteria|[ConditionalColorScaleCriteria](conditionalcolorscalecriteria.md)|The criteria of the color scale. Midpoint is optional when using a two point color scale.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/conditionalcellvaluerule.md b/markdown/conditionalcellvaluerule.md index 83e185c..71785fd 100644 --- a/markdown/conditionalcellvaluerule.md +++ b/markdown/conditionalcellvaluerule.md @@ -1,21 +1,21 @@ -# ConditionalCellValueRule Object (JavaScript API for Excel) - -Represents a Cell Value Conditional Format Rule - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|formula1|object|The formula, if required, to evaluate the conditional format rule on.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|formula2|object|The formula, if required, to evaluate the conditional format rule on.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|operator|string|The operator of the text conditional format. Possible values are: Invalid, Between, NotBetween, EqualTo, NotEqualTo, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods -None - +# ConditionalCellValueRule Object (JavaScript API for Excel) + +Represents a Cell Value Conditional Format Rule + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|formula1|object|The formula, if required, to evaluate the conditional format rule on.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|formula2|object|The formula, if required, to evaluate the conditional format rule on.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|operator|string|The operator of the text conditional format. Possible values are: Invalid, Between, NotBetween, EqualTo, NotEqualTo, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods +None + diff --git a/markdown/conditionalcolorscalecriteria.md b/markdown/conditionalcolorscalecriteria.md index 9661042..49248a4 100644 --- a/markdown/conditionalcolorscalecriteria.md +++ b/markdown/conditionalcolorscalecriteria.md @@ -1,18 +1,18 @@ -# ConditionalColorScaleCriteria Object (JavaScript API for Excel) - -Represents the criteria of the color scale. - -## Properties - -None - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|maximum|[ConditionalColorScaleCriterion](conditionalcolorscalecriterion.md)|The maximum point Color Scale Criterion.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|midpoint|[ConditionalColorScaleCriterion](conditionalcolorscalecriterion.md)|The midpoint Color Scale Criterion if the color scale is a 3-color scale.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|minimum|[ConditionalColorScaleCriterion](conditionalcolorscalecriterion.md)|The minimum point Color Scale Criterion.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# ConditionalColorScaleCriteria Object (JavaScript API for Excel) + +Represents the criteria of the color scale. + +## Properties + +None + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|maximum|[ConditionalColorScaleCriterion](conditionalcolorscalecriterion.md)|The maximum point Color Scale Criterion.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|midpoint|[ConditionalColorScaleCriterion](conditionalcolorscalecriterion.md)|The midpoint Color Scale Criterion if the color scale is a 3-color scale.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|minimum|[ConditionalColorScaleCriterion](conditionalcolorscalecriterion.md)|The minimum point Color Scale Criterion.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/conditionalcolorscalecriterion.md b/markdown/conditionalcolorscalecriterion.md index 899a236..20e6c2f 100644 --- a/markdown/conditionalcolorscalecriterion.md +++ b/markdown/conditionalcolorscalecriterion.md @@ -1,21 +1,21 @@ -# ConditionalColorScaleCriterion Object (JavaScript API for Excel) - -Represents a Color Scale Criterion which contains a type, value and a color. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|color|string|HTML color code representation of the color scale color. E.g. #FF0000 represents Red.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|formula|object|A number, a formula, or null (if Type is LowestValue).|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|type|string|What the icon conditional formula should be based on. Possible values are: Invalid, LowestValue, HighestValue, Number, Percent, Formula, Percentile.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods -None - +# ConditionalColorScaleCriterion Object (JavaScript API for Excel) + +Represents a Color Scale Criterion which contains a type, value and a color. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|color|string|HTML color code representation of the color scale color. E.g. #FF0000 represents Red.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|formula|object|A number, a formula, or null (if Type is LowestValue).|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|type|string|What the icon conditional formula should be based on. Possible values are: Invalid, LowestValue, HighestValue, Number, Percent, Formula, Percentile.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods +None + diff --git a/markdown/conditionaldatabarnegativeformat.md b/markdown/conditionaldatabarnegativeformat.md index 56b44a4..b57b5e0 100644 --- a/markdown/conditionaldatabarnegativeformat.md +++ b/markdown/conditionaldatabarnegativeformat.md @@ -1,22 +1,22 @@ -# ConditionalDataBarNegativeFormat Object (JavaScript API for Excel) - -Represents a conditional format DataBar Format for the negative side of the data bar. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|borderColor|string|HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|fillColor|string|HTML color code representing the fill color, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|matchPositiveBorderColor|bool|Boolean representation of whether or not the negative DataBar has the same border color as the positive DataBar.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|matchPositiveFillColor|bool|Boolean representation of whether or not the negative DataBar has the same fill color as the positive DataBar.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods -None - +# ConditionalDataBarNegativeFormat Object (JavaScript API for Excel) + +Represents a conditional format DataBar Format for the negative side of the data bar. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|borderColor|string|HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|fillColor|string|HTML color code representing the fill color, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|matchPositiveBorderColor|bool|Boolean representation of whether or not the negative DataBar has the same border color as the positive DataBar.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|matchPositiveFillColor|bool|Boolean representation of whether or not the negative DataBar has the same fill color as the positive DataBar.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods +None + diff --git a/markdown/conditionaldatabarpositiveformat.md b/markdown/conditionaldatabarpositiveformat.md index 069d44a..ce6cfab 100644 --- a/markdown/conditionaldatabarpositiveformat.md +++ b/markdown/conditionaldatabarpositiveformat.md @@ -1,21 +1,21 @@ -# ConditionalDataBarPositiveFormat Object (JavaScript API for Excel) - -Represents a conditional format DataBar Format for the positive side of the data bar. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|borderColor|string|HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|fillColor|string|HTML color code representing the fill color, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|gradientFill|bool|Boolean representation of whether or not the DataBar has a gradient.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods -None - +# ConditionalDataBarPositiveFormat Object (JavaScript API for Excel) + +Represents a conditional format DataBar Format for the positive side of the data bar. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|borderColor|string|HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|fillColor|string|HTML color code representing the fill color, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|gradientFill|bool|Boolean representation of whether or not the DataBar has a gradient.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods +None + diff --git a/markdown/conditionaldatabarrule.md b/markdown/conditionaldatabarrule.md index 459946d..4a9c39e 100644 --- a/markdown/conditionaldatabarrule.md +++ b/markdown/conditionaldatabarrule.md @@ -1,20 +1,20 @@ -# ConditionalDataBarRule Object (JavaScript API for Excel) - -Represents a rule-type for a Data Bar. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|formula|object|The formula, if required, to evaluate the databar rule on.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|type|string|The type of rule for the databar. Possible values are: LowestValue, HighestValue, Number, Percent, Formula, Percentile, Automatic.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods -None - +# ConditionalDataBarRule Object (JavaScript API for Excel) + +Represents a rule-type for a Data Bar. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|formula|object|The formula, if required, to evaluate the databar rule on.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|type|string|The type of rule for the databar. Possible values are: LowestValue, HighestValue, Number, Percent, Formula, Percentile, Automatic.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods +None + diff --git a/markdown/conditionalformat.md b/markdown/conditionalformat.md index e42b85d..a09b929 100644 --- a/markdown/conditionalformat.md +++ b/markdown/conditionalformat.md @@ -1,87 +1,87 @@ -# ConditionalFormat Object (JavaScript API for Excel) - -An object encapsulating a conditional format's range, format, rule, and other properties. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|priority|int|The priority (or index) within the conditional format collection that this conditional format currently exists in. Changing this also|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|stopIfTrue|bool|If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|type|string|A type of conditional format. Only one can be set at a time. Read-Only. Read-only. Possible values are: Custom, DataBar, ColorScale, IconSet.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|cellValue|[CellValueConditionalFormat](cellvalueconditionalformat.md)|Returns the cell value conditional format properties if the current conditional format is a CellValue type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|cellValueOrNullObject|[CellValueConditionalFormat](cellvalueconditionalformat.md)|Returns the cell value conditional format properties if the current conditional format is a CellValue type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|colorScale|[ColorScaleConditionalFormat](colorscaleconditionalformat.md)|Returns the ColorScale conditional format properties if the current conditional format is an ColorScale type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|colorScaleOrNullObject|[ColorScaleConditionalFormat](colorscaleconditionalformat.md)|Returns the ColorScale conditional format properties if the current conditional format is an ColorScale type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|custom|[CustomConditionalFormat](customconditionalformat.md)|Returns the custom conditional format properties if the current conditional format is a custom type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|customOrNullObject|[CustomConditionalFormat](customconditionalformat.md)|Returns the custom conditional format properties if the current conditional format is a custom type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|dataBar|[DataBarConditionalFormat](databarconditionalformat.md)|Returns the data bar properties if the current conditional format is a data bar. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|dataBarOrNullObject|[DataBarConditionalFormat](databarconditionalformat.md)|Returns the data bar properties if the current conditional format is a data bar. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|iconSet|[IconSetConditionalFormat](iconsetconditionalformat.md)|Returns the IconSet conditional format properties if the current conditional format is an IconSet type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|iconSetOrNullObject|[IconSetConditionalFormat](iconsetconditionalformat.md)|Returns the IconSet conditional format properties if the current conditional format is an IconSet type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|preset|[PresetCriteriaConditionalFormat](presetcriteriaconditionalformat.md)|Returns the preset criteria conditional format such as above averagebelow averageunique valuescontains blanknonblankerrornoerror properties. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|presetOrNullObject|[PresetCriteriaConditionalFormat](presetcriteriaconditionalformat.md)|Returns the preset criteria conditional format such as above averagebelow averageunique valuescontains blanknonblankerrornoerror properties. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|textComparison|[TextConditionalFormat](textconditionalformat.md)|Returns the specific text conditional format properties if the current conditional format is a text type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|textComparisonOrNullObject|[TextConditionalFormat](textconditionalformat.md)|Returns the specific text conditional format properties if the current conditional format is a text type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|topBottom|[TopBottomConditionalFormat](topbottomconditionalformat.md)|Returns the TopBottom conditional format properties if the current conditional format is an TopBottom type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|topBottomOrNullObject|[TopBottomConditionalFormat](topbottomconditionalformat.md)|Returns the TopBottom conditional format properties if the current conditional format is an TopBottom type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[delete()](#delete)|void|Deletes this conditional format.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|[getRange()](#getrange)|[Range](range.md)|Returns the range the conditonal format is applied to or a null object if the range is discontiguous. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|[getRangeOrNullObject()](#getrangeornullobject)|[Range](range.md)|Returns the range the conditonal format is applied to or a null object if the range is discontiguous. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### delete() -Deletes this conditional format. - -#### Syntax -```js -conditionalFormatObject.delete(); -``` - -#### Parameters -None - -#### Returns -void - -### getRange() -Returns the range the conditonal format is applied to or a null object if the range is discontiguous. Read-only. - -#### Syntax -```js -conditionalFormatObject.getRange(); -``` - -#### Parameters -None - -#### Returns -[Range](range.md) - -### getRangeOrNullObject() -Returns the range the conditonal format is applied to or a null object if the range is discontiguous. Read-only. - -#### Syntax -```js -conditionalFormatObject.getRangeOrNullObject(); -``` - -#### Parameters -None - -#### Returns -[Range](range.md) -### Property access examples +# ConditionalFormat Object (JavaScript API for Excel) + +An object encapsulating a conditional format's range, format, rule, and other properties. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|priority|int|The priority (or index) within the conditional format collection that this conditional format currently exists in. Changing this also|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|stopIfTrue|bool|If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|type|string|A type of conditional format. Only one can be set at a time. Read-Only. Read-only. Possible values are: Custom, DataBar, ColorScale, IconSet.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|cellValue|[CellValueConditionalFormat](cellvalueconditionalformat.md)|Returns the cell value conditional format properties if the current conditional format is a CellValue type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|cellValueOrNullObject|[CellValueConditionalFormat](cellvalueconditionalformat.md)|Returns the cell value conditional format properties if the current conditional format is a CellValue type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|colorScale|[ColorScaleConditionalFormat](colorscaleconditionalformat.md)|Returns the ColorScale conditional format properties if the current conditional format is an ColorScale type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|colorScaleOrNullObject|[ColorScaleConditionalFormat](colorscaleconditionalformat.md)|Returns the ColorScale conditional format properties if the current conditional format is an ColorScale type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|custom|[CustomConditionalFormat](customconditionalformat.md)|Returns the custom conditional format properties if the current conditional format is a custom type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|customOrNullObject|[CustomConditionalFormat](customconditionalformat.md)|Returns the custom conditional format properties if the current conditional format is a custom type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|dataBar|[DataBarConditionalFormat](databarconditionalformat.md)|Returns the data bar properties if the current conditional format is a data bar. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|dataBarOrNullObject|[DataBarConditionalFormat](databarconditionalformat.md)|Returns the data bar properties if the current conditional format is a data bar. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|iconSet|[IconSetConditionalFormat](iconsetconditionalformat.md)|Returns the IconSet conditional format properties if the current conditional format is an IconSet type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|iconSetOrNullObject|[IconSetConditionalFormat](iconsetconditionalformat.md)|Returns the IconSet conditional format properties if the current conditional format is an IconSet type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|preset|[PresetCriteriaConditionalFormat](presetcriteriaconditionalformat.md)|Returns the preset criteria conditional format such as above averagebelow averageunique valuescontains blanknonblankerrornoerror properties. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|presetOrNullObject|[PresetCriteriaConditionalFormat](presetcriteriaconditionalformat.md)|Returns the preset criteria conditional format such as above averagebelow averageunique valuescontains blanknonblankerrornoerror properties. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|textComparison|[TextConditionalFormat](textconditionalformat.md)|Returns the specific text conditional format properties if the current conditional format is a text type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|textComparisonOrNullObject|[TextConditionalFormat](textconditionalformat.md)|Returns the specific text conditional format properties if the current conditional format is a text type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|topBottom|[TopBottomConditionalFormat](topbottomconditionalformat.md)|Returns the TopBottom conditional format properties if the current conditional format is an TopBottom type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|topBottomOrNullObject|[TopBottomConditionalFormat](topbottomconditionalformat.md)|Returns the TopBottom conditional format properties if the current conditional format is an TopBottom type. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[delete()](#delete)|void|Deletes this conditional format.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|[getRange()](#getrange)|[Range](range.md)|Returns the range the conditonal format is applied to or a null object if the range is discontiguous. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|[getRangeOrNullObject()](#getrangeornullobject)|[Range](range.md)|Returns the range the conditonal format is applied to or a null object if the range is discontiguous. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### delete() +Deletes this conditional format. + +#### Syntax +```js +conditionalFormatObject.delete(); +``` + +#### Parameters +None + +#### Returns +void + +### getRange() +Returns the range the conditonal format is applied to or a null object if the range is discontiguous. Read-only. + +#### Syntax +```js +conditionalFormatObject.getRange(); +``` + +#### Parameters +None + +#### Returns +[Range](range.md) + +### getRangeOrNullObject() +Returns the range the conditonal format is applied to or a null object if the range is discontiguous. Read-only. + +#### Syntax +```js +conditionalFormatObject.getRangeOrNullObject(); +``` + +#### Parameters +None + +#### Returns +[Range](range.md) +### Property access examples diff --git a/markdown/conditionalformatcollection.md b/markdown/conditionalformatcollection.md index da85d14..c105238 100644 --- a/markdown/conditionalformatcollection.md +++ b/markdown/conditionalformatcollection.md @@ -1,165 +1,165 @@ -# ConditionalFormatCollection Object (JavaScript API for Excel) - -Represents a collection of all the conditional formats that are overlap the range. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|items|[ConditionalFormat[]](conditionalformat.md)|A collection of conditionalFormat objects. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[add(type: string)](#addtype-string)|[ConditionalFormat](conditionalformat.md)|Adds a new conditional format to the collection at the firsttop priority.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|[clearAll()](#clearall)|void|Clears all conditional formats active on the current specified range.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|[getCount()](#getcount)|int|Returns the number of conditional formats in the workbook. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|[getItemAt(index: number)](#getitematindex-number)|[ConditionalFormat](conditionalformat.md)|Returns a conditional format at the given index.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### add(type: string) -Adds a new conditional format to the collection at the firsttop priority. - -#### Syntax -```js -conditionalFormatCollectionObject.add(type); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|type|string|The type of conditional format being added. Possible values are: Custom, DataBar, ColorScale, IconSet| - -#### Returns -[ConditionalFormat](conditionalformat.md) - -#### Examples -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "A1:C3"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); - var conditionalFormat = range.conditionalFormats.add(Excel.ConditionalFormatType.iconSet); - conditionalFormat.iconOrNull.style = "YellowThreeArrows"; - return ctx.sync().then(function () { - console.log("Added new yellow three arrow icon set."); - }); -}).catch(function (error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } - }); -``` - - -### clearAll() -Clears all conditional formats active on the current specified range. - -#### Syntax -```js -conditionalFormatCollectionObject.clearAll(); -``` - -#### Parameters -None - -#### Returns -void - -#### Examples -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "A1:C3"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); - var conditionalFormats = range.conditionalFormats; - var conditionalFormat = conditionalFormats.clearAll(); - return ctx.sync().then(function () { - console.log("Cleared all conditional formats from this range."); - }); -}).catch(function (error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } - }); -``` - - -### getCount() -Returns the number of conditional formats in the workbook. Read-only. - -#### Syntax -```js -conditionalFormatCollectionObject.getCount(); -``` - -#### Parameters -None - -#### Returns -int - -#### Examples -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "A1:C3"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); - var conditionalFormat = range.conditionalFormats.add(Excel.ConditionalFormatType.iconSet); - conditionalFormat.iconOrNull.style = Excel.IconSet.fourTrafficLights; - var cfCount = range.conditionalFormats.getCount(); - - return ctx.sync().then(function () { - console.log("Count: " + cfCount.value); - }); -}).catch(function (error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` -### getItemAt(index: number) -Returns a conditional format at the given index. - -#### Syntax -```js -conditionalFormatCollectionObject.getItemAt(index); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|index|number|Index of the conditional formats to be retrieved.| - -#### Returns -[ConditionalFormat](conditionalformat.md) - -#### Examples -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "A1:C3"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); - var conditionalFormats = range.conditionalFormats; - var conditionalFormat = conditionalFormats.getItemAt(3); - return ctx.sync().then(function () { - console.log("Conditional Format at Item 3 Loaded"); - }); -}).catch(function (error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } - }); -``` - +# ConditionalFormatCollection Object (JavaScript API for Excel) + +Represents a collection of all the conditional formats that are overlap the range. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|items|[ConditionalFormat[]](conditionalformat.md)|A collection of conditionalFormat objects. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[add(type: string)](#addtype-string)|[ConditionalFormat](conditionalformat.md)|Adds a new conditional format to the collection at the firsttop priority.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|[clearAll()](#clearall)|void|Clears all conditional formats active on the current specified range.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|[getCount()](#getcount)|int|Returns the number of conditional formats in the workbook. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|[getItemAt(index: number)](#getitematindex-number)|[ConditionalFormat](conditionalformat.md)|Returns a conditional format at the given index.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### add(type: string) +Adds a new conditional format to the collection at the firsttop priority. + +#### Syntax +```js +conditionalFormatCollectionObject.add(type); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|type|string|The type of conditional format being added. Possible values are: Custom, DataBar, ColorScale, IconSet| + +#### Returns +[ConditionalFormat](conditionalformat.md) + +#### Examples +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "A1:C3"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + var conditionalFormat = range.conditionalFormats.add(Excel.ConditionalFormatType.iconSet); + conditionalFormat.iconOrNull.style = "YellowThreeArrows"; + return ctx.sync().then(function () { + console.log("Added new yellow three arrow icon set."); + }); +}).catch(function (error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } + }); +``` + + +### clearAll() +Clears all conditional formats active on the current specified range. + +#### Syntax +```js +conditionalFormatCollectionObject.clearAll(); +``` + +#### Parameters +None + +#### Returns +void + +#### Examples +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "A1:C3"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + var conditionalFormats = range.conditionalFormats; + var conditionalFormat = conditionalFormats.clearAll(); + return ctx.sync().then(function () { + console.log("Cleared all conditional formats from this range."); + }); +}).catch(function (error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } + }); +``` + + +### getCount() +Returns the number of conditional formats in the workbook. Read-only. + +#### Syntax +```js +conditionalFormatCollectionObject.getCount(); +``` + +#### Parameters +None + +#### Returns +int + +#### Examples +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "A1:C3"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + var conditionalFormat = range.conditionalFormats.add(Excel.ConditionalFormatType.iconSet); + conditionalFormat.iconOrNull.style = Excel.IconSet.fourTrafficLights; + var cfCount = range.conditionalFormats.getCount(); + + return ctx.sync().then(function () { + console.log("Count: " + cfCount.value); + }); +}).catch(function (error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` +### getItemAt(index: number) +Returns a conditional format at the given index. + +#### Syntax +```js +conditionalFormatCollectionObject.getItemAt(index); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|index|number|Index of the conditional formats to be retrieved.| + +#### Returns +[ConditionalFormat](conditionalformat.md) + +#### Examples +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "A1:C3"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + var conditionalFormats = range.conditionalFormats; + var conditionalFormat = conditionalFormats.getItemAt(3); + return ctx.sync().then(function () { + console.log("Conditional Format at Item 3 Loaded"); + }); +}).catch(function (error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } + }); +``` + diff --git a/markdown/conditionalformatrule.md b/markdown/conditionalformatrule.md index 11a9f98..fb2277c 100644 --- a/markdown/conditionalformatrule.md +++ b/markdown/conditionalformatrule.md @@ -1,21 +1,21 @@ -# ConditionalFormatRule Object (JavaScript API for Excel) - -Represents a rule, for all traditional ruleformat pairings. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|formula|object|The formula, if required, to evaluate the conditional format rule on.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|formulaLocal|object|The formula, if required, to evaluate the conditional format rule on in the user's language.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|formulaR1C1|object|The formula, if required, to evaluate the conditional format rule on in R1C1-style notation.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods -None - +# ConditionalFormatRule Object (JavaScript API for Excel) + +Represents a rule, for all traditional ruleformat pairings. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|formula|object|The formula, if required, to evaluate the conditional format rule on.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|formulaLocal|object|The formula, if required, to evaluate the conditional format rule on in the user's language.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|formulaR1C1|object|The formula, if required, to evaluate the conditional format rule on in R1C1-style notation.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods +None + diff --git a/markdown/conditionaliconcriterion.md b/markdown/conditionaliconcriterion.md index 29d337c..62be87a 100644 --- a/markdown/conditionaliconcriterion.md +++ b/markdown/conditionaliconcriterion.md @@ -1,22 +1,22 @@ -# ConditionalIconCriterion Object (JavaScript API for Excel) - -Represents an Icon Criterion which contains a type, value, an Operator, and an optional custom icon, if not using an iconset. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|formula|object|A number or a formula depending on the type.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|operator|string|GreaterThan or GreaterThanOrEqual for each of the rule type for the Icon conditional format. Possible values are: Invalid, GreaterThan, GreaterThanOrEqual.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|customIcon|[Icon](icon.md)|The custom icon for the current criterion if different from the default IconSet, else null will be returned.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|type|[ConditionalFormatIconRuleType](conditionalformaticonruletype.md)|What the icon conditional formula should be based on.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# ConditionalIconCriterion Object (JavaScript API for Excel) + +Represents an Icon Criterion which contains a type, value, an Operator, and an optional custom icon, if not using an iconset. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|formula|object|A number or a formula depending on the type.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|operator|string|GreaterThan or GreaterThanOrEqual for each of the rule type for the Icon conditional format. Possible values are: Invalid, GreaterThan, GreaterThanOrEqual.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|customIcon|[Icon](icon.md)|The custom icon for the current criterion if different from the default IconSet, else null will be returned.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|type|[ConditionalFormatIconRuleType](conditionalformaticonruletype.md)|What the icon conditional formula should be based on.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/conditionalpresetcriteriarule.md b/markdown/conditionalpresetcriteriarule.md index 104d0f2..db102ce 100644 --- a/markdown/conditionalpresetcriteriarule.md +++ b/markdown/conditionalpresetcriteriarule.md @@ -1,19 +1,19 @@ -# ConditionalPresetCriteriaRule Object (JavaScript API for Excel) - -Represents the Preset Criteria Conditional Format Rule - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|criterion|string|The criterion of the conditional format. Possible values are: Invalid, Blanks, NonBlanks, Errors, NonErrors, Yesterday, Today, Tomorrow, LastSevenDays, LastWeek, ThisWeek, NextWeek, LastMonth, ThisMonth, NextMonth, AboveAverage, BelowAverage, EqualOrAboveAverage, EqualOrBelowAverage, OneStdDevAboveAverage, OneStdDevBelowAverage, TwoStdDevAboveAverage, TwoStdDevBelowAverage, ThreeStdDevAboveAverage, ThreeStdDevBelowAverage, UniqueValues, DuplicateValues.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods -None - +# ConditionalPresetCriteriaRule Object (JavaScript API for Excel) + +Represents the Preset Criteria Conditional Format Rule + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|criterion|string|The criterion of the conditional format. Possible values are: Invalid, Blanks, NonBlanks, Errors, NonErrors, Yesterday, Today, Tomorrow, LastSevenDays, LastWeek, ThisWeek, NextWeek, LastMonth, ThisMonth, NextMonth, AboveAverage, BelowAverage, EqualOrAboveAverage, EqualOrBelowAverage, OneStdDevAboveAverage, OneStdDevBelowAverage, TwoStdDevAboveAverage, TwoStdDevBelowAverage, ThreeStdDevAboveAverage, ThreeStdDevBelowAverage, UniqueValues, DuplicateValues.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods +None + diff --git a/markdown/conditionalrangeborder.md b/markdown/conditionalrangeborder.md index 5337d61..187ff8f 100644 --- a/markdown/conditionalrangeborder.md +++ b/markdown/conditionalrangeborder.md @@ -1,22 +1,22 @@ -# ConditionalRangeBorder Object (JavaScript API for Excel) - -Represents the border of an object. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|color|string|HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|id|string|Represents border identifier. Read-only. Possible values are: EdgeTop, EdgeBottom, EdgeLeft, EdgeRight.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|sideIndex|string|Constant value that indicates the specific side of the border. Read-only. Possible values are: EdgeTop, EdgeBottom, EdgeLeft, EdgeRight.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|style|string|One of the constants of line style specifying the line style for the border. Possible values are: None, Continuous, Dash, DashDot, DashDotDot, Dot, Double, SlantDashDot.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods -None - +# ConditionalRangeBorder Object (JavaScript API for Excel) + +Represents the border of an object. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|color|string|HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|id|string|Represents border identifier. Read-only. Possible values are: EdgeTop, EdgeBottom, EdgeLeft, EdgeRight.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|sideIndex|string|Constant value that indicates the specific side of the border. Read-only. Possible values are: EdgeTop, EdgeBottom, EdgeLeft, EdgeRight.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|style|string|One of the constants of line style specifying the line style for the border. Possible values are: None, Continuous, Dash, DashDot, DashDotDot, Dot, Double, SlantDashDot.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods +None + diff --git a/markdown/conditionalrangebordercollection.md b/markdown/conditionalrangebordercollection.md index 22be91c..e48501c 100644 --- a/markdown/conditionalrangebordercollection.md +++ b/markdown/conditionalrangebordercollection.md @@ -1,62 +1,62 @@ -# ConditionalRangeBorderCollection Object (JavaScript API for Excel) - -Represents the border objects that make up range border. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|count|int|Number of border objects in the collection. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|items|[ConditionalRangeBorder[]](conditionalrangeborder.md)|A collection of conditionalRangeBorder objects. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|bottom|[ConditionalRangeBorder](conditionalrangeborder.md)|Gets the top border Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|left|[ConditionalRangeBorder](conditionalrangeborder.md)|Gets the top border Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|right|[ConditionalRangeBorder](conditionalrangeborder.md)|Gets the top border Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|top|[ConditionalRangeBorder](conditionalrangeborder.md)|Gets the top border Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[getItem(index: string)](#getitemindex-string)|[ConditionalRangeBorder](conditionalrangeborder.md)|Gets a border object using its name|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|[getItemAt(index: number)](#getitematindex-number)|[ConditionalRangeBorder](conditionalrangeborder.md)|Gets a border object using its index|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### getItem(index: string) -Gets a border object using its name - -#### Syntax -```js -conditionalRangeBorderCollectionObject.getItem(index); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|index|string|Index value of the border object to be retrieved. Possible values are: EdgeTop, EdgeBottom, EdgeLeft, EdgeRight| - -#### Returns -[ConditionalRangeBorder](conditionalrangeborder.md) - -### getItemAt(index: number) -Gets a border object using its index - -#### Syntax -```js -conditionalRangeBorderCollectionObject.getItemAt(index); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|index|number|Index value of the object to be retrieved. Zero-indexed.| - -#### Returns -[ConditionalRangeBorder](conditionalrangeborder.md) +# ConditionalRangeBorderCollection Object (JavaScript API for Excel) + +Represents the border objects that make up range border. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|count|int|Number of border objects in the collection. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|items|[ConditionalRangeBorder[]](conditionalrangeborder.md)|A collection of conditionalRangeBorder objects. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|bottom|[ConditionalRangeBorder](conditionalrangeborder.md)|Gets the top border Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|left|[ConditionalRangeBorder](conditionalrangeborder.md)|Gets the top border Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|right|[ConditionalRangeBorder](conditionalrangeborder.md)|Gets the top border Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|top|[ConditionalRangeBorder](conditionalrangeborder.md)|Gets the top border Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[getItem(index: string)](#getitemindex-string)|[ConditionalRangeBorder](conditionalrangeborder.md)|Gets a border object using its name|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|[getItemAt(index: number)](#getitematindex-number)|[ConditionalRangeBorder](conditionalrangeborder.md)|Gets a border object using its index|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### getItem(index: string) +Gets a border object using its name + +#### Syntax +```js +conditionalRangeBorderCollectionObject.getItem(index); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|index|string|Index value of the border object to be retrieved. Possible values are: EdgeTop, EdgeBottom, EdgeLeft, EdgeRight| + +#### Returns +[ConditionalRangeBorder](conditionalrangeborder.md) + +### getItemAt(index: number) +Gets a border object using its index + +#### Syntax +```js +conditionalRangeBorderCollectionObject.getItemAt(index); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|index|number|Index value of the object to be retrieved. Zero-indexed.| + +#### Returns +[ConditionalRangeBorder](conditionalrangeborder.md) diff --git a/markdown/conditionalrangefill.md b/markdown/conditionalrangefill.md index 1693167..9b21c8a 100644 --- a/markdown/conditionalrangefill.md +++ b/markdown/conditionalrangefill.md @@ -1,38 +1,38 @@ -# ConditionalRangeFill Object (JavaScript API for Excel) - -Represents the background of a conditional range object. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|color|string|HTML color code representing the color of the fill, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[clear()](#clear)|void|Resets the fill.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### clear() -Resets the fill. - -#### Syntax -```js -conditionalRangeFillObject.clear(); -``` - -#### Parameters -None - -#### Returns -void +# ConditionalRangeFill Object (JavaScript API for Excel) + +Represents the background of a conditional range object. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|color|string|HTML color code representing the color of the fill, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[clear()](#clear)|void|Resets the fill.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### clear() +Resets the fill. + +#### Syntax +```js +conditionalRangeFillObject.clear(); +``` + +#### Parameters +None + +#### Returns +void diff --git a/markdown/conditionalrangefont.md b/markdown/conditionalrangefont.md index 6c242d2..bc922a6 100644 --- a/markdown/conditionalrangefont.md +++ b/markdown/conditionalrangefont.md @@ -1,42 +1,42 @@ -# ConditionalRangeFont Object (JavaScript API for Excel) - -This object represents the font attributes (font style,, color, etc.) for an object. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|bold|bool|Represents the bold status of font.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|color|string|HTML color code representation of the text color. E.g. #FF0000 represents Red.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|italic|bool|Represents the italic status of the font.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|strikethrough|bool|Represents the strikethrough status of the font.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|underline|string|Type of underline applied to the font. Possible values are: None, Single, Double.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[clear()](#clear)|void|Resets the font formats.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### clear() -Resets the font formats. - -#### Syntax -```js -conditionalRangeFontObject.clear(); -``` - -#### Parameters -None - -#### Returns -void +# ConditionalRangeFont Object (JavaScript API for Excel) + +This object represents the font attributes (font style,, color, etc.) for an object. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|bold|bool|Represents the bold status of font.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|color|string|HTML color code representation of the text color. E.g. #FF0000 represents Red.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|italic|bool|Represents the italic status of the font.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|strikethrough|bool|Represents the strikethrough status of the font.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|underline|string|Type of underline applied to the font. Possible values are: None, Single, Double.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[clear()](#clear)|void|Resets the font formats.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### clear() +Resets the font formats. + +#### Syntax +```js +conditionalRangeFontObject.clear(); +``` + +#### Parameters +None + +#### Returns +void diff --git a/markdown/conditionalrangeformat.md b/markdown/conditionalrangeformat.md index efb1ec2..ad83437 100644 --- a/markdown/conditionalrangeformat.md +++ b/markdown/conditionalrangeformat.md @@ -1,22 +1,22 @@ -# ConditionalRangeFormat Object (JavaScript API for Excel) - -A format object encapsulating the conditional formats range's font, fill, borders, and other properties. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|numberFormat|object|Represents Excel's number format code for the given range. Cleared if null is passed in.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|borders|[ConditionalRangeBorderCollection](conditionalrangebordercollection.md)|Collection of border objects that apply to the overall conditional format range. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|fill|[ConditionalRangeFill](conditionalrangefill.md)|Returns the fill object defined on the overall conditional format range. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|font|[ConditionalRangeFont](conditionalrangefont.md)|Returns the font object defined on the overall conditional format range. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# ConditionalRangeFormat Object (JavaScript API for Excel) + +A format object encapsulating the conditional formats range's font, fill, borders, and other properties. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|numberFormat|object|Represents Excel's number format code for the given range. Cleared if null is passed in.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|borders|[ConditionalRangeBorderCollection](conditionalrangebordercollection.md)|Collection of border objects that apply to the overall conditional format range. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|fill|[ConditionalRangeFill](conditionalrangefill.md)|Returns the fill object defined on the overall conditional format range. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|font|[ConditionalRangeFont](conditionalrangefont.md)|Returns the font object defined on the overall conditional format range. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/conditionaltextcomparisonrule.md b/markdown/conditionaltextcomparisonrule.md index 1275c16..cdf7fc5 100644 --- a/markdown/conditionaltextcomparisonrule.md +++ b/markdown/conditionaltextcomparisonrule.md @@ -1,20 +1,20 @@ -# ConditionalTextComparisonRule Object (JavaScript API for Excel) - -Represents a Cell Value Conditional Format Rule - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|operator|string|The operator of the text conditional format. Possible values are: Invalid, Contains, NotContains, BeginsWith, EndsWith.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|text|string|The Text value of conditional format.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods -None - +# ConditionalTextComparisonRule Object (JavaScript API for Excel) + +Represents a Cell Value Conditional Format Rule + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|operator|string|The operator of the text conditional format. Possible values are: Invalid, Contains, NotContains, BeginsWith, EndsWith.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|text|string|The Text value of conditional format.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods +None + diff --git a/markdown/conditionaltopbottomrule.md b/markdown/conditionaltopbottomrule.md index bc58e4b..cdc33f8 100644 --- a/markdown/conditionaltopbottomrule.md +++ b/markdown/conditionaltopbottomrule.md @@ -1,20 +1,20 @@ -# ConditionalTopBottomRule Object (JavaScript API for Excel) - -Represents the rule of the topbottom conditional format. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|rank|int|The rank between 1 and 1000 for numeric ranks or 1 and 100 for percent ranks.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|type|string|Format values based on the top or bottom rank. Possible values are: Invalid, TopItems, TopPercent, BottomItems, BottomPercent.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods -None - +# ConditionalTopBottomRule Object (JavaScript API for Excel) + +Represents the rule of the topbottom conditional format. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|rank|int|The rank between 1 and 1000 for numeric ranks or 1 and 100 for percent ranks.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|type|string|Format values based on the top or bottom rank. Possible values are: Invalid, TopItems, TopPercent, BottomItems, BottomPercent.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods +None + diff --git a/markdown/customconditionalformat.md b/markdown/customconditionalformat.md index 4a1c196..66a4eed 100644 --- a/markdown/customconditionalformat.md +++ b/markdown/customconditionalformat.md @@ -1,17 +1,17 @@ -# CustomConditionalFormat Object (JavaScript API for Excel) - -Represents a custom conditional format type. - -## Properties - -None - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|format|[ConditionalRangeFormat](conditionalrangeformat.md)|Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|rule|[ConditionalFormatRule](conditionalformatrule.md)|Represents the Rule object on this conditional format. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# CustomConditionalFormat Object (JavaScript API for Excel) + +Represents a custom conditional format type. + +## Properties + +None + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|format|[ConditionalRangeFormat](conditionalrangeformat.md)|Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|rule|[ConditionalFormatRule](conditionalformatrule.md)|Represents the Rule object on this conditional format. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/customxmlpart.md b/markdown/customxmlpart.md index ead2076..9b794d8 100644 --- a/markdown/customxmlpart.md +++ b/markdown/customxmlpart.md @@ -1,71 +1,71 @@ -# CustomXmlPart Object (JavaScript API for Excel) - -Represents a custom XML part object in a workbook. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|id|string|The custom XML part's ID. Read-only.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| -|namespaceUri|string|The custom XML part's namespace URI. Read-only.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[delete()](#delete)|void|Deletes the custom XML part.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| -|[getXml()](#getxml)|string|Gets the custom XML part's full XML content.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| -|[setXml(xml: string)](#setxmlxml-string)|void|Sets the custom XML part's full XML content.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### delete() -Deletes the custom XML part. - -#### Syntax -```js -customXmlPartObject.delete(); -``` - -#### Parameters -None - -#### Returns -void - -### getXml() -Gets the custom XML part's full XML content. - -#### Syntax -```js -customXmlPartObject.getXml(); -``` - -#### Parameters -None - -#### Returns -string - -### setXml(xml: string) -Sets the custom XML part's full XML content. - -#### Syntax -```js -customXmlPartObject.setXml(xml); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|xml|string|XML content for the part.| - -#### Returns -void +# CustomXmlPart Object (JavaScript API for Excel) + +Represents a custom XML part object in a workbook. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|id|string|The custom XML part's ID. Read-only.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| +|namespaceUri|string|The custom XML part's namespace URI. Read-only.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[delete()](#delete)|void|Deletes the custom XML part.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| +|[getXml()](#getxml)|string|Gets the custom XML part's full XML content.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| +|[setXml(xml: string)](#setxmlxml-string)|void|Sets the custom XML part's full XML content.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### delete() +Deletes the custom XML part. + +#### Syntax +```js +customXmlPartObject.delete(); +``` + +#### Parameters +None + +#### Returns +void + +### getXml() +Gets the custom XML part's full XML content. + +#### Syntax +```js +customXmlPartObject.getXml(); +``` + +#### Parameters +None + +#### Returns +string + +### setXml(xml: string) +Sets the custom XML part's full XML content. + +#### Syntax +```js +customXmlPartObject.setXml(xml); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|xml|string|XML content for the part.| + +#### Returns +void diff --git a/markdown/customxmlpartcollection.md b/markdown/customxmlpartcollection.md index 83ac139..fbc45be 100644 --- a/markdown/customxmlpartcollection.md +++ b/markdown/customxmlpartcollection.md @@ -1,106 +1,106 @@ -# CustomXmlPartCollection Object (JavaScript API for Excel) - -A collection of custom XML parts. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|items|[CustomXmlPart[]](customxmlpart.md)|A collection of customXmlPart objects. Read-only.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[add(xml: string)](#addxml-string)|[CustomXmlPart](customxmlpart.md)|Adds a new custom XML part to the workbook.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| -|[getByNamespace(namespaceUri: string)](#getbynamespacenamespaceuri-string)|[CustomXmlPartScopedCollection](customxmlpartscopedcollection.md)|Gets a new scoped collection of custom XML parts whose namespaces match the given namespace.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| -|[getCount()](#getcount)|int|Gets the number of CustomXml parts in the collection.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| -|[getItem(id: string)](#getitemid-string)|[CustomXmlPart](customxmlpart.md)|Gets a custom XML part based on its ID.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| -|[getItemOrNullObject(id: string)](#getitemornullobjectid-string)|[CustomXmlPart](customxmlpart.md)|Gets a custom XML part based on its ID.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### add(xml: string) -Adds a new custom XML part to the workbook. - -#### Syntax -```js -customXmlPartCollectionObject.add(xml); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|xml|string|XML content. Must be a valid XML fragment.| - -#### Returns -[CustomXmlPart](customxmlpart.md) - -### getByNamespace(namespaceUri: string) -Gets a new scoped collection of custom XML parts whose namespaces match the given namespace. - -#### Syntax -```js -customXmlPartCollectionObject.getByNamespace(namespaceUri); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|namespaceUri|string|| - -#### Returns -[CustomXmlPartScopedCollection](customxmlpartscopedcollection.md) - -### getCount() -Gets the number of CustomXml parts in the collection. - -#### Syntax -```js -customXmlPartCollectionObject.getCount(); -``` - -#### Parameters -None - -#### Returns -int - -### getItem(id: string) -Gets a custom XML part based on its ID. - -#### Syntax -```js -customXmlPartCollectionObject.getItem(id); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|id|string|ID of the object to be retrieved.| - -#### Returns -[CustomXmlPart](customxmlpart.md) - -### getItemOrNullObject(id: string) -Gets a custom XML part based on its ID. - -#### Syntax -```js -customXmlPartCollectionObject.getItemOrNullObject(id); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|id|string|ID of the object to be retrieved.| - -#### Returns -[CustomXmlPart](customxmlpart.md) +# CustomXmlPartCollection Object (JavaScript API for Excel) + +A collection of custom XML parts. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|items|[CustomXmlPart[]](customxmlpart.md)|A collection of customXmlPart objects. Read-only.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[add(xml: string)](#addxml-string)|[CustomXmlPart](customxmlpart.md)|Adds a new custom XML part to the workbook.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| +|[getByNamespace(namespaceUri: string)](#getbynamespacenamespaceuri-string)|[CustomXmlPartScopedCollection](customxmlpartscopedcollection.md)|Gets a new scoped collection of custom XML parts whose namespaces match the given namespace.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| +|[getCount()](#getcount)|int|Gets the number of CustomXml parts in the collection.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| +|[getItem(id: string)](#getitemid-string)|[CustomXmlPart](customxmlpart.md)|Gets a custom XML part based on its ID.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| +|[getItemOrNullObject(id: string)](#getitemornullobjectid-string)|[CustomXmlPart](customxmlpart.md)|Gets a custom XML part based on its ID.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### add(xml: string) +Adds a new custom XML part to the workbook. + +#### Syntax +```js +customXmlPartCollectionObject.add(xml); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|xml|string|XML content. Must be a valid XML fragment.| + +#### Returns +[CustomXmlPart](customxmlpart.md) + +### getByNamespace(namespaceUri: string) +Gets a new scoped collection of custom XML parts whose namespaces match the given namespace. + +#### Syntax +```js +customXmlPartCollectionObject.getByNamespace(namespaceUri); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|namespaceUri|string|| + +#### Returns +[CustomXmlPartScopedCollection](customxmlpartscopedcollection.md) + +### getCount() +Gets the number of CustomXml parts in the collection. + +#### Syntax +```js +customXmlPartCollectionObject.getCount(); +``` + +#### Parameters +None + +#### Returns +int + +### getItem(id: string) +Gets a custom XML part based on its ID. + +#### Syntax +```js +customXmlPartCollectionObject.getItem(id); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|id|string|ID of the object to be retrieved.| + +#### Returns +[CustomXmlPart](customxmlpart.md) + +### getItemOrNullObject(id: string) +Gets a custom XML part based on its ID. + +#### Syntax +```js +customXmlPartCollectionObject.getItemOrNullObject(id); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|id|string|ID of the object to be retrieved.| + +#### Returns +[CustomXmlPart](customxmlpart.md) diff --git a/markdown/customxmlpartscopedcollection.md b/markdown/customxmlpartscopedcollection.md index 6bd9b08..86a2afa 100644 --- a/markdown/customxmlpartscopedcollection.md +++ b/markdown/customxmlpartscopedcollection.md @@ -1,102 +1,102 @@ -# CustomXmlPartScopedCollection Object (JavaScript API for Excel) - -A scoped collection of custom XML parts. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|items|[CustomXmlPartScoped[]](customxmlpartscoped.md)|A collection of customXmlPartScoped objects. Read-only.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[getCount()](#getcount)|int|Gets the number of CustomXML parts in this collection.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| -|[getItem(id: string)](#getitemid-string)|[CustomXmlPart](customxmlpart.md)|Gets a custom XML part based on its ID.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| -|[getItemOrNullObject(id: string)](#getitemornullobjectid-string)|[CustomXmlPart](customxmlpart.md)|Gets a custom XML part based on its ID.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| -|[getOnlyItem()](#getonlyitem)|[CustomXmlPart](customxmlpart.md)|If the collection contains exactly one item, this method returns it.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| -|[getOnlyItemOrNullObject()](#getonlyitemornullobject)|[CustomXmlPart](customxmlpart.md)|If the collection contains exactly one item, this method returns it.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### getCount() -Gets the number of CustomXML parts in this collection. - -#### Syntax -```js -customXmlPartScopedCollectionObject.getCount(); -``` - -#### Parameters -None - -#### Returns -int - -### getItem(id: string) -Gets a custom XML part based on its ID. - -#### Syntax -```js -customXmlPartScopedCollectionObject.getItem(id); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|id|string|ID of the object to be retrieved.| - -#### Returns -[CustomXmlPart](customxmlpart.md) - -### getItemOrNullObject(id: string) -Gets a custom XML part based on its ID. - -#### Syntax -```js -customXmlPartScopedCollectionObject.getItemOrNullObject(id); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|id|string|ID of the object to be retrieved.| - -#### Returns -[CustomXmlPart](customxmlpart.md) - -### getOnlyItem() -If the collection contains exactly one item, this method returns it. - -#### Syntax -```js -customXmlPartScopedCollectionObject.getOnlyItem(); -``` - -#### Parameters -None - -#### Returns -[CustomXmlPart](customxmlpart.md) - -### getOnlyItemOrNullObject() -If the collection contains exactly one item, this method returns it. - -#### Syntax -```js -customXmlPartScopedCollectionObject.getOnlyItemOrNullObject(); -``` - -#### Parameters -None - -#### Returns -[CustomXmlPart](customxmlpart.md) +# CustomXmlPartScopedCollection Object (JavaScript API for Excel) + +A scoped collection of custom XML parts. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|items|[CustomXmlPartScoped[]](customxmlpartscoped.md)|A collection of customXmlPartScoped objects. Read-only.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[getCount()](#getcount)|int|Gets the number of CustomXML parts in this collection.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| +|[getItem(id: string)](#getitemid-string)|[CustomXmlPart](customxmlpart.md)|Gets a custom XML part based on its ID.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| +|[getItemOrNullObject(id: string)](#getitemornullobjectid-string)|[CustomXmlPart](customxmlpart.md)|Gets a custom XML part based on its ID.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| +|[getOnlyItem()](#getonlyitem)|[CustomXmlPart](customxmlpart.md)|If the collection contains exactly one item, this method returns it.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| +|[getOnlyItemOrNullObject()](#getonlyitemornullobject)|[CustomXmlPart](customxmlpart.md)|If the collection contains exactly one item, this method returns it.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### getCount() +Gets the number of CustomXML parts in this collection. + +#### Syntax +```js +customXmlPartScopedCollectionObject.getCount(); +``` + +#### Parameters +None + +#### Returns +int + +### getItem(id: string) +Gets a custom XML part based on its ID. + +#### Syntax +```js +customXmlPartScopedCollectionObject.getItem(id); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|id|string|ID of the object to be retrieved.| + +#### Returns +[CustomXmlPart](customxmlpart.md) + +### getItemOrNullObject(id: string) +Gets a custom XML part based on its ID. + +#### Syntax +```js +customXmlPartScopedCollectionObject.getItemOrNullObject(id); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|id|string|ID of the object to be retrieved.| + +#### Returns +[CustomXmlPart](customxmlpart.md) + +### getOnlyItem() +If the collection contains exactly one item, this method returns it. + +#### Syntax +```js +customXmlPartScopedCollectionObject.getOnlyItem(); +``` + +#### Parameters +None + +#### Returns +[CustomXmlPart](customxmlpart.md) + +### getOnlyItemOrNullObject() +If the collection contains exactly one item, this method returns it. + +#### Syntax +```js +customXmlPartScopedCollectionObject.getOnlyItemOrNullObject(); +``` + +#### Parameters +None + +#### Returns +[CustomXmlPart](customxmlpart.md) diff --git a/markdown/databarconditionalformat.md b/markdown/databarconditionalformat.md index e23cf09..e1acf21 100644 --- a/markdown/databarconditionalformat.md +++ b/markdown/databarconditionalformat.md @@ -1,26 +1,26 @@ -# DataBarConditionalFormat Object (JavaScript API for Excel) - -Represents an Excel Conditional Data Bar Type. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|axisColor|string|HTML color code representing the color of the Axis line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|axisFormat|string|Representation of how the axis is determined for an Excel data bar. Possible values are: Automatic, None, CellMidPoint.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|barDirection|string|Represents the direction that the data bar graphic should be based on. Possible values are: Context, LeftToRight, RightToLeft.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|showDataBarOnly|bool|If true, hides the values from the cells where the data bar is applied.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|lowerBoundRule|[ConditionalDataBarRule](conditionaldatabarrule.md)|The rule for what consistutes the lower bound (and how to calculate it, if applicable) for a data bar.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|negativeFormat|[ConditionalDataBarNegativeFormat](conditionaldatabarnegativeformat.md)|Representation of all values to the left of the axis in an Excel data bar. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|positiveFormat|[ConditionalDataBarPositiveFormat](conditionaldatabarpositiveformat.md)|Representation of all values to the right of the axis in an Excel data bar. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|upperBoundRule|[ConditionalDataBarRule](conditionaldatabarrule.md)|The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# DataBarConditionalFormat Object (JavaScript API for Excel) + +Represents an Excel Conditional Data Bar Type. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|axisColor|string|HTML color code representing the color of the Axis line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|axisFormat|string|Representation of how the axis is determined for an Excel data bar. Possible values are: Automatic, None, CellMidPoint.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|barDirection|string|Represents the direction that the data bar graphic should be based on. Possible values are: Context, LeftToRight, RightToLeft.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|showDataBarOnly|bool|If true, hides the values from the cells where the data bar is applied.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|lowerBoundRule|[ConditionalDataBarRule](conditionaldatabarrule.md)|The rule for what consistutes the lower bound (and how to calculate it, if applicable) for a data bar.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|negativeFormat|[ConditionalDataBarNegativeFormat](conditionaldatabarnegativeformat.md)|Representation of all values to the left of the axis in an Excel data bar. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|positiveFormat|[ConditionalDataBarPositiveFormat](conditionaldatabarpositiveformat.md)|Representation of all values to the right of the axis in an Excel data bar. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|upperBoundRule|[ConditionalDataBarRule](conditionaldatabarrule.md)|The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/filter.md b/markdown/filter.md index 8013855..6af6f2d 100644 --- a/markdown/filter.md +++ b/markdown/filter.md @@ -1,224 +1,224 @@ -# Filter Object (JavaScript API for Excel) - -Manages the filtering of a table's column. - -## Properties - -None - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|criteria|[FilterCriteria](filtercriteria.md)|The currently applied filter on the given column. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[apply(criteria: FilterCriteria)](#applycriteria-filtercriteria)|void|Apply the given filter criteria on the given column.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|[applyBottomItemsFilter(count: number)](#applybottomitemsfiltercount-number)|void|Apply a "Bottom Item" filter to the column for the given number of elements.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|[applyBottomPercentFilter(percent: number)](#applybottompercentfilterpercent-number)|void|Apply a "Bottom Percent" filter to the column for the given percentage of elements.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|[applyCellColorFilter(color: string)](#applycellcolorfiltercolor-string)|void|Apply a "Cell Color" filter to the column for the given color.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|[applyCustomFilter(criteria1: string, criteria2: string, oper: string)](#applycustomfiltercriteria1-string-criteria2-string-oper-string)|void|Apply a "Icon" filter to the column for the given criteria strings.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|[applyDynamicFilter(criteria: string)](#applydynamicfiltercriteria-string)|void|Apply a "Dynamic" filter to the column.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|[applyFontColorFilter(color: string)](#applyfontcolorfiltercolor-string)|void|Apply a "Font Color" filter to the column for the given color.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|[applyIconFilter(icon: Icon)](#applyiconfiltericon-icon)|void|Apply a "Icon" filter to the column for the given icon.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|[applyTopItemsFilter(count: number)](#applytopitemsfiltercount-number)|void|Apply a "Top Item" filter to the column for the given number of elements.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|[applyTopPercentFilter(percent: number)](#applytoppercentfilterpercent-number)|void|Apply a "Top Percent" filter to the column for the given percentage of elements.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|[applyValuesFilter(values: object[])](#applyvaluesfiltervalues-object)|void|Apply a "Values" filter to the column for the given values.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|[clear()](#clear)|void|Clear the filter on the given column.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### apply(criteria: FilterCriteria) -Apply the given filter criteria on the given column. - -#### Syntax -```js -filterObject.apply(criteria); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|criteria|FilterCriteria|The criteria to apply.| - -#### Returns -void - -### applyBottomItemsFilter(count: number) -Apply a "Bottom Item" filter to the column for the given number of elements. - -#### Syntax -```js -filterObject.applyBottomItemsFilter(count); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|count|number|The number of elements from the bottom to show.| - -#### Returns -void - -### applyBottomPercentFilter(percent: number) -Apply a "Bottom Percent" filter to the column for the given percentage of elements. - -#### Syntax -```js -filterObject.applyBottomPercentFilter(percent); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|percent|number|The percentage of elements from the bottom to show.| - -#### Returns -void - -### applyCellColorFilter(color: string) -Apply a "Cell Color" filter to the column for the given color. - -#### Syntax -```js -filterObject.applyCellColorFilter(color); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|color|string|The background color of the cells to show.| - -#### Returns -void - -### applyCustomFilter(criteria1: string, criteria2: string, oper: string) -Apply a "Icon" filter to the column for the given criteria strings. - -#### Syntax -```js -filterObject.applyCustomFilter(criteria1, criteria2, oper); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|criteria1|string|The first criteria string.| -|criteria2|string|Optional. The second criteria string.| -|oper|string|Optional. The operator that describes how the two criteria are joined. Possible values are: And, Or| - -#### Returns -void - -### applyDynamicFilter(criteria: string) -Apply a "Dynamic" filter to the column. - -#### Syntax -```js -filterObject.applyDynamicFilter(criteria); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|criteria|string|The dynamic criteria to apply. Possible values are: Unknown, AboveAverage, AllDatesInPeriodApril, AllDatesInPeriodAugust, AllDatesInPeriodDecember, AllDatesInPeriodFebruray, AllDatesInPeriodJanuary, AllDatesInPeriodJuly, AllDatesInPeriodJune, AllDatesInPeriodMarch, AllDatesInPeriodMay, AllDatesInPeriodNovember, AllDatesInPeriodOctober, AllDatesInPeriodQuarter1, AllDatesInPeriodQuarter2, AllDatesInPeriodQuarter3, AllDatesInPeriodQuarter4, AllDatesInPeriodSeptember, BelowAverage, LastMonth, LastQuarter, LastWeek, LastYear, NextMonth, NextQuarter, NextWeek, NextYear, ThisMonth, ThisQuarter, ThisWeek, ThisYear, Today, Tomorrow, YearToDate, Yesterday| - -#### Returns -void - -### applyFontColorFilter(color: string) -Apply a "Font Color" filter to the column for the given color. - -#### Syntax -```js -filterObject.applyFontColorFilter(color); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|color|string|The font color of the cells to show.| - -#### Returns -void - -### applyIconFilter(icon: Icon) -Apply a "Icon" filter to the column for the given icon. - -#### Syntax -```js -filterObject.applyIconFilter(icon); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|icon|Icon|The icons of the cells to show.| - -#### Returns -void - -### applyTopItemsFilter(count: number) -Apply a "Top Item" filter to the column for the given number of elements. - -#### Syntax -```js -filterObject.applyTopItemsFilter(count); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|count|number|The number of elements from the top to show.| - -#### Returns -void - -### applyTopPercentFilter(percent: number) -Apply a "Top Percent" filter to the column for the given percentage of elements. - -#### Syntax -```js -filterObject.applyTopPercentFilter(percent); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|percent|number|The percentage of elements from the top to show.| - -#### Returns -void - -### applyValuesFilter(values: object[]) -Apply a "Values" filter to the column for the given values. - -#### Syntax -```js -filterObject.applyValuesFilter(values); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|values|object[]|The list of values to show.| - -#### Returns -void - -### clear() -Clear the filter on the given column. - -#### Syntax -```js -filterObject.clear(); -``` - -#### Parameters -None - -#### Returns -void +# Filter Object (JavaScript API for Excel) + +Manages the filtering of a table's column. + +## Properties + +None + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|criteria|[FilterCriteria](filtercriteria.md)|The currently applied filter on the given column. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[apply(criteria: FilterCriteria)](#applycriteria-filtercriteria)|void|Apply the given filter criteria on the given column.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|[applyBottomItemsFilter(count: number)](#applybottomitemsfiltercount-number)|void|Apply a "Bottom Item" filter to the column for the given number of elements.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|[applyBottomPercentFilter(percent: number)](#applybottompercentfilterpercent-number)|void|Apply a "Bottom Percent" filter to the column for the given percentage of elements.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|[applyCellColorFilter(color: string)](#applycellcolorfiltercolor-string)|void|Apply a "Cell Color" filter to the column for the given color.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|[applyCustomFilter(criteria1: string, criteria2: string, oper: string)](#applycustomfiltercriteria1-string-criteria2-string-oper-string)|void|Apply a "Icon" filter to the column for the given criteria strings.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|[applyDynamicFilter(criteria: string)](#applydynamicfiltercriteria-string)|void|Apply a "Dynamic" filter to the column.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|[applyFontColorFilter(color: string)](#applyfontcolorfiltercolor-string)|void|Apply a "Font Color" filter to the column for the given color.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|[applyIconFilter(icon: Icon)](#applyiconfiltericon-icon)|void|Apply a "Icon" filter to the column for the given icon.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|[applyTopItemsFilter(count: number)](#applytopitemsfiltercount-number)|void|Apply a "Top Item" filter to the column for the given number of elements.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|[applyTopPercentFilter(percent: number)](#applytoppercentfilterpercent-number)|void|Apply a "Top Percent" filter to the column for the given percentage of elements.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|[applyValuesFilter(values: object[])](#applyvaluesfiltervalues-object)|void|Apply a "Values" filter to the column for the given values.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|[clear()](#clear)|void|Clear the filter on the given column.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### apply(criteria: FilterCriteria) +Apply the given filter criteria on the given column. + +#### Syntax +```js +filterObject.apply(criteria); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|criteria|FilterCriteria|The criteria to apply.| + +#### Returns +void + +### applyBottomItemsFilter(count: number) +Apply a "Bottom Item" filter to the column for the given number of elements. + +#### Syntax +```js +filterObject.applyBottomItemsFilter(count); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|count|number|The number of elements from the bottom to show.| + +#### Returns +void + +### applyBottomPercentFilter(percent: number) +Apply a "Bottom Percent" filter to the column for the given percentage of elements. + +#### Syntax +```js +filterObject.applyBottomPercentFilter(percent); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|percent|number|The percentage of elements from the bottom to show.| + +#### Returns +void + +### applyCellColorFilter(color: string) +Apply a "Cell Color" filter to the column for the given color. + +#### Syntax +```js +filterObject.applyCellColorFilter(color); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|color|string|The background color of the cells to show.| + +#### Returns +void + +### applyCustomFilter(criteria1: string, criteria2: string, oper: string) +Apply a "Icon" filter to the column for the given criteria strings. + +#### Syntax +```js +filterObject.applyCustomFilter(criteria1, criteria2, oper); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|criteria1|string|The first criteria string.| +|criteria2|string|Optional. The second criteria string.| +|oper|string|Optional. The operator that describes how the two criteria are joined. Possible values are: And, Or| + +#### Returns +void + +### applyDynamicFilter(criteria: string) +Apply a "Dynamic" filter to the column. + +#### Syntax +```js +filterObject.applyDynamicFilter(criteria); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|criteria|string|The dynamic criteria to apply. Possible values are: Unknown, AboveAverage, AllDatesInPeriodApril, AllDatesInPeriodAugust, AllDatesInPeriodDecember, AllDatesInPeriodFebruray, AllDatesInPeriodJanuary, AllDatesInPeriodJuly, AllDatesInPeriodJune, AllDatesInPeriodMarch, AllDatesInPeriodMay, AllDatesInPeriodNovember, AllDatesInPeriodOctober, AllDatesInPeriodQuarter1, AllDatesInPeriodQuarter2, AllDatesInPeriodQuarter3, AllDatesInPeriodQuarter4, AllDatesInPeriodSeptember, BelowAverage, LastMonth, LastQuarter, LastWeek, LastYear, NextMonth, NextQuarter, NextWeek, NextYear, ThisMonth, ThisQuarter, ThisWeek, ThisYear, Today, Tomorrow, YearToDate, Yesterday| + +#### Returns +void + +### applyFontColorFilter(color: string) +Apply a "Font Color" filter to the column for the given color. + +#### Syntax +```js +filterObject.applyFontColorFilter(color); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|color|string|The font color of the cells to show.| + +#### Returns +void + +### applyIconFilter(icon: Icon) +Apply a "Icon" filter to the column for the given icon. + +#### Syntax +```js +filterObject.applyIconFilter(icon); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|icon|Icon|The icons of the cells to show.| + +#### Returns +void + +### applyTopItemsFilter(count: number) +Apply a "Top Item" filter to the column for the given number of elements. + +#### Syntax +```js +filterObject.applyTopItemsFilter(count); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|count|number|The number of elements from the top to show.| + +#### Returns +void + +### applyTopPercentFilter(percent: number) +Apply a "Top Percent" filter to the column for the given percentage of elements. + +#### Syntax +```js +filterObject.applyTopPercentFilter(percent); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|percent|number|The percentage of elements from the top to show.| + +#### Returns +void + +### applyValuesFilter(values: object[]) +Apply a "Values" filter to the column for the given values. + +#### Syntax +```js +filterObject.applyValuesFilter(values); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|values|object[]|The list of values to show.| + +#### Returns +void + +### clear() +Clear the filter on the given column. + +#### Syntax +```js +filterObject.clear(); +``` + +#### Parameters +None + +#### Returns +void diff --git a/markdown/filtercriteria.md b/markdown/filtercriteria.md index bea5a7f..47f8ed8 100644 --- a/markdown/filtercriteria.md +++ b/markdown/filtercriteria.md @@ -1,26 +1,26 @@ -# FilterCriteria Object (JavaScript API for Excel) - -Represents the filtering criteria applied to a column. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|color|string|The HTML color string used to filter cells. Used with "cellColor" and "fontColor" filtering.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|criterion1|string|The first criterion used to filter data. Used as an operator in the case of "custom" filtering.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|criterion2|string|The second criterion used to filter data. Only used as an operator in the case of "custom" filtering.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|dynamicCriteria|string|The dynamic criteria from the Excel.DynamicFilterCriteria set to apply on this column. Used with "dynamic" filtering. Possible values are: Unknown, AboveAverage, AllDatesInPeriodApril, AllDatesInPeriodAugust, AllDatesInPeriodDecember, AllDatesInPeriodFebruray, AllDatesInPeriodJanuary, AllDatesInPeriodJuly, AllDatesInPeriodJune, AllDatesInPeriodMarch, AllDatesInPeriodMay, AllDatesInPeriodNovember, AllDatesInPeriodOctober, AllDatesInPeriodQuarter1, AllDatesInPeriodQuarter2, AllDatesInPeriodQuarter3, AllDatesInPeriodQuarter4, AllDatesInPeriodSeptember, BelowAverage, LastMonth, LastQuarter, LastWeek, LastYear, NextMonth, NextQuarter, NextWeek, NextYear, ThisMonth, ThisQuarter, ThisWeek, ThisYear, Today, Tomorrow, YearToDate, Yesterday.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|filterOn|string|The property used by the filter to determine whether the values should stay visible. Possible values are: BottomItems, BottomPercent, CellColor, Dynamic, FontColor, Values, TopItems, TopPercent, Icon, Custom.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|operator|string|The operator used to combine criterion 1 and 2 when using "custom" filtering. Possible values are: And, Or.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|values|object[]|The set of values to be used as part of "values" filtering.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|icon|[Icon](icon.md)|The icon used to filter cells. Used with "icon" filtering.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# FilterCriteria Object (JavaScript API for Excel) + +Represents the filtering criteria applied to a column. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|color|string|The HTML color string used to filter cells. Used with "cellColor" and "fontColor" filtering.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|criterion1|string|The first criterion used to filter data. Used as an operator in the case of "custom" filtering.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|criterion2|string|The second criterion used to filter data. Only used as an operator in the case of "custom" filtering.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|dynamicCriteria|string|The dynamic criteria from the Excel.DynamicFilterCriteria set to apply on this column. Used with "dynamic" filtering. Possible values are: Unknown, AboveAverage, AllDatesInPeriodApril, AllDatesInPeriodAugust, AllDatesInPeriodDecember, AllDatesInPeriodFebruray, AllDatesInPeriodJanuary, AllDatesInPeriodJuly, AllDatesInPeriodJune, AllDatesInPeriodMarch, AllDatesInPeriodMay, AllDatesInPeriodNovember, AllDatesInPeriodOctober, AllDatesInPeriodQuarter1, AllDatesInPeriodQuarter2, AllDatesInPeriodQuarter3, AllDatesInPeriodQuarter4, AllDatesInPeriodSeptember, BelowAverage, LastMonth, LastQuarter, LastWeek, LastYear, NextMonth, NextQuarter, NextWeek, NextYear, ThisMonth, ThisQuarter, ThisWeek, ThisYear, Today, Tomorrow, YearToDate, Yesterday.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|filterOn|string|The property used by the filter to determine whether the values should stay visible. Possible values are: BottomItems, BottomPercent, CellColor, Dynamic, FontColor, Values, TopItems, TopPercent, Icon, Custom.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|operator|string|The operator used to combine criterion 1 and 2 when using "custom" filtering. Possible values are: And, Or.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|values|object[]|The set of values to be used as part of "values" filtering.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|icon|[Icon](icon.md)|The icon used to filter cells. Used with "icon" filtering.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/filterdatetime.md b/markdown/filterdatetime.md index 8be0e53..c9d54c1 100644 --- a/markdown/filterdatetime.md +++ b/markdown/filterdatetime.md @@ -1,20 +1,20 @@ -# FilterDatetime Object (JavaScript API for Excel) - -Represents how to filter a date when filtering on values. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|date|string|The date in ISO8601 format used to filter data.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|specificity|string|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 2009. Possible values are: Year, Monday, Day, Hour, Minute, Second.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods -None - +# FilterDatetime Object (JavaScript API for Excel) + +Represents how to filter a date when filtering on values. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|date|string|The date in ISO8601 format used to filter data.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|specificity|string|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 2009. Possible values are: Year, Monday, Day, Hour, Minute, Second.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods +None + diff --git a/markdown/formatprotection.md b/markdown/formatprotection.md index 1a2fd8a..8469620 100644 --- a/markdown/formatprotection.md +++ b/markdown/formatprotection.md @@ -1,20 +1,20 @@ -# FormatProtection Object (JavaScript API for Excel) - -Represents the format protection of a range object. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|formulaHidden|bool|Indicates if Excel hides the formula for the cells in the range. A null value indicates that the entire range doesn't have uniform formula hidden setting.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|locked|bool|Indicates if Excel locks the cells in the object. A null value indicates that the entire range doesn't have uniform lock setting.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods -None - +# FormatProtection Object (JavaScript API for Excel) + +Represents the format protection of a range object. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|formulaHidden|bool|Indicates if Excel hides the formula for the cells in the range. A null value indicates that the entire range doesn't have uniform formula hidden setting.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|locked|bool|Indicates if Excel locks the cells in the object. A null value indicates that the entire range doesn't have uniform lock setting.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods +None + diff --git a/markdown/icon.md b/markdown/icon.md index 2a0c06f..e68d261 100644 --- a/markdown/icon.md +++ b/markdown/icon.md @@ -1,20 +1,20 @@ -# Icon Object (JavaScript API for Excel) - -Represents a cell icon. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|index|int|Represents the index of the icon in the given set.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|set|string|Represents the set that the icon is part of. Possible values are: Invalid, ThreeArrows, ThreeArrowsGray, ThreeFlags, ThreeTrafficLights1, ThreeTrafficLights2, ThreeSigns, ThreeSymbols, ThreeSymbols2, FourArrows, FourArrowsGray, FourRedToBlack, FourRating, FourTrafficLights, FiveArrows, FiveArrowsGray, FiveRating, FiveQuarters, ThreeStars, ThreeTriangles, FiveBoxes.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods -None - +# Icon Object (JavaScript API for Excel) + +Represents a cell icon. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|index|int|Represents the index of the icon in the given set.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|set|string|Represents the set that the icon is part of. Possible values are: Invalid, ThreeArrows, ThreeArrowsGray, ThreeFlags, ThreeTrafficLights1, ThreeTrafficLights2, ThreeSigns, ThreeSymbols, ThreeSymbols2, FourArrows, FourArrowsGray, FourRedToBlack, FourRating, FourTrafficLights, FiveArrows, FiveArrowsGray, FiveRating, FiveQuarters, ThreeStars, ThreeTriangles, FiveBoxes.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods +None + diff --git a/markdown/iconsetconditionalformat.md b/markdown/iconsetconditionalformat.md index 6c8b85a..8fab737 100644 --- a/markdown/iconsetconditionalformat.md +++ b/markdown/iconsetconditionalformat.md @@ -1,22 +1,22 @@ -# IconSetConditionalFormat Object (JavaScript API for Excel) - -Represents an IconSet criteria for conditional formatting. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|reverseIconOrder|bool|If true, reverses the icon orders for the IconSet. Note that this cannot be set if custom icons are used.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|showIconOnly|bool|If true, hides the values and only shows icons.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|style|string|If set, displays the IconSet option for the conditional format. Possible values are: Invalid, ThreeArrows, ThreeArrowsGray, ThreeFlags, ThreeTrafficLights1, ThreeTrafficLights2, ThreeSigns, ThreeSymbols, ThreeSymbols2, FourArrows, FourArrowsGray, FourRedToBlack, FourRating, FourTrafficLights, FiveArrows, FiveArrowsGray, FiveRating, FiveQuarters, ThreeStars, ThreeTriangles, FiveBoxes.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|criteria|[ConditionalIconCriterion](conditionaliconcriterion.md)|An array of Criteria and IconSets 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.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# IconSetConditionalFormat Object (JavaScript API for Excel) + +Represents an IconSet criteria for conditional formatting. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|reverseIconOrder|bool|If true, reverses the icon orders for the IconSet. Note that this cannot be set if custom icons are used.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|showIconOnly|bool|If true, hides the values and only shows icons.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|style|string|If set, displays the IconSet option for the conditional format. Possible values are: Invalid, ThreeArrows, ThreeArrowsGray, ThreeFlags, ThreeTrafficLights1, ThreeTrafficLights2, ThreeSigns, ThreeSymbols, ThreeSymbols2, FourArrows, FourArrowsGray, FourRedToBlack, FourRating, FourTrafficLights, FiveArrows, FiveArrowsGray, FiveRating, FiveQuarters, ThreeStars, ThreeTriangles, FiveBoxes.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|criteria|[ConditionalIconCriterion](conditionaliconcriterion.md)|An array of Criteria and IconSets 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.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/nameditem.md b/markdown/nameditem.md index 102b6c4..7266767 100644 --- a/markdown/nameditem.md +++ b/markdown/nameditem.md @@ -1,113 +1,113 @@ -# NamedItem Object (JavaScript API for Excel) - -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, reference to a range. This object can be used to obtain range object associated with names. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|comment|string|Represents the comment associated with this name.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|name|string|The name of the object. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|scope|string|Indicates whether the name is scoped to the workbook or to a specific worksheet. Read-only. Possible values are: Equal, Greater, GreaterEqual, Less, LessEqual, NotEqual.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|type|string|Indicates the type of the value returned by the name's formula. Read-only. Possible values are: String, Integer, Double, Boolean, Range.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|value|object|Represents the value computed by the name's formula. For a named range, will return the range address. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|visible|bool|Specifies whether the object is visible or not.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|worksheet|[Worksheet](worksheet.md)|Returns the worksheet on which the named item is scoped to. Throws an error if the items is scoped to the workbook instead. Read-only.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|worksheetOrNullObject|[Worksheet](worksheet.md)|Returns the worksheet on which the named item is scoped to. Returns a null object if the item is scoped to the workbook instead. Read-only.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[delete()](#delete)|void|Deletes the given name.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|[getRange()](#getrange)|[Range](range.md)|Returns the range object that is associated with the name. Throws an error if the named item's type is not a range.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getRangeOrNullObject()](#getrangeornullobject)|[Range](range.md)|Returns the range object that is associated with the name. Returns a null object if the named item's type is not a range.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### delete() -Deletes the given name. - -#### Syntax -```js -namedItemObject.delete(); -``` - -#### Parameters -None - -#### Returns -void - -### getRange() -Returns the range object that is associated with the name. Throws an error if the named item's type is not a range. - -#### Syntax -```js -namedItemObject.getRange(); -``` - -#### Parameters -None - -#### Returns -[Range](range.md) - -#### Examples - -Returns the Range object that is associated with the name. `null` if the name is not of the type `Range`. Note: This API currently supports only the Workbook scoped items.** - -```js -Excel.run(function (ctx) { - var names = ctx.workbook.names; - var range = names.getItem('MyRange').getRange(); - range.load('address'); - return ctx.sync().then(function() { - console.log(range.address); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getRangeOrNullObject() -Returns the range object that is associated with the name. Returns a null object if the named item's type is not a range. - -#### Syntax -```js -namedItemObject.getRangeOrNullObject(); -``` - -#### Parameters -None - -#### Returns -[Range](range.md) -### Property access examples - -```js -Excel.run(function (ctx) { - var names = ctx.workbook.names; - var namedItem = names.getItem('MyRange'); - namedItem.load('type'); - return ctx.sync().then(function() { - console.log(namedItem.type); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` +# NamedItem Object (JavaScript API for Excel) + +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, reference to a range. This object can be used to obtain range object associated with names. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|comment|string|Represents the comment associated with this name.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|name|string|The name of the object. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|scope|string|Indicates whether the name is scoped to the workbook or to a specific worksheet. Read-only. Possible values are: Equal, Greater, GreaterEqual, Less, LessEqual, NotEqual.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|type|string|Indicates the type of the value returned by the name's formula. Read-only. Possible values are: String, Integer, Double, Boolean, Range.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|value|object|Represents the value computed by the name's formula. For a named range, will return the range address. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|visible|bool|Specifies whether the object is visible or not.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|worksheet|[Worksheet](worksheet.md)|Returns the worksheet on which the named item is scoped to. Throws an error if the items is scoped to the workbook instead. Read-only.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|worksheetOrNullObject|[Worksheet](worksheet.md)|Returns the worksheet on which the named item is scoped to. Returns a null object if the item is scoped to the workbook instead. Read-only.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[delete()](#delete)|void|Deletes the given name.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|[getRange()](#getrange)|[Range](range.md)|Returns the range object that is associated with the name. Throws an error if the named item's type is not a range.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getRangeOrNullObject()](#getrangeornullobject)|[Range](range.md)|Returns the range object that is associated with the name. Returns a null object if the named item's type is not a range.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### delete() +Deletes the given name. + +#### Syntax +```js +namedItemObject.delete(); +``` + +#### Parameters +None + +#### Returns +void + +### getRange() +Returns the range object that is associated with the name. Throws an error if the named item's type is not a range. + +#### Syntax +```js +namedItemObject.getRange(); +``` + +#### Parameters +None + +#### Returns +[Range](range.md) + +#### Examples + +Returns the Range object that is associated with the name. `null` if the name is not of the type `Range`. Note: This API currently supports only the Workbook scoped items.** + +```js +Excel.run(function (ctx) { + var names = ctx.workbook.names; + var range = names.getItem('MyRange').getRange(); + range.load('address'); + return ctx.sync().then(function() { + console.log(range.address); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getRangeOrNullObject() +Returns the range object that is associated with the name. Returns a null object if the named item's type is not a range. + +#### Syntax +```js +namedItemObject.getRangeOrNullObject(); +``` + +#### Parameters +None + +#### Returns +[Range](range.md) +### Property access examples + +```js +Excel.run(function (ctx) { + var names = ctx.workbook.names; + var namedItem = names.getItem('MyRange'); + namedItem.load('type'); + return ctx.sync().then(function() { + console.log(namedItem.type); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` diff --git a/markdown/nameditemcollection.md b/markdown/nameditemcollection.md index 6b6b338..847e608 100644 --- a/markdown/nameditemcollection.md +++ b/markdown/nameditemcollection.md @@ -1,149 +1,149 @@ -# NamedItemCollection Object (JavaScript API for Excel) - -A collection of all the nameditem objects that are part of the workbook or worksheet, depending on how it was reached. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|items|[NamedItem[]](nameditem.md)|A collection of namedItem objects. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[add(name: string, reference: Range or string, comment: string)](#addname-string-reference-range-or-string-comment-string)|[NamedItem](nameditem.md)|Adds a new name to the collection of the given scope.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|[addFormulaLocal(name: string, formula: string, comment: string)](#addformulalocalname-string-formula-string-comment-string)|[NamedItem](nameditem.md)|Adds a new name to the collection of the given scope using the user's locale for the formula.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|[getCount()](#getcount)|int|Gets the number of named items in the collection.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|[getItem(name: string)](#getitemname-string)|[NamedItem](nameditem.md)|Gets a nameditem object using its name|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getItemOrNullObject(name: string)](#getitemornullobjectname-string)|[NamedItem](nameditem.md)|Gets a nameditem object using its name. If the nameditem object does not exist, will return a null object.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### add(name: string, reference: Range or string, comment: string) -Adds a new name to the collection of the given scope. - -#### Syntax -```js -namedItemCollectionObject.add(name, reference, comment); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|name|string|The name of the named item.| -|reference|Range or string|The formula or the range that the name will refer to.| -|comment|string|Optional. The comment associated with the named item| - -#### Returns -[NamedItem](nameditem.md) - -### addFormulaLocal(name: string, formula: string, comment: string) -Adds a new name to the collection of the given scope using the user's locale for the formula. - -#### Syntax -```js -namedItemCollectionObject.addFormulaLocal(name, formula, comment); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|name|string|The "name" of the named item.| -|formula|string|The formula in the user's locale that the name will refer to.| -|comment|string|Optional. The comment associated with the named item| - -#### Returns -[NamedItem](nameditem.md) - -### getCount() -Gets the number of named items in the collection. - -#### Syntax -```js -namedItemCollectionObject.getCount(); -``` - -#### Parameters -None - -#### Returns -int - -### getItem(name: string) -Gets a nameditem object using its name - -#### Syntax -```js -namedItemCollectionObject.getItem(name); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|name|string|nameditem name.| - -#### Returns -[NamedItem](nameditem.md) - -#### Examples - -```js -Excel.run(function (ctx) { - var sheetName = 'Sheet1'; - var nameditem = ctx.workbook.names.getItem(sheetName); - nameditem.load('type'); - return ctx.sync().then(function() { - console.log(nameditem.type); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` -### getItemOrNullObject(name: string) -Gets a nameditem object using its name. If the nameditem object does not exist, will return a null object. - -#### Syntax -```js -namedItemCollectionObject.getItemOrNullObject(name); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|name|string|nameditem name.| - -#### Returns -[NamedItem](nameditem.md) -### Property access examples - -```js -Excel.run(function (ctx) { - var nameditems = ctx.workbook.names; - nameditems.load('items'); - return ctx.sync().then(function() { - for (var i = 0; i < nameditems.items.length; i++) - { - console.log(nameditems.items[i].name); - console.log(nameditems.items[i].index); - } - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - +# NamedItemCollection Object (JavaScript API for Excel) + +A collection of all the nameditem objects that are part of the workbook or worksheet, depending on how it was reached. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|items|[NamedItem[]](nameditem.md)|A collection of namedItem objects. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[add(name: string, reference: Range or string, comment: string)](#addname-string-reference-range-or-string-comment-string)|[NamedItem](nameditem.md)|Adds a new name to the collection of the given scope.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|[addFormulaLocal(name: string, formula: string, comment: string)](#addformulalocalname-string-formula-string-comment-string)|[NamedItem](nameditem.md)|Adds a new name to the collection of the given scope using the user's locale for the formula.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|[getCount()](#getcount)|int|Gets the number of named items in the collection.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|[getItem(name: string)](#getitemname-string)|[NamedItem](nameditem.md)|Gets a nameditem object using its name|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getItemOrNullObject(name: string)](#getitemornullobjectname-string)|[NamedItem](nameditem.md)|Gets a nameditem object using its name. If the nameditem object does not exist, will return a null object.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### add(name: string, reference: Range or string, comment: string) +Adds a new name to the collection of the given scope. + +#### Syntax +```js +namedItemCollectionObject.add(name, reference, comment); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|name|string|The name of the named item.| +|reference|Range or string|The formula or the range that the name will refer to.| +|comment|string|Optional. The comment associated with the named item| + +#### Returns +[NamedItem](nameditem.md) + +### addFormulaLocal(name: string, formula: string, comment: string) +Adds a new name to the collection of the given scope using the user's locale for the formula. + +#### Syntax +```js +namedItemCollectionObject.addFormulaLocal(name, formula, comment); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|name|string|The "name" of the named item.| +|formula|string|The formula in the user's locale that the name will refer to.| +|comment|string|Optional. The comment associated with the named item| + +#### Returns +[NamedItem](nameditem.md) + +### getCount() +Gets the number of named items in the collection. + +#### Syntax +```js +namedItemCollectionObject.getCount(); +``` + +#### Parameters +None + +#### Returns +int + +### getItem(name: string) +Gets a nameditem object using its name + +#### Syntax +```js +namedItemCollectionObject.getItem(name); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|name|string|nameditem name.| + +#### Returns +[NamedItem](nameditem.md) + +#### Examples + +```js +Excel.run(function (ctx) { + var sheetName = 'Sheet1'; + var nameditem = ctx.workbook.names.getItem(sheetName); + nameditem.load('type'); + return ctx.sync().then(function() { + console.log(nameditem.type); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` +### getItemOrNullObject(name: string) +Gets a nameditem object using its name. If the nameditem object does not exist, will return a null object. + +#### Syntax +```js +namedItemCollectionObject.getItemOrNullObject(name); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|name|string|nameditem name.| + +#### Returns +[NamedItem](nameditem.md) +### Property access examples + +```js +Excel.run(function (ctx) { + var nameditems = ctx.workbook.names; + nameditems.load('items'); + return ctx.sync().then(function() { + for (var i = 0; i < nameditems.items.length; i++) + { + console.log(nameditems.items[i].name); + console.log(nameditems.items[i].index); + } + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + diff --git a/markdown/pivottable.md b/markdown/pivottable.md index 1a766ec..f4feed7 100644 --- a/markdown/pivottable.md +++ b/markdown/pivottable.md @@ -1,40 +1,40 @@ -# PivotTable Object (JavaScript API for Excel) - -Represents an Excel PivotTable. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|id|string|Id of the PivotTable. Read-only.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| -|name|string|Name of the PivotTable.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|worksheet|[Worksheet](worksheet.md)|The worksheet containing the current PivotTable. Read-only.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[refresh()](#refresh)|void|Refreshes the PivotTable.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### refresh() -Refreshes the PivotTable. - -#### Syntax -```js -pivotTableObject.refresh(); -``` - -#### Parameters -None - -#### Returns -void +# PivotTable Object (JavaScript API for Excel) + +Represents an Excel PivotTable. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|id|string|Id of the PivotTable. Read-only.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| +|name|string|Name of the PivotTable.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|worksheet|[Worksheet](worksheet.md)|The worksheet containing the current PivotTable. Read-only.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[refresh()](#refresh)|void|Refreshes the PivotTable.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### refresh() +Refreshes the PivotTable. + +#### Syntax +```js +pivotTableObject.refresh(); +``` + +#### Parameters +None + +#### Returns +void diff --git a/markdown/pivottablecollection.md b/markdown/pivottablecollection.md index 40a6d39..3bfd334 100644 --- a/markdown/pivottablecollection.md +++ b/markdown/pivottablecollection.md @@ -1,87 +1,87 @@ -# PivotTableCollection Object (JavaScript API for Excel) - -Represents a collection of all the PivotTables that are part of the workbook or worksheet. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|items|[PivotTable[]](pivottable.md)|A collection of pivotTable objects. Read-only.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[getCount()](#getcount)|int|Gets the number of pivot tables in the collection.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|[getItem(name: string)](#getitemname-string)|[PivotTable](pivottable.md)|Gets a PivotTable by name.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| -|[getItemOrNullObject(name: string)](#getitemornullobjectname-string)|[PivotTable](pivottable.md)|Gets a PivotTable by name. If the PivotTable does not exist, will return a null object.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|[refreshAll()](#refreshall)|void|Refreshes all the pivot tables in the collection.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### getCount() -Gets the number of pivot tables in the collection. - -#### Syntax -```js -pivotTableCollectionObject.getCount(); -``` - -#### Parameters -None - -#### Returns -int - -### getItem(name: string) -Gets a PivotTable by name. - -#### Syntax -```js -pivotTableCollectionObject.getItem(name); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|name|string|Name of the PivotTable to be retrieved.| - -#### Returns -[PivotTable](pivottable.md) - -### getItemOrNullObject(name: string) -Gets a PivotTable by name. If the PivotTable does not exist, will return a null object. - -#### Syntax -```js -pivotTableCollectionObject.getItemOrNullObject(name); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|name|string|Name of the PivotTable to be retrieved.| - -#### Returns -[PivotTable](pivottable.md) - -### refreshAll() -Refreshes all the pivot tables in the collection. - -#### Syntax -```js -pivotTableCollectionObject.refreshAll(); -``` - -#### Parameters -None - -#### Returns -void +# PivotTableCollection Object (JavaScript API for Excel) + +Represents a collection of all the PivotTables that are part of the workbook or worksheet. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|items|[PivotTable[]](pivottable.md)|A collection of pivotTable objects. Read-only.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[getCount()](#getcount)|int|Gets the number of pivot tables in the collection.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|[getItem(name: string)](#getitemname-string)|[PivotTable](pivottable.md)|Gets a PivotTable by name.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| +|[getItemOrNullObject(name: string)](#getitemornullobjectname-string)|[PivotTable](pivottable.md)|Gets a PivotTable by name. If the PivotTable does not exist, will return a null object.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|[refreshAll()](#refreshall)|void|Refreshes all the pivot tables in the collection.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### getCount() +Gets the number of pivot tables in the collection. + +#### Syntax +```js +pivotTableCollectionObject.getCount(); +``` + +#### Parameters +None + +#### Returns +int + +### getItem(name: string) +Gets a PivotTable by name. + +#### Syntax +```js +pivotTableCollectionObject.getItem(name); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|name|string|Name of the PivotTable to be retrieved.| + +#### Returns +[PivotTable](pivottable.md) + +### getItemOrNullObject(name: string) +Gets a PivotTable by name. If the PivotTable does not exist, will return a null object. + +#### Syntax +```js +pivotTableCollectionObject.getItemOrNullObject(name); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|name|string|Name of the PivotTable to be retrieved.| + +#### Returns +[PivotTable](pivottable.md) + +### refreshAll() +Refreshes all the pivot tables in the collection. + +#### Syntax +```js +pivotTableCollectionObject.refreshAll(); +``` + +#### Parameters +None + +#### Returns +void diff --git a/markdown/presetcriteriaconditionalformat.md b/markdown/presetcriteriaconditionalformat.md index 0dc9056..1ed9122 100644 --- a/markdown/presetcriteriaconditionalformat.md +++ b/markdown/presetcriteriaconditionalformat.md @@ -1,17 +1,17 @@ -# PresetCriteriaConditionalFormat Object (JavaScript API for Excel) - -Represents the the preset criteria conditional format such as above averagebelow averageunique valuescontains blanknonblankerrornoerror. - -## Properties - -None - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|format|[ConditionalRangeFormat](conditionalrangeformat.md)|Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|rule|[ConditionalPresetCriteriaRule](conditionalpresetcriteriarule.md)|The rule of the conditional format.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# PresetCriteriaConditionalFormat Object (JavaScript API for Excel) + +Represents the the preset criteria conditional format such as above averagebelow averageunique valuescontains blanknonblankerrornoerror. + +## Properties + +None + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|format|[ConditionalRangeFormat](conditionalrangeformat.md)|Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|rule|[ConditionalPresetCriteriaRule](conditionalpresetcriteriarule.md)|The rule of the conditional format.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/range.md b/markdown/range.md index 88f9d98..4b1fa30 100644 --- a/markdown/range.md +++ b/markdown/range.md @@ -1,963 +1,963 @@ -# Range Object (JavaScript API for Excel) - -Range represents a set of one or more contiguous cells such as a cell, a row, a column, block of cells, etc. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|address|string|Represents the range reference in A1-style. Address value will contain the Sheet reference (e.g. Sheet1!A1:B4). Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|addressLocal|string|Represents range reference for the specified range in the language of the user. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|cellCount|int|Number of cells in the range. This API will return -1 if the cell count exceeds 2^31-1 (2,147,483,647). Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|columnCount|int|Represents the total number of columns in the range. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|columnHidden|bool|Represents if all columns of the current range are hidden.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|columnIndex|int|Represents the column number of the first cell in the range. Zero-indexed. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|formulas|object[][]|Represents the formula in A1-style notation.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|formulasLocal|object[][]|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.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|formulasR1C1|object[][]|Represents the formula in R1C1-style notation.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|hidden|bool|Represents if all cells of the current range are hidden. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|numberFormat|object[][]|Represents Excel's number format code for the given cell.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|rowCount|int|Returns the total number of rows in the range. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|rowHidden|bool|Represents if all rows of the current range are hidden.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|rowIndex|int|Returns the row number of the first cell in the range. Zero-indexed. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|text|object[][]|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. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|valueTypes|string|Represents the type of data of each cell. Read-only. Possible values are: Unknown, Empty, String, Integer, Double, Boolean, Error.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|values|object[][]|Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|conditionalFormats|[ConditionalFormatCollection](conditionalformatcollection.md)|Collection of ConditionalFormats that intersect the range. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|format|[RangeFormat](rangeformat.md)|Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|sort|[RangeSort](rangesort.md)|Represents the range sort of the current range. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|worksheet|[Worksheet](worksheet.md)|The worksheet containing the current range. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[calculate()](#calculate)|void|Calculates a range of cells on a worksheet.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|[clear(applyTo: string)](#clearapplyto-string)|void|Clear range values, format, fill, border, etc.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[delete(shift: string)](#deleteshift-string)|void|Deletes the cells associated with the range.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getBoundingRect(anotherRange: Range or string)](#getboundingrectanotherrange-range-or-string)|[Range](range.md)|Gets the smallest range object that encompasses the given ranges. For example, the GetBoundingRect of "B2:C5" and "D10:E15" is "B2:E16".|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getCell(row: number, column: number)](#getcellrow-number-column-number)|[Range](range.md)|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's stays within the worksheet grid. The returned cell is located relative to the top left cell of the range.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getColumn(column: number)](#getcolumncolumn-number)|[Range](range.md)|Gets a column contained in the range.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getColumnsAfter(count: number)](#getcolumnsaftercount-number)|[Range](range.md)|Gets a certain number of columns to the right of the current Range object.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getColumnsBefore(count: number)](#getcolumnsbeforecount-number)|[Range](range.md)|Gets a certain number of columns to the left of the current Range object.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getEntireColumn()](#getentirecolumn)|[Range](range.md)|Gets an object that represents the entire column of the range (for example, if the current range represents cells "B4:E11", it's `getEntireColumn` is a range that represents columns "B:E").|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getEntireRow()](#getentirerow)|[Range](range.md)|Gets an object that represents the entire row of the range (for example, if the current range represents cells "B4:E11", it's `GetEntireRow` is a range that represents rows "4:11").|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getIntersection(anotherRange: Range or string)](#getintersectionanotherrange-range-or-string)|[Range](range.md)|Gets the range object that represents the rectangular intersection of the given ranges.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getIntersectionOrNullObject(anotherRange: Range or string)](#getintersectionornullobjectanotherrange-range-or-string)|[Range](range.md)|Gets the range object that represents the rectangular intersection of the given ranges. If no intersection is found, will return a null object.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|[getLastCell()](#getlastcell)|[Range](range.md)|Gets the last cell within the range. For example, the last cell of "B2:D5" is "D5".|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getLastColumn()](#getlastcolumn)|[Range](range.md)|Gets the last column within the range. For example, the last column of "B2:D5" is "D2:D5".|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getLastRow()](#getlastrow)|[Range](range.md)|Gets the last row within the range. For example, the last row of "B2:D5" is "B5:D5".|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getOffsetRange(rowOffset: number, columnOffset: number)](#getoffsetrangerowoffset-number-columnoffset-number)|[Range](range.md)|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.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getResizedRange(deltaRows: number, deltaColumns: number)](#getresizedrangedeltarows-number-deltacolumns-number)|[Range](range.md)|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.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getRow(row: number)](#getrowrow-number)|[Range](range.md)|Gets a row contained in the range.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getRowsAbove(count: number)](#getrowsabovecount-number)|[Range](range.md)|Gets a certain number of rows above the current Range object.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getRowsBelow(count: number)](#getrowsbelowcount-number)|[Range](range.md)|Gets a certain number of rows below the current Range object.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getUsedRange(valuesOnly: bool)](#getusedrangevaluesonly-bool)|[Range](range.md)|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.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getUsedRangeOrNullObject(valuesOnly: bool)](#getusedrangeornullobjectvaluesonly-bool)|[Range](range.md)|Returns the used range of the given range object. If there are no used cells within the range, this function will return a null object.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|[getVisibleView()](#getvisibleview)|[RangeView](rangeview.md)|Represents the visible rows of the current range.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| -|[insert(shift: string)](#insertshift-string)|[Range](range.md)|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.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[merge(across: bool)](#mergeacross-bool)|void|Merge the range cells into one region in the worksheet.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|[select()](#select)|void|Selects the specified range in the Excel UI.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[unmerge()](#unmerge)|void|Unmerge the range cells into separate cells.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### calculate() -Calculates a range of cells on a worksheet. - -#### Syntax -```js -rangeObject.calculate(); -``` - -#### Parameters -None - -#### Returns -void - -### clear(applyTo: string) -Clear range values, format, fill, border, etc. - -#### Syntax -```js -rangeObject.clear(applyTo); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|applyTo|string|Optional. Determines the type of clear action. Possible values are: `All` Default-option,`Formats` ,`Contents` | - -#### Returns -void - -#### Examples - -Below example clears format and contents of the range. - -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "D:F"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); - range.clear(); - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### delete(shift: string) -Deletes the cells associated with the range. - -#### Syntax -```js -rangeObject.delete(shift); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|shift|string|Specifies which way to shift the cells. Possible values are: Up, Left| - -#### Returns -void - -#### Examples - -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "D:F"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); - range.delete(); - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getBoundingRect(anotherRange: Range or string) -Gets the smallest range object that encompasses the given ranges. For example, the GetBoundingRect of "B2:C5" and "D10:E15" is "B2:E16". - -#### Syntax -```js -rangeObject.getBoundingRect(anotherRange); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|anotherRange|Range or string|The range object or address or range name.| - -#### Returns -[Range](range.md) - -#### Examples - -```js - -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "D4:G6"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); - var range = range.getBoundingRect("G4:H8"); - range.load('address'); - return ctx.sync().then(function() { - console.log(range.address); // Prints Sheet1!D4:H8 - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getCell(row: number, column: number) -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's stays within the worksheet grid. The returned cell is located relative to the top left cell of the range. - -#### Syntax -```js -rangeObject.getCell(row, column); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|row|number|Row number of the cell to be retrieved. Zero-indexed.| -|column|number|Column number of the cell to be retrieved. Zero-indexed.| - -#### Returns -[Range](range.md) - -#### Examples - -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "A1:F8"; - var worksheet = ctx.workbook.worksheets.getItem(sheetName); - var range = worksheet.getRange(rangeAddress); - var cell = range.cell(0,0); - cell.load('address'); - return ctx.sync().then(function() { - console.log(cell.address); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getColumn(column: number) -Gets a column contained in the range. - -#### Syntax -```js -rangeObject.getColumn(column); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|column|number|Column number of the range to be retrieved. Zero-indexed.| - -#### Returns -[Range](range.md) - -#### Examples - -```js - -Excel.run(function (ctx) { - var sheetName = "Sheet19"; - var rangeAddress = "A1:F8"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getColumn(1); - range.load('address'); - return ctx.sync().then(function() { - console.log(range.address); // prints Sheet1!B1:B8 - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getColumnsAfter(count: number) -Gets a certain number of columns to the right of the current Range object. - -#### Syntax -```js -rangeObject.getColumnsAfter(count); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|count|number|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.| - -#### Returns -[Range](range.md) - -### getColumnsBefore(count: number) -Gets a certain number of columns to the left of the current Range object. - -#### Syntax -```js -rangeObject.getColumnsBefore(count); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|count|number|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.| - -#### Returns -[Range](range.md) - -### getEntireColumn() -Gets an object that represents the entire column of the range (for example, if the current range represents cells "B4:E11", it's `getEntireColumn` is a range that represents columns "B:E"). - -#### Syntax -```js -rangeObject.getEntireColumn(); -``` - -#### Parameters -None - -#### Returns -[Range](range.md) - -#### Examples - -Note: the grid properties of the Range (values, numberFormat, formulas) contains `null` since the Range in question is unbounded. - -```js - -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "D:F"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); - var rangeEC = range.getEntireColumn(); - rangeEC.load('address'); - return ctx.sync().then(function() { - console.log(rangeEC.address); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -### getEntireRow() -Gets an object that represents the entire row of the range (for example, if the current range represents cells "B4:E11", it's `GetEntireRow` is a range that represents rows "4:11"). - -#### Syntax -```js -rangeObject.getEntireRow(); -``` - -#### Parameters -None - -#### Returns -[Range](range.md) - -#### Examples -```js - -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "D:F"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); - var rangeER = range.getEntireRow(); - rangeER.load('address'); - return ctx.sync().then(function() { - console.log(rangeER.address); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` -The grid properties of the Range (values, numberFormat, formulas) contains `null` since the Range in question is unbounded. - - -### getIntersection(anotherRange: Range or string) -Gets the range object that represents the rectangular intersection of the given ranges. - -#### Syntax -```js -rangeObject.getIntersection(anotherRange); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|anotherRange|Range or string|The range object or range address that will be used to determine the intersection of ranges.| - -#### Returns -[Range](range.md) - -#### Examples - -```js - -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "A1:F8"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getIntersection("D4:G6"); - range.load('address'); - return ctx.sync().then(function() { - console.log(range.address); // prints Sheet1!D4:F6 - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getIntersectionOrNullObject(anotherRange: Range or string) -Gets the range object that represents the rectangular intersection of the given ranges. If no intersection is found, will return a null object. - -#### Syntax -```js -rangeObject.getIntersectionOrNullObject(anotherRange); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|anotherRange|Range or string|The range object or range address that will be used to determine the intersection of ranges.| - -#### Returns -[Range](range.md) - -### getLastCell() -Gets the last cell within the range. For example, the last cell of "B2:D5" is "D5". - -#### Syntax -```js -rangeObject.getLastCell(); -``` - -#### Parameters -None - -#### Returns -[Range](range.md) - -#### Examples - -```js - -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "A1:F8"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastCell(); - range.load('address'); - return ctx.sync().then(function() { - console.log(range.address); // prints Sheet1!F8 - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getLastColumn() -Gets the last column within the range. For example, the last column of "B2:D5" is "D2:D5". - -#### Syntax -```js -rangeObject.getLastColumn(); -``` - -#### Parameters -None - -#### Returns -[Range](range.md) - -#### Examples - -```js - -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "A1:F8"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastColumn(); - range.load('address'); - return ctx.sync().then(function() { - console.log(range.address); // prints Sheet1!F1:F8 - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getLastRow() -Gets the last row within the range. For example, the last row of "B2:D5" is "B5:D5". - -#### Syntax -```js -rangeObject.getLastRow(); -``` - -#### Parameters -None - -#### Returns -[Range](range.md) - -#### Examples - -```js - -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "A1:F8"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastRow(); - range.load('address'); - return ctx.sync().then(function() { - console.log(range.address); // prints Sheet1!A8:F8 - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - - -### getOffsetRange(rowOffset: number, columnOffset: number) -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. - -#### Syntax -```js -rangeObject.getOffsetRange(rowOffset, columnOffset); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|rowOffset|number|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.| -|columnOffset|number|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.| - -#### Returns -[Range](range.md) - -#### Examples - -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "D4:F6"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getOffsetRange(-1,4); - range.load('address'); - return ctx.sync().then(function() { - console.log(range.address); // prints Sheet1!H3:K5 - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getResizedRange(deltaRows: number, deltaColumns: number) -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. - -#### Syntax -```js -rangeObject.getResizedRange(deltaRows, deltaColumns); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|deltaRows|number|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.| -|deltaColumns|number|The number of columnsby 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.| - -#### Returns -[Range](range.md) - -### getRow(row: number) -Gets a row contained in the range. - -#### Syntax -```js -rangeObject.getRow(row); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|row|number|Row number of the range to be retrieved. Zero-indexed.| - -#### Returns -[Range](range.md) - -#### Examples - -```js - -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "A1:F8"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getRow(1); - range.load('address'); - return ctx.sync().then(function() { - console.log(range.address); // prints Sheet1!A2:F2 - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getRowsAbove(count: number) -Gets a certain number of rows above the current Range object. - -#### Syntax -```js -rangeObject.getRowsAbove(count); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|count|number|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.| - -#### Returns -[Range](range.md) - -### getRowsBelow(count: number) -Gets a certain number of rows below the current Range object. - -#### Syntax -```js -rangeObject.getRowsBelow(count); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|count|number|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.| - -#### Returns -[Range](range.md) - -### getUsedRange(valuesOnly: bool) -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. - -#### Syntax -```js -rangeObject.getUsedRange(valuesOnly); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|valuesOnly|bool|Optional. Considers only cells with values as used cells.| - -#### Returns -[Range](range.md) - -#### Examples - -```js - -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "D:F"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); - var rangeUR = range.getUsedRange(); - rangeUR.load('address'); - return ctx.sync().then(function() { - console.log(rangeUR.address); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getUsedRangeOrNullObject(valuesOnly: bool) -Returns the used range of the given range object. If there are no used cells within the range, this function will return a null object. - -#### Syntax -```js -rangeObject.getUsedRangeOrNullObject(valuesOnly); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|valuesOnly|bool|Optional. Considers only cells with values as used cells.| - -#### Returns -[Range](range.md) - -### getVisibleView() -Represents the visible rows of the current range. - -#### Syntax -```js -rangeObject.getVisibleView(); -``` - -#### Parameters -None - -#### Returns -[RangeView](rangeview.md) - -### insert(shift: string) -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. - -#### Syntax -```js -rangeObject.insert(shift); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|shift|string|Specifies which way to shift the cells. Possible values are: Down, Right| - -#### Returns -[Range](range.md) - -#### Examples - -```js - -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "F5:F10"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); - range.insert(); - return ctx.sync(); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### merge(across: bool) -Merge the range cells into one region in the worksheet. - -#### Syntax -```js -rangeObject.merge(across); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|across|bool|Optional. Set true to merge cells in each row of the specified range as separate merged cells. The default value is false.| - -#### Returns -void - -#### Examples -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "A1:C3"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); - range.merge(true); - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - - -#### Examples -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "A1:C3"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); - range.unmerge(); - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### select() -Selects the specified range in the Excel UI. - -#### Syntax -```js -rangeObject.select(); -``` - -#### Parameters -None - -#### Returns -void - -#### Examples - -```js - -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "F5:F10"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); - range.select(); - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### unmerge() -Unmerge the range cells into separate cells. - -#### Syntax -```js -rangeObject.unmerge(); -``` - -#### Parameters -None - -#### Returns -void - -#### Examples -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "A1:C3"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); - range.unmerge(); - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -### Property access examples - -Below example uses range address to get the range object. - -```js - -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "A1:F8"; - var worksheet = ctx.workbook.worksheets.getItem(sheetName); - var range = worksheet.getRange(rangeAddress); - range.load('cellCount'); - return ctx.sync().then(function() { - console.log(range.cellCount); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -Below example uses a named-range to get the range object. - -```js - -Excel.run(function (ctx) { - var rangeName = 'MyRange'; - var range = ctx.workbook.names.getItem(rangeName).range; - range.load('cellCount'); - return ctx.sync().then(function() { - console.log(range.cellCount); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -The example below sets number-format, values and formulas on a grid that contains 2x3 grid. - -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "F5:G7"; - var numberFormat = [[null, "d-mmm"], [null, "d-mmm"], [null, null]] - var values = [["Today", 42147], ["Tomorrow", "5/24"], ["Difference in days", null]]; - var formulas = [[null,null], [null,null], [null,"=G6-G5"]]; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); - range.numberFormat = numberFormat; - range.values = values; - range.formulas= formulas; - range.load('text'); - return ctx.sync().then(function() { - console.log(range.text); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` -Get the worksheet containing the range. - -```js -/* This might be broken still - it was broken before because it - it was missing 'var', but might still be wrong because of - getting information without loading properly. */ -Excel.run(function (ctx) { - var names = ctx.workbook.names; - var namedItem = names.getItem('MyRange'); - var range = namedItem.range; - var rangeWorksheet = range.worksheet; - rangeWorksheet.load('name'); - return ctx.sync().then(function() { - console.log(rangeWorksheet.name); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - +# Range Object (JavaScript API for Excel) + +Range represents a set of one or more contiguous cells such as a cell, a row, a column, block of cells, etc. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|address|string|Represents the range reference in A1-style. Address value will contain the Sheet reference (e.g. Sheet1!A1:B4). Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|addressLocal|string|Represents range reference for the specified range in the language of the user. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|cellCount|int|Number of cells in the range. This API will return -1 if the cell count exceeds 2^31-1 (2,147,483,647). Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|columnCount|int|Represents the total number of columns in the range. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|columnHidden|bool|Represents if all columns of the current range are hidden.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|columnIndex|int|Represents the column number of the first cell in the range. Zero-indexed. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|formulas|object[][]|Represents the formula in A1-style notation.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|formulasLocal|object[][]|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.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|formulasR1C1|object[][]|Represents the formula in R1C1-style notation.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|hidden|bool|Represents if all cells of the current range are hidden. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|numberFormat|object[][]|Represents Excel's number format code for the given cell.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|rowCount|int|Returns the total number of rows in the range. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|rowHidden|bool|Represents if all rows of the current range are hidden.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|rowIndex|int|Returns the row number of the first cell in the range. Zero-indexed. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|text|object[][]|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. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|valueTypes|string|Represents the type of data of each cell. Read-only. Possible values are: Unknown, Empty, String, Integer, Double, Boolean, Error.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|values|object[][]|Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|conditionalFormats|[ConditionalFormatCollection](conditionalformatcollection.md)|Collection of ConditionalFormats that intersect the range. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|format|[RangeFormat](rangeformat.md)|Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|sort|[RangeSort](rangesort.md)|Represents the range sort of the current range. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|worksheet|[Worksheet](worksheet.md)|The worksheet containing the current range. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[calculate()](#calculate)|void|Calculates a range of cells on a worksheet.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|[clear(applyTo: string)](#clearapplyto-string)|void|Clear range values, format, fill, border, etc.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[delete(shift: string)](#deleteshift-string)|void|Deletes the cells associated with the range.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getBoundingRect(anotherRange: Range or string)](#getboundingrectanotherrange-range-or-string)|[Range](range.md)|Gets the smallest range object that encompasses the given ranges. For example, the GetBoundingRect of "B2:C5" and "D10:E15" is "B2:E16".|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getCell(row: number, column: number)](#getcellrow-number-column-number)|[Range](range.md)|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's stays within the worksheet grid. The returned cell is located relative to the top left cell of the range.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getColumn(column: number)](#getcolumncolumn-number)|[Range](range.md)|Gets a column contained in the range.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getColumnsAfter(count: number)](#getcolumnsaftercount-number)|[Range](range.md)|Gets a certain number of columns to the right of the current Range object.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getColumnsBefore(count: number)](#getcolumnsbeforecount-number)|[Range](range.md)|Gets a certain number of columns to the left of the current Range object.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getEntireColumn()](#getentirecolumn)|[Range](range.md)|Gets an object that represents the entire column of the range (for example, if the current range represents cells "B4:E11", it's `getEntireColumn` is a range that represents columns "B:E").|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getEntireRow()](#getentirerow)|[Range](range.md)|Gets an object that represents the entire row of the range (for example, if the current range represents cells "B4:E11", it's `GetEntireRow` is a range that represents rows "4:11").|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getIntersection(anotherRange: Range or string)](#getintersectionanotherrange-range-or-string)|[Range](range.md)|Gets the range object that represents the rectangular intersection of the given ranges.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getIntersectionOrNullObject(anotherRange: Range or string)](#getintersectionornullobjectanotherrange-range-or-string)|[Range](range.md)|Gets the range object that represents the rectangular intersection of the given ranges. If no intersection is found, will return a null object.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|[getLastCell()](#getlastcell)|[Range](range.md)|Gets the last cell within the range. For example, the last cell of "B2:D5" is "D5".|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getLastColumn()](#getlastcolumn)|[Range](range.md)|Gets the last column within the range. For example, the last column of "B2:D5" is "D2:D5".|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getLastRow()](#getlastrow)|[Range](range.md)|Gets the last row within the range. For example, the last row of "B2:D5" is "B5:D5".|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getOffsetRange(rowOffset: number, columnOffset: number)](#getoffsetrangerowoffset-number-columnoffset-number)|[Range](range.md)|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.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getResizedRange(deltaRows: number, deltaColumns: number)](#getresizedrangedeltarows-number-deltacolumns-number)|[Range](range.md)|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.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getRow(row: number)](#getrowrow-number)|[Range](range.md)|Gets a row contained in the range.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getRowsAbove(count: number)](#getrowsabovecount-number)|[Range](range.md)|Gets a certain number of rows above the current Range object.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getRowsBelow(count: number)](#getrowsbelowcount-number)|[Range](range.md)|Gets a certain number of rows below the current Range object.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getUsedRange(valuesOnly: bool)](#getusedrangevaluesonly-bool)|[Range](range.md)|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.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getUsedRangeOrNullObject(valuesOnly: bool)](#getusedrangeornullobjectvaluesonly-bool)|[Range](range.md)|Returns the used range of the given range object. If there are no used cells within the range, this function will return a null object.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|[getVisibleView()](#getvisibleview)|[RangeView](rangeview.md)|Represents the visible rows of the current range.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| +|[insert(shift: string)](#insertshift-string)|[Range](range.md)|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.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[merge(across: bool)](#mergeacross-bool)|void|Merge the range cells into one region in the worksheet.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|[select()](#select)|void|Selects the specified range in the Excel UI.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[unmerge()](#unmerge)|void|Unmerge the range cells into separate cells.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### calculate() +Calculates a range of cells on a worksheet. + +#### Syntax +```js +rangeObject.calculate(); +``` + +#### Parameters +None + +#### Returns +void + +### clear(applyTo: string) +Clear range values, format, fill, border, etc. + +#### Syntax +```js +rangeObject.clear(applyTo); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|applyTo|string|Optional. Determines the type of clear action. Possible values are: `All` Default-option,`Formats` ,`Contents` | + +#### Returns +void + +#### Examples + +Below example clears format and contents of the range. + +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "D:F"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + range.clear(); + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### delete(shift: string) +Deletes the cells associated with the range. + +#### Syntax +```js +rangeObject.delete(shift); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|shift|string|Specifies which way to shift the cells. Possible values are: Up, Left| + +#### Returns +void + +#### Examples + +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "D:F"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + range.delete(); + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getBoundingRect(anotherRange: Range or string) +Gets the smallest range object that encompasses the given ranges. For example, the GetBoundingRect of "B2:C5" and "D10:E15" is "B2:E16". + +#### Syntax +```js +rangeObject.getBoundingRect(anotherRange); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|anotherRange|Range or string|The range object or address or range name.| + +#### Returns +[Range](range.md) + +#### Examples + +```js + +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "D4:G6"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + var range = range.getBoundingRect("G4:H8"); + range.load('address'); + return ctx.sync().then(function() { + console.log(range.address); // Prints Sheet1!D4:H8 + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getCell(row: number, column: number) +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's stays within the worksheet grid. The returned cell is located relative to the top left cell of the range. + +#### Syntax +```js +rangeObject.getCell(row, column); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|row|number|Row number of the cell to be retrieved. Zero-indexed.| +|column|number|Column number of the cell to be retrieved. Zero-indexed.| + +#### Returns +[Range](range.md) + +#### Examples + +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "A1:F8"; + var worksheet = ctx.workbook.worksheets.getItem(sheetName); + var range = worksheet.getRange(rangeAddress); + var cell = range.cell(0,0); + cell.load('address'); + return ctx.sync().then(function() { + console.log(cell.address); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getColumn(column: number) +Gets a column contained in the range. + +#### Syntax +```js +rangeObject.getColumn(column); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|column|number|Column number of the range to be retrieved. Zero-indexed.| + +#### Returns +[Range](range.md) + +#### Examples + +```js + +Excel.run(function (ctx) { + var sheetName = "Sheet19"; + var rangeAddress = "A1:F8"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getColumn(1); + range.load('address'); + return ctx.sync().then(function() { + console.log(range.address); // prints Sheet1!B1:B8 + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getColumnsAfter(count: number) +Gets a certain number of columns to the right of the current Range object. + +#### Syntax +```js +rangeObject.getColumnsAfter(count); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|count|number|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.| + +#### Returns +[Range](range.md) + +### getColumnsBefore(count: number) +Gets a certain number of columns to the left of the current Range object. + +#### Syntax +```js +rangeObject.getColumnsBefore(count); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|count|number|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.| + +#### Returns +[Range](range.md) + +### getEntireColumn() +Gets an object that represents the entire column of the range (for example, if the current range represents cells "B4:E11", it's `getEntireColumn` is a range that represents columns "B:E"). + +#### Syntax +```js +rangeObject.getEntireColumn(); +``` + +#### Parameters +None + +#### Returns +[Range](range.md) + +#### Examples + +Note: the grid properties of the Range (values, numberFormat, formulas) contains `null` since the Range in question is unbounded. + +```js + +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "D:F"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + var rangeEC = range.getEntireColumn(); + rangeEC.load('address'); + return ctx.sync().then(function() { + console.log(rangeEC.address); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +### getEntireRow() +Gets an object that represents the entire row of the range (for example, if the current range represents cells "B4:E11", it's `GetEntireRow` is a range that represents rows "4:11"). + +#### Syntax +```js +rangeObject.getEntireRow(); +``` + +#### Parameters +None + +#### Returns +[Range](range.md) + +#### Examples +```js + +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "D:F"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + var rangeER = range.getEntireRow(); + rangeER.load('address'); + return ctx.sync().then(function() { + console.log(rangeER.address); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` +The grid properties of the Range (values, numberFormat, formulas) contains `null` since the Range in question is unbounded. + + +### getIntersection(anotherRange: Range or string) +Gets the range object that represents the rectangular intersection of the given ranges. + +#### Syntax +```js +rangeObject.getIntersection(anotherRange); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|anotherRange|Range or string|The range object or range address that will be used to determine the intersection of ranges.| + +#### Returns +[Range](range.md) + +#### Examples + +```js + +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "A1:F8"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getIntersection("D4:G6"); + range.load('address'); + return ctx.sync().then(function() { + console.log(range.address); // prints Sheet1!D4:F6 + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getIntersectionOrNullObject(anotherRange: Range or string) +Gets the range object that represents the rectangular intersection of the given ranges. If no intersection is found, will return a null object. + +#### Syntax +```js +rangeObject.getIntersectionOrNullObject(anotherRange); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|anotherRange|Range or string|The range object or range address that will be used to determine the intersection of ranges.| + +#### Returns +[Range](range.md) + +### getLastCell() +Gets the last cell within the range. For example, the last cell of "B2:D5" is "D5". + +#### Syntax +```js +rangeObject.getLastCell(); +``` + +#### Parameters +None + +#### Returns +[Range](range.md) + +#### Examples + +```js + +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "A1:F8"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastCell(); + range.load('address'); + return ctx.sync().then(function() { + console.log(range.address); // prints Sheet1!F8 + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getLastColumn() +Gets the last column within the range. For example, the last column of "B2:D5" is "D2:D5". + +#### Syntax +```js +rangeObject.getLastColumn(); +``` + +#### Parameters +None + +#### Returns +[Range](range.md) + +#### Examples + +```js + +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "A1:F8"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastColumn(); + range.load('address'); + return ctx.sync().then(function() { + console.log(range.address); // prints Sheet1!F1:F8 + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getLastRow() +Gets the last row within the range. For example, the last row of "B2:D5" is "B5:D5". + +#### Syntax +```js +rangeObject.getLastRow(); +``` + +#### Parameters +None + +#### Returns +[Range](range.md) + +#### Examples + +```js + +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "A1:F8"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastRow(); + range.load('address'); + return ctx.sync().then(function() { + console.log(range.address); // prints Sheet1!A8:F8 + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + + +### getOffsetRange(rowOffset: number, columnOffset: number) +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. + +#### Syntax +```js +rangeObject.getOffsetRange(rowOffset, columnOffset); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|rowOffset|number|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.| +|columnOffset|number|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.| + +#### Returns +[Range](range.md) + +#### Examples + +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "D4:F6"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getOffsetRange(-1,4); + range.load('address'); + return ctx.sync().then(function() { + console.log(range.address); // prints Sheet1!H3:K5 + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getResizedRange(deltaRows: number, deltaColumns: number) +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. + +#### Syntax +```js +rangeObject.getResizedRange(deltaRows, deltaColumns); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|deltaRows|number|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.| +|deltaColumns|number|The number of columnsby 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.| + +#### Returns +[Range](range.md) + +### getRow(row: number) +Gets a row contained in the range. + +#### Syntax +```js +rangeObject.getRow(row); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|row|number|Row number of the range to be retrieved. Zero-indexed.| + +#### Returns +[Range](range.md) + +#### Examples + +```js + +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "A1:F8"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getRow(1); + range.load('address'); + return ctx.sync().then(function() { + console.log(range.address); // prints Sheet1!A2:F2 + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getRowsAbove(count: number) +Gets a certain number of rows above the current Range object. + +#### Syntax +```js +rangeObject.getRowsAbove(count); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|count|number|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.| + +#### Returns +[Range](range.md) + +### getRowsBelow(count: number) +Gets a certain number of rows below the current Range object. + +#### Syntax +```js +rangeObject.getRowsBelow(count); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|count|number|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.| + +#### Returns +[Range](range.md) + +### getUsedRange(valuesOnly: bool) +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. + +#### Syntax +```js +rangeObject.getUsedRange(valuesOnly); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|valuesOnly|bool|Optional. Considers only cells with values as used cells.| + +#### Returns +[Range](range.md) + +#### Examples + +```js + +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "D:F"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + var rangeUR = range.getUsedRange(); + rangeUR.load('address'); + return ctx.sync().then(function() { + console.log(rangeUR.address); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getUsedRangeOrNullObject(valuesOnly: bool) +Returns the used range of the given range object. If there are no used cells within the range, this function will return a null object. + +#### Syntax +```js +rangeObject.getUsedRangeOrNullObject(valuesOnly); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|valuesOnly|bool|Optional. Considers only cells with values as used cells.| + +#### Returns +[Range](range.md) + +### getVisibleView() +Represents the visible rows of the current range. + +#### Syntax +```js +rangeObject.getVisibleView(); +``` + +#### Parameters +None + +#### Returns +[RangeView](rangeview.md) + +### insert(shift: string) +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. + +#### Syntax +```js +rangeObject.insert(shift); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|shift|string|Specifies which way to shift the cells. Possible values are: Down, Right| + +#### Returns +[Range](range.md) + +#### Examples + +```js + +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "F5:F10"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + range.insert(); + return ctx.sync(); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### merge(across: bool) +Merge the range cells into one region in the worksheet. + +#### Syntax +```js +rangeObject.merge(across); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|across|bool|Optional. Set true to merge cells in each row of the specified range as separate merged cells. The default value is false.| + +#### Returns +void + +#### Examples +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "A1:C3"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + range.merge(true); + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + + +#### Examples +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "A1:C3"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + range.unmerge(); + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### select() +Selects the specified range in the Excel UI. + +#### Syntax +```js +rangeObject.select(); +``` + +#### Parameters +None + +#### Returns +void + +#### Examples + +```js + +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "F5:F10"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + range.select(); + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### unmerge() +Unmerge the range cells into separate cells. + +#### Syntax +```js +rangeObject.unmerge(); +``` + +#### Parameters +None + +#### Returns +void + +#### Examples +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "A1:C3"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + range.unmerge(); + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +### Property access examples + +Below example uses range address to get the range object. + +```js + +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "A1:F8"; + var worksheet = ctx.workbook.worksheets.getItem(sheetName); + var range = worksheet.getRange(rangeAddress); + range.load('cellCount'); + return ctx.sync().then(function() { + console.log(range.cellCount); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +Below example uses a named-range to get the range object. + +```js + +Excel.run(function (ctx) { + var rangeName = 'MyRange'; + var range = ctx.workbook.names.getItem(rangeName).range; + range.load('cellCount'); + return ctx.sync().then(function() { + console.log(range.cellCount); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +The example below sets number-format, values and formulas on a grid that contains 2x3 grid. + +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "F5:G7"; + var numberFormat = [[null, "d-mmm"], [null, "d-mmm"], [null, null]] + var values = [["Today", 42147], ["Tomorrow", "5/24"], ["Difference in days", null]]; + var formulas = [[null,null], [null,null], [null,"=G6-G5"]]; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + range.numberFormat = numberFormat; + range.values = values; + range.formulas= formulas; + range.load('text'); + return ctx.sync().then(function() { + console.log(range.text); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` +Get the worksheet containing the range. + +```js +/* This might be broken still - it was broken before because it + it was missing 'var', but might still be wrong because of + getting information without loading properly. */ +Excel.run(function (ctx) { + var names = ctx.workbook.names; + var namedItem = names.getItem('MyRange'); + var range = namedItem.range; + var rangeWorksheet = range.worksheet; + rangeWorksheet.load('name'); + return ctx.sync().then(function() { + console.log(rangeWorksheet.name); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + diff --git a/markdown/rangeborder.md b/markdown/rangeborder.md index 57c843c..8f667d8 100644 --- a/markdown/rangeborder.md +++ b/markdown/rangeborder.md @@ -1,72 +1,72 @@ -# RangeBorder Object (JavaScript API for Excel) - -Represents the border of an object. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|color|string|HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|id|string|Represents border identifier. Read-only. Possible values are: EdgeTop, EdgeBottom, EdgeLeft, EdgeRight, InsideVertical, InsideHorizontal, DiagonalDown, DiagonalUp.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|sideIndex|string|Constant value that indicates the specific side of the border. Read-only. Possible values are: EdgeTop, EdgeBottom, EdgeLeft, EdgeRight, InsideVertical, InsideHorizontal, DiagonalDown, DiagonalUp.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|style|string|One of the constants of line style specifying the line style for the border. Possible values are: None, Continuous, Dash, DashDot, DashDotDot, Dot, Double, SlantDashDot.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|weight|string|Specifies the weight of the border around a range. Possible values are: Hairline, Thin, Medium, Thick.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods -None - - -## Method Details - -### Property access examples - -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "A1:F8"; - var worksheet = ctx.workbook.worksheets.getItem(sheetName); - var range = worksheet.getRange(rangeAddress); - var borders = range.format.borders; - borders.load('items'); - return ctx.sync().then(function() { - console.log(borders.count); - for (var i = 0; i < borders.items.length; i++) - { - console.log(borders.items[i].sideIndex); - } - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` -The example below adds grid border around the range. - -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "A1:F8"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); - range.format.borders.getItem('InsideHorizontal').style = 'Continuous'; - range.format.borders.getItem('InsideVertical').style = 'Continuous'; - range.format.borders.getItem('EdgeBottom').style = 'Continuous'; - range.format.borders.getItem('EdgeLeft').style = 'Continuous'; - range.format.borders.getItem('EdgeRight').style = 'Continuous'; - range.format.borders.getItem('EdgeTop').style = 'Continuous'; - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - +# RangeBorder Object (JavaScript API for Excel) + +Represents the border of an object. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|color|string|HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|id|string|Represents border identifier. Read-only. Possible values are: EdgeTop, EdgeBottom, EdgeLeft, EdgeRight, InsideVertical, InsideHorizontal, DiagonalDown, DiagonalUp.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|sideIndex|string|Constant value that indicates the specific side of the border. Read-only. Possible values are: EdgeTop, EdgeBottom, EdgeLeft, EdgeRight, InsideVertical, InsideHorizontal, DiagonalDown, DiagonalUp.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|style|string|One of the constants of line style specifying the line style for the border. Possible values are: None, Continuous, Dash, DashDot, DashDotDot, Dot, Double, SlantDashDot.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|weight|string|Specifies the weight of the border around a range. Possible values are: Hairline, Thin, Medium, Thick.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods +None + + +## Method Details + +### Property access examples + +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "A1:F8"; + var worksheet = ctx.workbook.worksheets.getItem(sheetName); + var range = worksheet.getRange(rangeAddress); + var borders = range.format.borders; + borders.load('items'); + return ctx.sync().then(function() { + console.log(borders.count); + for (var i = 0; i < borders.items.length; i++) + { + console.log(borders.items[i].sideIndex); + } + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` +The example below adds grid border around the range. + +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "A1:F8"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + range.format.borders.getItem('InsideHorizontal').style = 'Continuous'; + range.format.borders.getItem('InsideVertical').style = 'Continuous'; + range.format.borders.getItem('EdgeBottom').style = 'Continuous'; + range.format.borders.getItem('EdgeLeft').style = 'Continuous'; + range.format.borders.getItem('EdgeRight').style = 'Continuous'; + range.format.borders.getItem('EdgeTop').style = 'Continuous'; + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + diff --git a/markdown/rangebordercollection.md b/markdown/rangebordercollection.md index 8db40bd..5696c74 100644 --- a/markdown/rangebordercollection.md +++ b/markdown/rangebordercollection.md @@ -1,169 +1,169 @@ -# RangeBorderCollection Object (JavaScript API for Excel) - -Represents the border objects that make up the range border. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|count|int|Number of border objects in the collection. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|items|[RangeBorder[]](rangeborder.md)|A collection of rangeBorder objects. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[getItem(index: string)](#getitemindex-string)|[RangeBorder](rangeborder.md)|Gets a border object using its name|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getItemAt(index: number)](#getitematindex-number)|[RangeBorder](rangeborder.md)|Gets a border object using its index|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### getItem(index: string) -Gets a border object using its name - -#### Syntax -```js -rangeBorderCollectionObject.getItem(index); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|index|string|Index value of the border object to be retrieved. Possible values are: EdgeTop, EdgeBottom, EdgeLeft, EdgeRight, InsideVertical, InsideHorizontal, DiagonalDown, DiagonalUp| - -#### Returns -[RangeBorder](rangeborder.md) - -#### Examples -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "A1:F8"; - var worksheet = ctx.workbook.worksheets.getItem(sheetName); - var range = worksheet.getRange(rangeAddress); - var borderName = 'EdgeTop'; - var border = range.format.borders.getItem(borderName); - border.load('style'); - return ctx.sync().then(function() { - console.log(border.style); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -#### Examples -```js - -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "A1:F8"; - var worksheet = ctx.workbook.worksheets.getItem(sheetName); - var range = worksheet.getRange(rangeAddress); - var border = range.format.borders.getItemAt(0); - border.load('sideIndex'); - return ctx.sync().then(function() { - console.log(border.sideIndex); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getItemAt(index: number) -Gets a border object using its index - -#### Syntax -```js -rangeBorderCollectionObject.getItemAt(index); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|index|number|Index value of the object to be retrieved. Zero-indexed.| - -#### Returns -[RangeBorder](rangeborder.md) - -#### Examples -```js - -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "A1:F8"; - var worksheet = ctx.workbook.worksheets.getItem(sheetName); - var range = worksheet.getRange(rangeAddress); - var border = range.format.borders.getItemAt(0); - border.load('sideIndex'); - return ctx.sync().then(function() { - console.log(border.sideIndex); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -### Property access examples - -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "A1:F8"; - var worksheet = ctx.workbook.worksheets.getItem(sheetName); - var range = worksheet.getRange(rangeAddress); - var borders = range.format.borders; - border.load('items'); - return ctx.sync().then(function() { - console.log(borders.count); - for (var i = 0; i < borders.items.length; i++) - { - console.log(borders.items[i].sideIndex); - } - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` -The example below adds grid border around the range. - -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "A1:F8"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); - range.format.borders.getItem('InsideHorizontal').style = 'Continuous'; - range.format.borders.getItem('InsideVertical').style = 'Continuous'; - range.format.borders.getItem('EdgeBottom').style = 'Continuous'; - range.format.borders.getItem('EdgeLeft').style = 'Continuous'; - range.format.borders.getItem('EdgeRight').style = 'Continuous'; - range.format.borders.getItem('EdgeTop').style = 'Continuous'; - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); +# RangeBorderCollection Object (JavaScript API for Excel) + +Represents the border objects that make up the range border. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|count|int|Number of border objects in the collection. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|items|[RangeBorder[]](rangeborder.md)|A collection of rangeBorder objects. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[getItem(index: string)](#getitemindex-string)|[RangeBorder](rangeborder.md)|Gets a border object using its name|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getItemAt(index: number)](#getitematindex-number)|[RangeBorder](rangeborder.md)|Gets a border object using its index|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### getItem(index: string) +Gets a border object using its name + +#### Syntax +```js +rangeBorderCollectionObject.getItem(index); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|index|string|Index value of the border object to be retrieved. Possible values are: EdgeTop, EdgeBottom, EdgeLeft, EdgeRight, InsideVertical, InsideHorizontal, DiagonalDown, DiagonalUp| + +#### Returns +[RangeBorder](rangeborder.md) + +#### Examples +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "A1:F8"; + var worksheet = ctx.workbook.worksheets.getItem(sheetName); + var range = worksheet.getRange(rangeAddress); + var borderName = 'EdgeTop'; + var border = range.format.borders.getItem(borderName); + border.load('style'); + return ctx.sync().then(function() { + console.log(border.style); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +#### Examples +```js + +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "A1:F8"; + var worksheet = ctx.workbook.worksheets.getItem(sheetName); + var range = worksheet.getRange(rangeAddress); + var border = range.format.borders.getItemAt(0); + border.load('sideIndex'); + return ctx.sync().then(function() { + console.log(border.sideIndex); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getItemAt(index: number) +Gets a border object using its index + +#### Syntax +```js +rangeBorderCollectionObject.getItemAt(index); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|index|number|Index value of the object to be retrieved. Zero-indexed.| + +#### Returns +[RangeBorder](rangeborder.md) + +#### Examples +```js + +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "A1:F8"; + var worksheet = ctx.workbook.worksheets.getItem(sheetName); + var range = worksheet.getRange(rangeAddress); + var border = range.format.borders.getItemAt(0); + border.load('sideIndex'); + return ctx.sync().then(function() { + console.log(border.sideIndex); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +### Property access examples + +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "A1:F8"; + var worksheet = ctx.workbook.worksheets.getItem(sheetName); + var range = worksheet.getRange(rangeAddress); + var borders = range.format.borders; + border.load('items'); + return ctx.sync().then(function() { + console.log(borders.count); + for (var i = 0; i < borders.items.length; i++) + { + console.log(borders.items[i].sideIndex); + } + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` +The example below adds grid border around the range. + +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "A1:F8"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + range.format.borders.getItem('InsideHorizontal').style = 'Continuous'; + range.format.borders.getItem('InsideVertical').style = 'Continuous'; + range.format.borders.getItem('EdgeBottom').style = 'Continuous'; + range.format.borders.getItem('EdgeLeft').style = 'Continuous'; + range.format.borders.getItem('EdgeRight').style = 'Continuous'; + range.format.borders.getItem('EdgeTop').style = 'Continuous'; + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); ``` \ No newline at end of file diff --git a/markdown/rangefill.md b/markdown/rangefill.md index 1d0d5c5..a9cf6ff 100644 --- a/markdown/rangefill.md +++ b/markdown/rangefill.md @@ -1,95 +1,95 @@ -# RangeFill Object (JavaScript API for Excel) - -Represents the background of a range object. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|color|string|HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange")|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[clear()](#clear)|void|Resets the range background.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### clear() -Resets the range background. - -#### Syntax -```js -rangeFillObject.clear(); -``` - -#### Parameters -None - -#### Returns -void - -#### Examples - -This example resets the range background. - -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "F:G"; - var worksheet = ctx.workbook.worksheets.getItem(sheetName); - var range = worksheet.getRange(rangeAddress); - var rangeFill = range.format.fill; - rangeFill.clear(); - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -### Property access examples -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "F:G"; - var worksheet = ctx.workbook.worksheets.getItem(sheetName); - var range = worksheet.getRange(rangeAddress); - var rangeFill = range.format.fill; - rangeFill.load('color'); - return ctx.sync().then(function() { - console.log(rangeFill.color); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` -The example below sets fill color. - -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "F:G"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); - range.format.fill.color = '0000FF'; - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); +# RangeFill Object (JavaScript API for Excel) + +Represents the background of a range object. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|color|string|HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange")|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[clear()](#clear)|void|Resets the range background.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### clear() +Resets the range background. + +#### Syntax +```js +rangeFillObject.clear(); +``` + +#### Parameters +None + +#### Returns +void + +#### Examples + +This example resets the range background. + +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "F:G"; + var worksheet = ctx.workbook.worksheets.getItem(sheetName); + var range = worksheet.getRange(rangeAddress); + var rangeFill = range.format.fill; + rangeFill.clear(); + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +### Property access examples +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "F:G"; + var worksheet = ctx.workbook.worksheets.getItem(sheetName); + var range = worksheet.getRange(rangeAddress); + var rangeFill = range.format.fill; + rangeFill.load('color'); + return ctx.sync().then(function() { + console.log(rangeFill.color); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` +The example below sets fill color. + +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "F:G"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + range.format.fill.color = '0000FF'; + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); ``` \ No newline at end of file diff --git a/markdown/rangefont.md b/markdown/rangefont.md index 5df2b36..e1e5c17 100644 --- a/markdown/rangefont.md +++ b/markdown/rangefont.md @@ -1,63 +1,63 @@ -# RangeFont Object (JavaScript API for Excel) - -This object represents the font attributes (font name, font size, color, etc.) for an object. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|bold|bool|Represents the bold status of font.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|color|string|HTML color code representation of the text color. E.g. #FF0000 represents Red.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|italic|bool|Represents the italic status of the font.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|name|string|Font name (e.g. "Calibri")|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|size|double|Font size.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|underline|string|Type of underline applied to the font. Possible values are: None, Single, Double, SingleAccountant, DoubleAccountant.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods -None - - -## Method Details - -### Property access examples - -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "F:G"; - var worksheet = ctx.workbook.worksheets.getItem(sheetName); - var range = worksheet.getRange(rangeAddress); - var rangeFont = range.format.font; - rangeFont.load('name'); - return ctx.sync().then(function() { - console.log(rangeFont.name); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` -The example below sets font name. - -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "F:G"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); - range.format.font.name = 'Times New Roman'; - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); +# RangeFont Object (JavaScript API for Excel) + +This object represents the font attributes (font name, font size, color, etc.) for an object. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|bold|bool|Represents the bold status of font.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|color|string|HTML color code representation of the text color. E.g. #FF0000 represents Red.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|italic|bool|Represents the italic status of the font.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|name|string|Font name (e.g. "Calibri")|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|size|double|Font size.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|underline|string|Type of underline applied to the font. Possible values are: None, Single, Double, SingleAccountant, DoubleAccountant.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods +None + + +## Method Details + +### Property access examples + +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "F:G"; + var worksheet = ctx.workbook.worksheets.getItem(sheetName); + var range = worksheet.getRange(rangeAddress); + var rangeFont = range.format.font; + rangeFont.load('name'); + return ctx.sync().then(function() { + console.log(rangeFont.name); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` +The example below sets font name. + +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "F:G"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + range.format.font.name = 'Times New Roman'; + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); ``` \ No newline at end of file diff --git a/markdown/rangeformat.md b/markdown/rangeformat.md index 3fbca20..7eefae4 100644 --- a/markdown/rangeformat.md +++ b/markdown/rangeformat.md @@ -1,125 +1,125 @@ -# RangeFormat Object (JavaScript API for Excel) - -A format object encapsulating the range's font, fill, borders, alignment, and other properties. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|columnWidth|double|Gets or sets the width of all colums within the range. If the column widths are not uniform, null will be returned.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|horizontalAlignment|string|Represents the horizontal alignment for the specified object. Possible values are: General, Left, Center, Right, Fill, Justify, CenterAcrossSelection, Distributed.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|rowHeight|double|Gets or sets the height of all rows in the range. If the row heights are not uniform null will be returned.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|verticalAlignment|string|Represents the vertical alignment for the specified object. Possible values are: Top, Center, Bottom, Justify, Distributed.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|wrapText|bool|Indicates if Excel wraps the text in the object. A null value indicates that the entire range doesn't have uniform wrap setting|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|borders|[RangeBorderCollection](rangebordercollection.md)|Collection of border objects that apply to the overall range. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|fill|[RangeFill](rangefill.md)|Returns the fill object defined on the overall range. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|font|[RangeFont](rangefont.md)|Returns the font object defined on the overall range. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|protection|[FormatProtection](formatprotection.md)|Returns the format protection object for a range. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[autofitColumns()](#autofitcolumns)|void|Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|[autofitRows()](#autofitrows)|void|Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### autofitColumns() -Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. - -#### Syntax -```js -rangeFormatObject.autofitColumns(); -``` - -#### Parameters -None - -#### Returns -void - -### autofitRows() -Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns. - -#### Syntax -```js -rangeFormatObject.autofitRows(); -``` - -#### Parameters -None - -#### Returns -void -### Property access examples - -Below example selects all of the Range's format properties. - -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "F:G"; - var worksheet = ctx.workbook.worksheets.getItem(sheetName); - var range = worksheet.getRange(rangeAddress); - range.load(["format/*", "format/fill", "format/borders", "format/font"]); - return ctx.sync().then(function() { - console.log(range.format.wrapText); - console.log(range.format.fill.color); - console.log(range.format.font.name); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -The example below sets font name, fill color and wraps text. - -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "F:G"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); - range.format.wrapText = true; - range.format.font.name = 'Times New Roman'; - range.format.fill.color = '0000FF'; - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -The example below adds grid border around the range. - -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "F:G"; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); - range.format.borders.getItem('InsideHorizontal').style = 'Continuous'; - range.format.borders.getItem('InsideVertical').style = 'Continuous'; - range.format.borders.getItem('EdgeBottom').style = 'Continuous'; - range.format.borders.getItem('EdgeLeft').style = 'Continuous'; - range.format.borders.getItem('EdgeRight').style = 'Continuous'; - range.format.borders.getItem('EdgeTop').style = 'Continuous'; - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); +# RangeFormat Object (JavaScript API for Excel) + +A format object encapsulating the range's font, fill, borders, alignment, and other properties. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|columnWidth|double|Gets or sets the width of all colums within the range. If the column widths are not uniform, null will be returned.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|horizontalAlignment|string|Represents the horizontal alignment for the specified object. Possible values are: General, Left, Center, Right, Fill, Justify, CenterAcrossSelection, Distributed.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|rowHeight|double|Gets or sets the height of all rows in the range. If the row heights are not uniform null will be returned.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|verticalAlignment|string|Represents the vertical alignment for the specified object. Possible values are: Top, Center, Bottom, Justify, Distributed.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|wrapText|bool|Indicates if Excel wraps the text in the object. A null value indicates that the entire range doesn't have uniform wrap setting|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|borders|[RangeBorderCollection](rangebordercollection.md)|Collection of border objects that apply to the overall range. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|fill|[RangeFill](rangefill.md)|Returns the fill object defined on the overall range. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|font|[RangeFont](rangefont.md)|Returns the font object defined on the overall range. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|protection|[FormatProtection](formatprotection.md)|Returns the format protection object for a range. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[autofitColumns()](#autofitcolumns)|void|Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|[autofitRows()](#autofitrows)|void|Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### autofitColumns() +Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. + +#### Syntax +```js +rangeFormatObject.autofitColumns(); +``` + +#### Parameters +None + +#### Returns +void + +### autofitRows() +Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns. + +#### Syntax +```js +rangeFormatObject.autofitRows(); +``` + +#### Parameters +None + +#### Returns +void +### Property access examples + +Below example selects all of the Range's format properties. + +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "F:G"; + var worksheet = ctx.workbook.worksheets.getItem(sheetName); + var range = worksheet.getRange(rangeAddress); + range.load(["format/*", "format/fill", "format/borders", "format/font"]); + return ctx.sync().then(function() { + console.log(range.format.wrapText); + console.log(range.format.fill.color); + console.log(range.format.font.name); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +The example below sets font name, fill color and wraps text. + +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "F:G"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + range.format.wrapText = true; + range.format.font.name = 'Times New Roman'; + range.format.fill.color = '0000FF'; + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +The example below adds grid border around the range. + +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "F:G"; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + range.format.borders.getItem('InsideHorizontal').style = 'Continuous'; + range.format.borders.getItem('InsideVertical').style = 'Continuous'; + range.format.borders.getItem('EdgeBottom').style = 'Continuous'; + range.format.borders.getItem('EdgeLeft').style = 'Continuous'; + range.format.borders.getItem('EdgeRight').style = 'Continuous'; + range.format.borders.getItem('EdgeTop').style = 'Continuous'; + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); ``` \ No newline at end of file diff --git a/markdown/rangereference.md b/markdown/rangereference.md index 3783068..d4c5332 100644 --- a/markdown/rangereference.md +++ b/markdown/rangereference.md @@ -1,19 +1,19 @@ -# RangeReference Object (JavaScript API for Excel) - -Represents a string reference of the form SheetName!A1:B5, or a global or local named range. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|address|string|Represents the visible rows of the current range.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods -None - +# RangeReference Object (JavaScript API for Excel) + +Represents a string reference of the form SheetName!A1:B5, or a global or local named range. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|address|string|Represents the visible rows of the current range.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods +None + diff --git a/markdown/rangesort.md b/markdown/rangesort.md index dc21bbb..50c710a 100644 --- a/markdown/rangesort.md +++ b/markdown/rangesort.md @@ -1,40 +1,40 @@ -# RangeSort Object (JavaScript API for Excel) - -Manages sorting operations on Range objects. - -## Properties - -None - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[apply(fields: SortField[], matchCase: bool, hasHeaders: bool, orientation: string, method: string)](#applyfields-sortfield-matchcase-bool-hasheaders-bool-orientation-string-method-string)|void|Perform a sort operation.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### apply(fields: SortField[], matchCase: bool, hasHeaders: bool, orientation: string, method: string) -Perform a sort operation. - -#### Syntax -```js -rangeSortObject.apply(fields, matchCase, hasHeaders, orientation, method); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|fields|SortField[]|The list of conditions to sort on.| -|matchCase|bool|Optional. Whether to have the casing impact string ordering.| -|hasHeaders|bool|Optional. Whether the range has a header.| -|orientation|string|Optional. Whether the operation is sorting rows or columns. Possible values are: Rows, Columns| -|method|string|Optional. The ordering method used for Chinese characters. Possible values are: PinYin, StrokeCount| - -#### Returns -void +# RangeSort Object (JavaScript API for Excel) + +Manages sorting operations on Range objects. + +## Properties + +None + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[apply(fields: SortField[], matchCase: bool, hasHeaders: bool, orientation: string, method: string)](#applyfields-sortfield-matchcase-bool-hasheaders-bool-orientation-string-method-string)|void|Perform a sort operation.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### apply(fields: SortField[], matchCase: bool, hasHeaders: bool, orientation: string, method: string) +Perform a sort operation. + +#### Syntax +```js +rangeSortObject.apply(fields, matchCase, hasHeaders, orientation, method); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|fields|SortField[]|The list of conditions to sort on.| +|matchCase|bool|Optional. Whether to have the casing impact string ordering.| +|hasHeaders|bool|Optional. Whether the range has a header.| +|orientation|string|Optional. Whether the operation is sorting rows or columns. Possible values are: Rows, Columns| +|method|string|Optional. The ordering method used for Chinese characters. Possible values are: PinYin, StrokeCount| + +#### Returns +void diff --git a/markdown/rangeview.md b/markdown/rangeview.md index ba12736..d9d26ec 100644 --- a/markdown/rangeview.md +++ b/markdown/rangeview.md @@ -1,49 +1,49 @@ -# RangeView Object (JavaScript API for Excel) - -RangeView represents a set of visible cells of the parent range. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|cellAddresses|object[][]|Represents the cell addresses of the RangeView. Read-only.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| -|columnCount|int|Returns the number of visible columns. Read-only.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| -|formulas|object[][]|Represents the formula in A1-style notation.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| -|formulasLocal|object[][]|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.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| -|formulasR1C1|object[][]|Represents the formula in R1C1-style notation.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| -|index|int|Returns a value that represents the index of the RangeView. Read-only.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| -|numberFormat|object[][]|Represents Excel's number format code for the given cell.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| -|rowCount|int|Returns the number of visible rows. Read-only.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| -|text|object[][]|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. Read-only.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| -|valueTypes|string|Represents the type of data of each cell. Read-only. Possible values are: Unknown, Empty, String, Integer, Double, Boolean, Error.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| -|values|object[][]|Represents the raw values of the specified range view. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|rows|[RangeViewCollection](rangeviewcollection.md)|Represents a collection of range views associated with the range. Read-only.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[getRange()](#getrange)|[Range](range.md)|Gets the parent range associated with the current RangeView.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### getRange() -Gets the parent range associated with the current RangeView. - -#### Syntax -```js -rangeViewObject.getRange(); -``` - -#### Parameters -None - -#### Returns -[Range](range.md) +# RangeView Object (JavaScript API for Excel) + +RangeView represents a set of visible cells of the parent range. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|cellAddresses|object[][]|Represents the cell addresses of the RangeView. Read-only.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| +|columnCount|int|Returns the number of visible columns. Read-only.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| +|formulas|object[][]|Represents the formula in A1-style notation.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| +|formulasLocal|object[][]|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.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| +|formulasR1C1|object[][]|Represents the formula in R1C1-style notation.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| +|index|int|Returns a value that represents the index of the RangeView. Read-only.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| +|numberFormat|object[][]|Represents Excel's number format code for the given cell.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| +|rowCount|int|Returns the number of visible rows. Read-only.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| +|text|object[][]|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. Read-only.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| +|valueTypes|string|Represents the type of data of each cell. Read-only. Possible values are: Unknown, Empty, String, Integer, Double, Boolean, Error.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| +|values|object[][]|Represents the raw values of the specified range view. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|rows|[RangeViewCollection](rangeviewcollection.md)|Represents a collection of range views associated with the range. Read-only.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[getRange()](#getrange)|[Range](range.md)|Gets the parent range associated with the current RangeView.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### getRange() +Gets the parent range associated with the current RangeView. + +#### Syntax +```js +rangeViewObject.getRange(); +``` + +#### Parameters +None + +#### Returns +[Range](range.md) diff --git a/markdown/rangeviewcollection.md b/markdown/rangeviewcollection.md index 427a123..8be1176 100644 --- a/markdown/rangeviewcollection.md +++ b/markdown/rangeviewcollection.md @@ -1,55 +1,55 @@ -# RangeViewCollection Object (JavaScript API for Excel) - -Represents a collection of RangeView objects. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|items|[RangeView[]](rangeview.md)|A collection of rangeView objects. Read-only.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[getCount()](#getcount)|int|Gets the number of RangeView objects in the collection.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|[getItemAt(index: number)](#getitematindex-number)|[RangeView](rangeview.md)|Gets a RangeView Row via it's index. Zero-Indexed.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### getCount() -Gets the number of RangeView objects in the collection. - -#### Syntax -```js -rangeViewCollectionObject.getCount(); -``` - -#### Parameters -None - -#### Returns -int - -### getItemAt(index: number) -Gets a RangeView Row via it's index. Zero-Indexed. - -#### Syntax -```js -rangeViewCollectionObject.getItemAt(index); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|index|number|Index of the visible row.| - -#### Returns -[RangeView](rangeview.md) +# RangeViewCollection Object (JavaScript API for Excel) + +Represents a collection of RangeView objects. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|items|[RangeView[]](rangeview.md)|A collection of rangeView objects. Read-only.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[getCount()](#getcount)|int|Gets the number of RangeView objects in the collection.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|[getItemAt(index: number)](#getitematindex-number)|[RangeView](rangeview.md)|Gets a RangeView Row via it's index. Zero-Indexed.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### getCount() +Gets the number of RangeView objects in the collection. + +#### Syntax +```js +rangeViewCollectionObject.getCount(); +``` + +#### Parameters +None + +#### Returns +int + +### getItemAt(index: number) +Gets a RangeView Row via it's index. Zero-Indexed. + +#### Syntax +```js +rangeViewCollectionObject.getItemAt(index); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|index|number|Index of the visible row.| + +#### Returns +[RangeView](rangeview.md) diff --git a/markdown/selectionchangedeventargs.md b/markdown/selectionchangedeventargs.md index a5e1ca9..378a59c 100644 --- a/markdown/selectionchangedeventargs.md +++ b/markdown/selectionchangedeventargs.md @@ -1,16 +1,16 @@ -# SelectionChangedEventArgs Object (JavaScript API for Excel) - -Provides information about the document that raised the SelectionChanged event. - -## Properties - -None - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|workbook|[Workbook](workbook.md)|Gets the workbook object that raised the SelectionChanged event.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# SelectionChangedEventArgs Object (JavaScript API for Excel) + +Provides information about the document that raised the SelectionChanged event. + +## Properties + +None + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|workbook|[Workbook](workbook.md)|Gets the workbook object that raised the SelectionChanged event.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/setting.md b/markdown/setting.md index 8a8c929..8e659e8 100644 --- a/markdown/setting.md +++ b/markdown/setting.md @@ -1,39 +1,39 @@ -# Setting Object (JavaScript API for Excel) - -Setting represents a key-value pair of a setting persisted to the document. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|key|string|Returns the key that represents the id of the Setting. Read-only.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|value|object|Represents the value stored for this setting.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[delete()](#delete)|void|Deletes the setting.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### delete() -Deletes the setting. - -#### Syntax -```js -settingObject.delete(); -``` - -#### Parameters -None - -#### Returns -void +# Setting Object (JavaScript API for Excel) + +Setting represents a key-value pair of a setting persisted to the document. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|key|string|Returns the key that represents the id of the Setting. Read-only.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|value|object|Represents the value stored for this setting.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[delete()](#delete)|void|Deletes the setting.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### delete() +Deletes the setting. + +#### Syntax +```js +settingObject.delete(); +``` + +#### Parameters +None + +#### Returns +void diff --git a/markdown/settingcollection.md b/markdown/settingcollection.md index 9f7b364..599cec7 100644 --- a/markdown/settingcollection.md +++ b/markdown/settingcollection.md @@ -1,90 +1,90 @@ -# SettingCollection Object (JavaScript API for Excel) - -Represents a collection of worksheet objects that are part of the workbook. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|items|[Setting[]](setting.md)|A collection of setting objects. Read-only.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[add(key: string, value: (any)[])](#addkey-string-value-any)|[Setting](setting.md)|Sets or adds the specified setting to the workbook.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|[getCount()](#getcount)|int|Gets the number of Settings in the collection.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|[getItem(key: string)](#getitemkey-string)|[Setting](setting.md)|Gets a Setting entry via the key.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|[getItemOrNullObject(key: string)](#getitemornullobjectkey-string)|[Setting](setting.md)|Gets a Setting entry via the key. If the Setting does not exist, will return a null object.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### add(key: string, value: (any)[]) -Sets or adds the specified setting to the workbook. - -#### Syntax -```js -settingCollectionObject.add(key, value); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|key|string|The Key of the new setting.| -|value|(any)[]|The Value for the new setting.| - -#### Returns -[Setting](setting.md) - -### getCount() -Gets the number of Settings in the collection. - -#### Syntax -```js -settingCollectionObject.getCount(); -``` - -#### Parameters -None - -#### Returns -int - -### getItem(key: string) -Gets a Setting entry via the key. - -#### Syntax -```js -settingCollectionObject.getItem(key); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|key|string|Key of the setting.| - -#### Returns -[Setting](setting.md) - -### getItemOrNullObject(key: string) -Gets a Setting entry via the key. If the Setting does not exist, will return a null object. - -#### Syntax -```js -settingCollectionObject.getItemOrNullObject(key); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|key|string|The key of the setting.| - -#### Returns -[Setting](setting.md) +# SettingCollection Object (JavaScript API for Excel) + +Represents a collection of worksheet objects that are part of the workbook. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|items|[Setting[]](setting.md)|A collection of setting objects. Read-only.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[add(key: string, value: (any)[])](#addkey-string-value-any)|[Setting](setting.md)|Sets or adds the specified setting to the workbook.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|[getCount()](#getcount)|int|Gets the number of Settings in the collection.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|[getItem(key: string)](#getitemkey-string)|[Setting](setting.md)|Gets a Setting entry via the key.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|[getItemOrNullObject(key: string)](#getitemornullobjectkey-string)|[Setting](setting.md)|Gets a Setting entry via the key. If the Setting does not exist, will return a null object.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### add(key: string, value: (any)[]) +Sets or adds the specified setting to the workbook. + +#### Syntax +```js +settingCollectionObject.add(key, value); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|key|string|The Key of the new setting.| +|value|(any)[]|The Value for the new setting.| + +#### Returns +[Setting](setting.md) + +### getCount() +Gets the number of Settings in the collection. + +#### Syntax +```js +settingCollectionObject.getCount(); +``` + +#### Parameters +None + +#### Returns +int + +### getItem(key: string) +Gets a Setting entry via the key. + +#### Syntax +```js +settingCollectionObject.getItem(key); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|key|string|Key of the setting.| + +#### Returns +[Setting](setting.md) + +### getItemOrNullObject(key: string) +Gets a Setting entry via the key. If the Setting does not exist, will return a null object. + +#### Syntax +```js +settingCollectionObject.getItemOrNullObject(key); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|key|string|The key of the setting.| + +#### Returns +[Setting](setting.md) diff --git a/markdown/settingschangedeventargs.md b/markdown/settingschangedeventargs.md index 6fe0f44..ba1de35 100644 --- a/markdown/settingschangedeventargs.md +++ b/markdown/settingschangedeventargs.md @@ -1,16 +1,16 @@ -# SettingsChangedEventArgs Object (JavaScript API for Excel) - -Provides information about the setting that raised the SettingsChanged event - -## Properties - -None - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|settings|[SettingCollection](settingcollection.md)|Gets the Setting object that represents the binding that raised the SettingsChanged event|[1.4](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# SettingsChangedEventArgs Object (JavaScript API for Excel) + +Provides information about the setting that raised the SettingsChanged event + +## Properties + +None + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|settings|[SettingCollection](settingcollection.md)|Gets the Setting object that represents the binding that raised the SettingsChanged event|[1.4](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/sortfield.md b/markdown/sortfield.md index d576cb8..f752dd5 100644 --- a/markdown/sortfield.md +++ b/markdown/sortfield.md @@ -1,24 +1,24 @@ -# SortField Object (JavaScript API for Excel) - -Represents a condition in a sorting operation. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|ascending|bool|Represents whether the sorting is done in an ascending fashion.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|color|string|Represents the color that is the target of the condition if the sorting is on font or cell color.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|dataOption|string|Represents additional sorting options for this field. Possible values are: Normal, TextAsNumber.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|key|int|Represents the column (or row, depending on the sort orientation) that the condition is on. Represented as an offset from the first column (or row).|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|sortOn|string|Represents the type of sorting of this condition. Possible values are: Value, CellColor, FontColor, Icon.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|icon|[Icon](icon.md)|Represents the icon that is the target of the condition if the sorting is on the cell's icon.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# SortField Object (JavaScript API for Excel) + +Represents a condition in a sorting operation. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|ascending|bool|Represents whether the sorting is done in an ascending fashion.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|color|string|Represents the color that is the target of the condition if the sorting is on font or cell color.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|dataOption|string|Represents additional sorting options for this field. Possible values are: Normal, TextAsNumber.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|key|int|Represents the column (or row, depending on the sort orientation) that the condition is on. Represented as an offset from the first column (or row).|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|sortOn|string|Represents the type of sorting of this condition. Possible values are: Value, CellColor, FontColor, Icon.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|icon|[Icon](icon.md)|Represents the icon that is the target of the condition if the sorting is on the cell's icon.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/table.md b/markdown/table.md index f73f0e8..ef72bca 100644 --- a/markdown/table.md +++ b/markdown/table.md @@ -1,320 +1,320 @@ -# Table Object (JavaScript API for Excel) - -Represents an Excel table. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|highlightFirstColumn|bool|Indicates whether the first column contains special formatting.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| -|highlightLastColumn|bool|Indicates whether the last column contains special formatting.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| -|id|int|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. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|name|string|Name of the table.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|showBandedColumns|bool|Indicates whether the columns show banded formatting in which odd columns are highlighted differently from even ones to make reading the table easier.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| -|showBandedRows|bool|Indicates whether the rows show banded formatting in which odd rows are highlighted differently from even ones to make reading the table easier.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| -|showFilterButton|bool|Indicates whether the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| -|showHeaders|bool|Indicates whether the header row is visible or not. This value can be set to show or remove the header row.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|showTotals|bool|Indicates whether the total row is visible or not. This value can be set to show or remove the total row.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|style|string|Constant value that represents the Table style. Possible values are: TableStyleLight1 thru TableStyleLight21, TableStyleMedium1 thru TableStyleMedium28, TableStyleStyleDark1 thru TableStyleStyleDark11. A custom user-defined style present in the workbook can also be specified.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|columns|[TableColumnCollection](tablecolumncollection.md)|Represents a collection of all the columns in the table. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|rows|[TableRowCollection](tablerowcollection.md)|Represents a collection of all the rows in the table. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|sort|[TableSort](tablesort.md)|Represents the sorting for the table. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|worksheet|[Worksheet](worksheet.md)|The worksheet containing the current table. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[clearFilters()](#clearfilters)|void|Clears all the filters currently applied on the table.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|[convertToRange()](#converttorange)|[Range](range.md)|Converts the table into a normal range of cells. All data is preserved.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|[delete()](#delete)|void|Deletes the table.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getDataBodyRange()](#getdatabodyrange)|[Range](range.md)|Gets the range object associated with the data body of the table.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getHeaderRowRange()](#getheaderrowrange)|[Range](range.md)|Gets the range object associated with header row of the table.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getRange()](#getrange)|[Range](range.md)|Gets the range object associated with the entire table.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getTotalRowRange()](#gettotalrowrange)|[Range](range.md)|Gets the range object associated with totals row of the table.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[reapplyFilters()](#reapplyfilters)|void|Reapplies all the filters currently on the table.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### clearFilters() -Clears all the filters currently applied on the table. - -#### Syntax -```js -tableObject.clearFilters(); -``` - -#### Parameters -None - -#### Returns -void - -### convertToRange() -Converts the table into a normal range of cells. All data is preserved. - -#### Syntax -```js -tableObject.convertToRange(); -``` - -#### Parameters -None - -#### Returns -[Range](range.md) - -#### Examples -```js -Excel.run(function (ctx) { - var tableName = 'Table1'; - var table = ctx.workbook.tables.getItem(tableName); - table.convertToRange(); - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -### delete() -Deletes the table. - -#### Syntax -```js -tableObject.delete(); -``` - -#### Parameters -None - -#### Returns -void - -#### Examples -```js -Excel.run(function (ctx) { - var tableName = 'Table1'; - var table = ctx.workbook.tables.getItem(tableName); - table.delete(); - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getDataBodyRange() -Gets the range object associated with the data body of the table. - -#### Syntax -```js -tableObject.getDataBodyRange(); -``` - -#### Parameters -None - -#### Returns -[Range](range.md) - -#### Examples -```js -Excel.run(function (ctx) { - var tableName = 'Table1'; - var table = ctx.workbook.tables.getItem(tableName); - var tableDataRange = table.getDataBodyRange(); - tableDataRange.load('address') - return ctx.sync().then(function() { - console.log(tableDataRange.address); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -### getHeaderRowRange() -Gets the range object associated with header row of the table. - -#### Syntax -```js -tableObject.getHeaderRowRange(); -``` - -#### Parameters -None - -#### Returns -[Range](range.md) - -#### Examples -```js -Excel.run(function (ctx) { - var tableName = 'Table1'; - var table = ctx.workbook.tables.getItem(tableName); - var tableHeaderRange = table.getHeaderRowRange(); - tableHeaderRange.load('address'); - return ctx.sync().then(function() { - console.log(tableHeaderRange.address); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getRange() -Gets the range object associated with the entire table. - -#### Syntax -```js -tableObject.getRange(); -``` - -#### Parameters -None - -#### Returns -[Range](range.md) - -#### Examples -```js -Excel.run(function (ctx) { - var tableName = 'Table1'; - var table = ctx.workbook.tables.getItem(tableName); - var tableRange = table.getRange(); - tableRange.load('address'); - return ctx.sync().then(function() { - console.log(tableRange.address); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getTotalRowRange() -Gets the range object associated with totals row of the table. - -#### Syntax -```js -tableObject.getTotalRowRange(); -``` - -#### Parameters -None - -#### Returns -[Range](range.md) - -#### Examples -```js -Excel.run(function (ctx) { - var tableName = 'Table1'; - var table = ctx.workbook.tables.getItem(tableName); - var tableTotalsRange = table.getTotalRowRange(); - tableTotalsRange.load('address'); - return ctx.sync().then(function() { - console.log(tableTotalsRange.address); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### reapplyFilters() -Reapplies all the filters currently on the table. - -#### Syntax -```js -tableObject.reapplyFilters(); -``` - -#### Parameters -None - -#### Returns -void -### Property access examples - -Get a table by name. - -```js -Excel.run(function (ctx) { - var tableName = 'Table1'; - var table = ctx.workbook.tables.getItem(tableName); - table.load('index') - return ctx.sync().then(function() { - console.log(table.index); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -Get a table by index. - -```js -Excel.run(function (ctx) { - var index = 0; - var table = ctx.workbook.tables.getItemAt(0); - table.load('id') - return ctx.sync().then(function() { - console.log(table.id); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -Set table style. - -```js -Excel.run(function (ctx) { - var tableName = 'Table1'; - var table = ctx.workbook.tables.getItem(tableName); - table.name = 'Table1-Renamed'; - table.showTotals = false; - table.style = 'TableStyleMedium2'; - table.load('tableStyle'); - return ctx.sync().then(function() { - console.log(table.style); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` +# Table Object (JavaScript API for Excel) + +Represents an Excel table. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|highlightFirstColumn|bool|Indicates whether the first column contains special formatting.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| +|highlightLastColumn|bool|Indicates whether the last column contains special formatting.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| +|id|int|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. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|name|string|Name of the table.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|showBandedColumns|bool|Indicates whether the columns show banded formatting in which odd columns are highlighted differently from even ones to make reading the table easier.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| +|showBandedRows|bool|Indicates whether the rows show banded formatting in which odd rows are highlighted differently from even ones to make reading the table easier.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| +|showFilterButton|bool|Indicates whether the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| +|showHeaders|bool|Indicates whether the header row is visible or not. This value can be set to show or remove the header row.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|showTotals|bool|Indicates whether the total row is visible or not. This value can be set to show or remove the total row.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|style|string|Constant value that represents the Table style. Possible values are: TableStyleLight1 thru TableStyleLight21, TableStyleMedium1 thru TableStyleMedium28, TableStyleStyleDark1 thru TableStyleStyleDark11. A custom user-defined style present in the workbook can also be specified.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|columns|[TableColumnCollection](tablecolumncollection.md)|Represents a collection of all the columns in the table. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|rows|[TableRowCollection](tablerowcollection.md)|Represents a collection of all the rows in the table. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|sort|[TableSort](tablesort.md)|Represents the sorting for the table. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|worksheet|[Worksheet](worksheet.md)|The worksheet containing the current table. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[clearFilters()](#clearfilters)|void|Clears all the filters currently applied on the table.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|[convertToRange()](#converttorange)|[Range](range.md)|Converts the table into a normal range of cells. All data is preserved.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|[delete()](#delete)|void|Deletes the table.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getDataBodyRange()](#getdatabodyrange)|[Range](range.md)|Gets the range object associated with the data body of the table.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getHeaderRowRange()](#getheaderrowrange)|[Range](range.md)|Gets the range object associated with header row of the table.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getRange()](#getrange)|[Range](range.md)|Gets the range object associated with the entire table.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getTotalRowRange()](#gettotalrowrange)|[Range](range.md)|Gets the range object associated with totals row of the table.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[reapplyFilters()](#reapplyfilters)|void|Reapplies all the filters currently on the table.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### clearFilters() +Clears all the filters currently applied on the table. + +#### Syntax +```js +tableObject.clearFilters(); +``` + +#### Parameters +None + +#### Returns +void + +### convertToRange() +Converts the table into a normal range of cells. All data is preserved. + +#### Syntax +```js +tableObject.convertToRange(); +``` + +#### Parameters +None + +#### Returns +[Range](range.md) + +#### Examples +```js +Excel.run(function (ctx) { + var tableName = 'Table1'; + var table = ctx.workbook.tables.getItem(tableName); + table.convertToRange(); + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +### delete() +Deletes the table. + +#### Syntax +```js +tableObject.delete(); +``` + +#### Parameters +None + +#### Returns +void + +#### Examples +```js +Excel.run(function (ctx) { + var tableName = 'Table1'; + var table = ctx.workbook.tables.getItem(tableName); + table.delete(); + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getDataBodyRange() +Gets the range object associated with the data body of the table. + +#### Syntax +```js +tableObject.getDataBodyRange(); +``` + +#### Parameters +None + +#### Returns +[Range](range.md) + +#### Examples +```js +Excel.run(function (ctx) { + var tableName = 'Table1'; + var table = ctx.workbook.tables.getItem(tableName); + var tableDataRange = table.getDataBodyRange(); + tableDataRange.load('address') + return ctx.sync().then(function() { + console.log(tableDataRange.address); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +### getHeaderRowRange() +Gets the range object associated with header row of the table. + +#### Syntax +```js +tableObject.getHeaderRowRange(); +``` + +#### Parameters +None + +#### Returns +[Range](range.md) + +#### Examples +```js +Excel.run(function (ctx) { + var tableName = 'Table1'; + var table = ctx.workbook.tables.getItem(tableName); + var tableHeaderRange = table.getHeaderRowRange(); + tableHeaderRange.load('address'); + return ctx.sync().then(function() { + console.log(tableHeaderRange.address); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getRange() +Gets the range object associated with the entire table. + +#### Syntax +```js +tableObject.getRange(); +``` + +#### Parameters +None + +#### Returns +[Range](range.md) + +#### Examples +```js +Excel.run(function (ctx) { + var tableName = 'Table1'; + var table = ctx.workbook.tables.getItem(tableName); + var tableRange = table.getRange(); + tableRange.load('address'); + return ctx.sync().then(function() { + console.log(tableRange.address); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getTotalRowRange() +Gets the range object associated with totals row of the table. + +#### Syntax +```js +tableObject.getTotalRowRange(); +``` + +#### Parameters +None + +#### Returns +[Range](range.md) + +#### Examples +```js +Excel.run(function (ctx) { + var tableName = 'Table1'; + var table = ctx.workbook.tables.getItem(tableName); + var tableTotalsRange = table.getTotalRowRange(); + tableTotalsRange.load('address'); + return ctx.sync().then(function() { + console.log(tableTotalsRange.address); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### reapplyFilters() +Reapplies all the filters currently on the table. + +#### Syntax +```js +tableObject.reapplyFilters(); +``` + +#### Parameters +None + +#### Returns +void +### Property access examples + +Get a table by name. + +```js +Excel.run(function (ctx) { + var tableName = 'Table1'; + var table = ctx.workbook.tables.getItem(tableName); + table.load('index') + return ctx.sync().then(function() { + console.log(table.index); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +Get a table by index. + +```js +Excel.run(function (ctx) { + var index = 0; + var table = ctx.workbook.tables.getItemAt(0); + table.load('id') + return ctx.sync().then(function() { + console.log(table.id); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +Set table style. + +```js +Excel.run(function (ctx) { + var tableName = 'Table1'; + var table = ctx.workbook.tables.getItem(tableName); + table.name = 'Table1-Renamed'; + table.showTotals = false; + table.style = 'TableStyleMedium2'; + table.load('tableStyle'); + return ctx.sync().then(function() { + console.log(table.style); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` diff --git a/markdown/tablecollection.md b/markdown/tablecollection.md index 80df05e..8209645 100644 --- a/markdown/tablecollection.md +++ b/markdown/tablecollection.md @@ -1,217 +1,217 @@ -# TableCollection Object (JavaScript API for Excel) - -Represents a collection of all the tables that are part of the workbook or worksheet, depending on how it was reached. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|count|int|Returns the number of tables in the workbook. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|items|[Table[]](table.md)|A collection of table objects. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[add(address: object, hasHeaders: bool)](#addaddress-object-hasheaders-bool)|[Table](table.md)|Create 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.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getCount()](#getcount)|int|Gets the number of tables in the collection.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|[getItem(key: number or string)](#getitemkey-number-or-string)|[Table](table.md)|Gets a table by Name or ID.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getItemAt(index: number)](#getitematindex-number)|[Table](table.md)|Gets a table based on its position in the collection.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getItemOrNullObject(key: number or string)](#getitemornullobjectkey-number-or-string)|[Table](table.md)|Gets a table by Name or ID. If the table does not exist, will return a null object.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### add(address: object, hasHeaders: bool) -Create 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. - -#### Syntax -```js -tableCollectionObject.add(address, hasHeaders); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|address|object|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.| -|hasHeaders|bool|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 header shifting the data down by one row.| - -#### Returns -[Table](table.md) - -#### Examples - -```js -Excel.run(function (ctx) { - var table = ctx.workbook.tables.add('Sheet1!A1:E7', true); - table.load('name'); - return ctx.sync().then(function() { - console.log(table.name); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -### getCount() -Gets the number of tables in the collection. - -#### Syntax -```js -tableCollectionObject.getCount(); -``` - -#### Parameters -None - -#### Returns -int - -### getItem(key: number or string) -Gets a table by Name or ID. - -#### Syntax -```js -tableCollectionObject.getItem(key); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|key|number or string|Name or ID of the table to be retrieved.| - -#### Returns -[Table](table.md) - -#### Examples - -```js -Excel.run(function (ctx) { - var tableName = 'Table1'; - var table = ctx.workbook.tables.getItem(tableName); - table.load('name'); - return ctx.sync().then(function() { - console.log(table.name); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -#### Examples - -```js -Excel.run(function (ctx) { - var table = ctx.workbook.tables.getItemAt(0); - table.load('name'); - return ctx.sync().then(function() { - console.log(table.name); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getItemAt(index: number) -Gets a table based on its position in the collection. - -#### Syntax -```js -tableCollectionObject.getItemAt(index); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|index|number|Index value of the object to be retrieved. Zero-indexed.| - -#### Returns -[Table](table.md) - -#### Examples - -```js -Excel.run(function (ctx) { - var table = ctx.workbook.tables.getItemAt(0); - table.load('name'); - return ctx.sync().then(function() { - console.log(table.name); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getItemOrNullObject(key: number or string) -Gets a table by Name or ID. If the table does not exist, will return a null object. - -#### Syntax -```js -tableCollectionObject.getItemOrNullObject(key); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|key|number or string|Name or ID of the table to be retrieved.| - -#### Returns -[Table](table.md) -### Property access examples - -```js -Excel.run(function (ctx) { - var tables = ctx.workbook.tables; - tables.load(); - return ctx.sync().then(function() { - console.log("tables Count: " + tables.count); - for (var i = 0; i < tables.items.length; i++) - { - console.log(tables.items[i].name); - } - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -Get the number of tables - -```js -Excel.run(function (ctx) { - var tables = ctx.workbook.tables; - tables.load('count'); - return ctx.sync().then(function() { - console.log(tables.count); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); +# TableCollection Object (JavaScript API for Excel) + +Represents a collection of all the tables that are part of the workbook or worksheet, depending on how it was reached. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|count|int|Returns the number of tables in the workbook. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|items|[Table[]](table.md)|A collection of table objects. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[add(address: object, hasHeaders: bool)](#addaddress-object-hasheaders-bool)|[Table](table.md)|Create 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.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getCount()](#getcount)|int|Gets the number of tables in the collection.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|[getItem(key: number or string)](#getitemkey-number-or-string)|[Table](table.md)|Gets a table by Name or ID.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getItemAt(index: number)](#getitematindex-number)|[Table](table.md)|Gets a table based on its position in the collection.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getItemOrNullObject(key: number or string)](#getitemornullobjectkey-number-or-string)|[Table](table.md)|Gets a table by Name or ID. If the table does not exist, will return a null object.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### add(address: object, hasHeaders: bool) +Create 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. + +#### Syntax +```js +tableCollectionObject.add(address, hasHeaders); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|address|object|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.| +|hasHeaders|bool|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 header shifting the data down by one row.| + +#### Returns +[Table](table.md) + +#### Examples + +```js +Excel.run(function (ctx) { + var table = ctx.workbook.tables.add('Sheet1!A1:E7', true); + table.load('name'); + return ctx.sync().then(function() { + console.log(table.name); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +### getCount() +Gets the number of tables in the collection. + +#### Syntax +```js +tableCollectionObject.getCount(); +``` + +#### Parameters +None + +#### Returns +int + +### getItem(key: number or string) +Gets a table by Name or ID. + +#### Syntax +```js +tableCollectionObject.getItem(key); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|key|number or string|Name or ID of the table to be retrieved.| + +#### Returns +[Table](table.md) + +#### Examples + +```js +Excel.run(function (ctx) { + var tableName = 'Table1'; + var table = ctx.workbook.tables.getItem(tableName); + table.load('name'); + return ctx.sync().then(function() { + console.log(table.name); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +#### Examples + +```js +Excel.run(function (ctx) { + var table = ctx.workbook.tables.getItemAt(0); + table.load('name'); + return ctx.sync().then(function() { + console.log(table.name); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getItemAt(index: number) +Gets a table based on its position in the collection. + +#### Syntax +```js +tableCollectionObject.getItemAt(index); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|index|number|Index value of the object to be retrieved. Zero-indexed.| + +#### Returns +[Table](table.md) + +#### Examples + +```js +Excel.run(function (ctx) { + var table = ctx.workbook.tables.getItemAt(0); + table.load('name'); + return ctx.sync().then(function() { + console.log(table.name); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getItemOrNullObject(key: number or string) +Gets a table by Name or ID. If the table does not exist, will return a null object. + +#### Syntax +```js +tableCollectionObject.getItemOrNullObject(key); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|key|number or string|Name or ID of the table to be retrieved.| + +#### Returns +[Table](table.md) +### Property access examples + +```js +Excel.run(function (ctx) { + var tables = ctx.workbook.tables; + tables.load(); + return ctx.sync().then(function() { + console.log("tables Count: " + tables.count); + for (var i = 0; i < tables.items.length; i++) + { + console.log(tables.items[i].name); + } + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +Get the number of tables + +```js +Excel.run(function (ctx) { + var tables = ctx.workbook.tables; + tables.load('count'); + return ctx.sync().then(function() { + console.log(tables.count); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); ``` \ No newline at end of file diff --git a/markdown/tablecolumn.md b/markdown/tablecolumn.md index ad815e6..81b261c 100644 --- a/markdown/tablecolumn.md +++ b/markdown/tablecolumn.md @@ -1,233 +1,233 @@ -# TableColumn Object (JavaScript API for Excel) - -Represents a column in a table. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|id|int|Returns a unique key that identifies the column within the table. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|index|int|Returns the index number of the column within the columns collection of the table. Zero-indexed. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|name|string|Represents the name of the table column.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|values|object[][]|Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|filter|[Filter](filter.md)|Retrieve the filter applied to the column. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[delete()](#delete)|void|Deletes the column from the table.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getDataBodyRange()](#getdatabodyrange)|[Range](range.md)|Gets the range object associated with the data body of the column.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getHeaderRowRange()](#getheaderrowrange)|[Range](range.md)|Gets the range object associated with the header row of the column.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getRange()](#getrange)|[Range](range.md)|Gets the range object associated with the entire column.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getTotalRowRange()](#gettotalrowrange)|[Range](range.md)|Gets the range object associated with the totals row of the column.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### delete() -Deletes the column from the table. - -#### Syntax -```js -tableColumnObject.delete(); -``` - -#### Parameters -None - -#### Returns -void - -#### Examples - -```js -Excel.run(function (ctx) { - var tableName = 'Table1'; - var column = ctx.workbook.tables.getItem(tableName).columns.getItemAt(2); - column.delete(); - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getDataBodyRange() -Gets the range object associated with the data body of the column. - -#### Syntax -```js -tableColumnObject.getDataBodyRange(); -``` - -#### Parameters -None - -#### Returns -[Range](range.md) - -#### Examples - -```js -Excel.run(function (ctx) { - var tableName = 'Table1'; - var column = ctx.workbook.tables.getItem(tableName).columns.getItemAt(0); - var dataBodyRange = column.getDataBodyRange(); - dataBodyRange.load('address'); - return ctx.sync().then(function() { - console.log(dataBodyRange.address); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getHeaderRowRange() -Gets the range object associated with the header row of the column. - -#### Syntax -```js -tableColumnObject.getHeaderRowRange(); -``` - -#### Parameters -None - -#### Returns -[Range](range.md) - -#### Examples - -```js -Excel.run(function (ctx) { - var tableName = 'Table1'; - var columns = ctx.workbook.tables.getItem(tableName).columns.getItemAt(0); - var headerRowRange = columns.getHeaderRowRange(); - headerRowRange.load('address'); - return ctx.sync().then(function() { - console.log(headerRowRange.address); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -### getRange() -Gets the range object associated with the entire column. - -#### Syntax -```js -tableColumnObject.getRange(); -``` - -#### Parameters -None - -#### Returns -[Range](range.md) - -#### Examples - -```js -Excel.run(function (ctx) { - var tableName = 'Table1'; - var columns = ctx.workbook.tables.getItem(tableName).columns.getItemAt(0); - var columnRange = columns.getRange(); - columnRange.load('address'); - return ctx.sync().then(function() { - console.log(columnRange.address); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getTotalRowRange() -Gets the range object associated with the totals row of the column. - -#### Syntax -```js -tableColumnObject.getTotalRowRange(); -``` - -#### Parameters -None - -#### Returns -[Range](range.md) - -#### Examples - -```js -Excel.run(function (ctx) { - var tableName = 'Table1'; - var columns = ctx.workbook.tables.getItem(tableName).columns.getItemAt(0); - var totalRowRange = columns.getTotalRowRange(); - totalRowRange.load('address'); - return ctx.sync().then(function() { - console.log(totalRowRange.address); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -### Property access examples - -```js -Excel.run(function (ctx) { - var tableName = 'Table1'; - var column = ctx.workbook.tables.getItem(tableName).columns.getItem(0); - column.load('index'); - return ctx.sync().then(function() { - console.log(column.index); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -```js -Excel.run(function (ctx) { - var tableName = 'Table1'; - var tables = ctx.workbook.tables; - var newValues = [["New"], ["Values"], ["For"], ["New"], ["Column"]]; - var column = ctx.workbook.tables.getItem(tableName).columns.getItemAt(2); - column.values = newValues; - column.load('values'); - return ctx.sync().then(function() { - console.log(column.values); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); +# TableColumn Object (JavaScript API for Excel) + +Represents a column in a table. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|id|int|Returns a unique key that identifies the column within the table. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|index|int|Returns the index number of the column within the columns collection of the table. Zero-indexed. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|name|string|Represents the name of the table column.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|values|object[][]|Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|filter|[Filter](filter.md)|Retrieve the filter applied to the column. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[delete()](#delete)|void|Deletes the column from the table.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getDataBodyRange()](#getdatabodyrange)|[Range](range.md)|Gets the range object associated with the data body of the column.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getHeaderRowRange()](#getheaderrowrange)|[Range](range.md)|Gets the range object associated with the header row of the column.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getRange()](#getrange)|[Range](range.md)|Gets the range object associated with the entire column.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getTotalRowRange()](#gettotalrowrange)|[Range](range.md)|Gets the range object associated with the totals row of the column.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### delete() +Deletes the column from the table. + +#### Syntax +```js +tableColumnObject.delete(); +``` + +#### Parameters +None + +#### Returns +void + +#### Examples + +```js +Excel.run(function (ctx) { + var tableName = 'Table1'; + var column = ctx.workbook.tables.getItem(tableName).columns.getItemAt(2); + column.delete(); + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getDataBodyRange() +Gets the range object associated with the data body of the column. + +#### Syntax +```js +tableColumnObject.getDataBodyRange(); +``` + +#### Parameters +None + +#### Returns +[Range](range.md) + +#### Examples + +```js +Excel.run(function (ctx) { + var tableName = 'Table1'; + var column = ctx.workbook.tables.getItem(tableName).columns.getItemAt(0); + var dataBodyRange = column.getDataBodyRange(); + dataBodyRange.load('address'); + return ctx.sync().then(function() { + console.log(dataBodyRange.address); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getHeaderRowRange() +Gets the range object associated with the header row of the column. + +#### Syntax +```js +tableColumnObject.getHeaderRowRange(); +``` + +#### Parameters +None + +#### Returns +[Range](range.md) + +#### Examples + +```js +Excel.run(function (ctx) { + var tableName = 'Table1'; + var columns = ctx.workbook.tables.getItem(tableName).columns.getItemAt(0); + var headerRowRange = columns.getHeaderRowRange(); + headerRowRange.load('address'); + return ctx.sync().then(function() { + console.log(headerRowRange.address); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +### getRange() +Gets the range object associated with the entire column. + +#### Syntax +```js +tableColumnObject.getRange(); +``` + +#### Parameters +None + +#### Returns +[Range](range.md) + +#### Examples + +```js +Excel.run(function (ctx) { + var tableName = 'Table1'; + var columns = ctx.workbook.tables.getItem(tableName).columns.getItemAt(0); + var columnRange = columns.getRange(); + columnRange.load('address'); + return ctx.sync().then(function() { + console.log(columnRange.address); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getTotalRowRange() +Gets the range object associated with the totals row of the column. + +#### Syntax +```js +tableColumnObject.getTotalRowRange(); +``` + +#### Parameters +None + +#### Returns +[Range](range.md) + +#### Examples + +```js +Excel.run(function (ctx) { + var tableName = 'Table1'; + var columns = ctx.workbook.tables.getItem(tableName).columns.getItemAt(0); + var totalRowRange = columns.getTotalRowRange(); + totalRowRange.load('address'); + return ctx.sync().then(function() { + console.log(totalRowRange.address); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +### Property access examples + +```js +Excel.run(function (ctx) { + var tableName = 'Table1'; + var column = ctx.workbook.tables.getItem(tableName).columns.getItem(0); + column.load('index'); + return ctx.sync().then(function() { + console.log(column.index); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +```js +Excel.run(function (ctx) { + var tableName = 'Table1'; + var tables = ctx.workbook.tables; + var newValues = [["New"], ["Values"], ["For"], ["New"], ["Column"]]; + var column = ctx.workbook.tables.getItem(tableName).columns.getItemAt(2); + column.values = newValues; + column.load('values'); + return ctx.sync().then(function() { + console.log(column.values); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); ``` \ No newline at end of file diff --git a/markdown/tablecolumncollection.md b/markdown/tablecolumncollection.md index d97d051..8056632 100644 --- a/markdown/tablecolumncollection.md +++ b/markdown/tablecolumncollection.md @@ -1,199 +1,199 @@ -# TableColumnCollection Object (JavaScript API for Excel) - -Represents a collection of all the columns that are part of the table. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|count|int|Returns the number of columns in the table. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|items|[TableColumn[]](tablecolumn.md)|A collection of tableColumn objects. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[add(index: number, values: object, name: string)](#addindex-number-values-object-name-string)|[TableColumn](tablecolumn.md)|Adds a new column to the table.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getCount()](#getcount)|int|Gets the number of columns in the table.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|[getItem(key: object)](#getitemkey-object)|[TableColumn](tablecolumn.md)|Gets a column object by Name or ID.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getItemAt(index: number)](#getitematindex-number)|[TableColumn](tablecolumn.md)|Gets a column based on its position in the collection.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getItemOrNullObject(key: object)](#getitemornullobjectkey-object)|[TableColumn](tablecolumn.md)|Gets a column object by Name or ID. If the column does not exist, will return a null object.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### add(index: number, values: object, name: string) -Adds a new column to the table. - -#### Syntax -```js -tableColumnCollectionObject.add(index, values, name); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|index|number|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.| -|values|object|Optional. A 2-dimensional array of unformatted values of the table column.| -|name|string|Optional. Specifies the name of the new column. If null, the default name will be used.| - -#### Returns -[TableColumn](tablecolumn.md) - -#### Examples - -```js -Excel.run(function (ctx) { - var tables = ctx.workbook.tables; - var values = [["Sample"], ["Values"], ["For"], ["New"], ["Column"]]; - var column = tables.getItem("Table1").columns.add(null, values); - column.load('name'); - return ctx.sync().then(function() { - console.log(column.name); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getCount() -Gets the number of columns in the table. - -#### Syntax -```js -tableColumnCollectionObject.getCount(); -``` - -#### Parameters -None - -#### Returns -int - -### getItem(key: object) -Gets a column object by Name or ID. - -#### Syntax -```js -tableColumnCollectionObject.getItem(key); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|key|object| Column Name or ID.| - -#### Returns -[TableColumn](tablecolumn.md) - -#### Examples - -```js -Excel.run(function (ctx) { - var tablecolumn = ctx.workbook.tables.getItem('Table1').columns.getItem(0); - tablecolumn.load('name'); - return ctx.sync().then(function() { - console.log(tablecolumn.name); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -#### Examples -```js -Excel.run(function (ctx) { - var tablecolumn = ctx.workbook.tables.getItem['Table1'].columns.getItemAt(0); - tablecolumn.load('name'); - return ctx.sync().then(function() { - console.log(tablecolumn.name); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -### getItemAt(index: number) -Gets a column based on its position in the collection. - -#### Syntax -```js -tableColumnCollectionObject.getItemAt(index); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|index|number|Index value of the object to be retrieved. Zero-indexed.| - -#### Returns -[TableColumn](tablecolumn.md) - -#### Examples -```js -Excel.run(function (ctx) { - var tablecolumn = ctx.workbook.tables.getItem['Table1'].columns.getItemAt(0); - tablecolumn.load('name'); - return ctx.sync().then(function() { - console.log(tablecolumn.name); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -### getItemOrNullObject(key: object) -Gets a column object by Name or ID. If the column does not exist, will return a null object. - -#### Syntax -```js -tableColumnCollectionObject.getItemOrNullObject(key); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|key|object| Column Name or ID.| - -#### Returns -[TableColumn](tablecolumn.md) -### Property access examples - -```js -Excel.run(function (ctx) { - var tablecolumns = ctx.workbook.tables.getItem('Table1').columns; - tablecolumns.load('items'); - return ctx.sync().then(function() { - console.log("tablecolumns Count: " + tablecolumns.count); - for (var i = 0; i < tablecolumns.items.length; i++) - { - console.log(tablecolumns.items[i].name); - } - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); +# TableColumnCollection Object (JavaScript API for Excel) + +Represents a collection of all the columns that are part of the table. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|count|int|Returns the number of columns in the table. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|items|[TableColumn[]](tablecolumn.md)|A collection of tableColumn objects. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[add(index: number, values: object, name: string)](#addindex-number-values-object-name-string)|[TableColumn](tablecolumn.md)|Adds a new column to the table.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getCount()](#getcount)|int|Gets the number of columns in the table.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|[getItem(key: object)](#getitemkey-object)|[TableColumn](tablecolumn.md)|Gets a column object by Name or ID.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getItemAt(index: number)](#getitematindex-number)|[TableColumn](tablecolumn.md)|Gets a column based on its position in the collection.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getItemOrNullObject(key: object)](#getitemornullobjectkey-object)|[TableColumn](tablecolumn.md)|Gets a column object by Name or ID. If the column does not exist, will return a null object.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### add(index: number, values: object, name: string) +Adds a new column to the table. + +#### Syntax +```js +tableColumnCollectionObject.add(index, values, name); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|index|number|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.| +|values|object|Optional. A 2-dimensional array of unformatted values of the table column.| +|name|string|Optional. Specifies the name of the new column. If null, the default name will be used.| + +#### Returns +[TableColumn](tablecolumn.md) + +#### Examples + +```js +Excel.run(function (ctx) { + var tables = ctx.workbook.tables; + var values = [["Sample"], ["Values"], ["For"], ["New"], ["Column"]]; + var column = tables.getItem("Table1").columns.add(null, values); + column.load('name'); + return ctx.sync().then(function() { + console.log(column.name); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getCount() +Gets the number of columns in the table. + +#### Syntax +```js +tableColumnCollectionObject.getCount(); +``` + +#### Parameters +None + +#### Returns +int + +### getItem(key: object) +Gets a column object by Name or ID. + +#### Syntax +```js +tableColumnCollectionObject.getItem(key); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|key|object| Column Name or ID.| + +#### Returns +[TableColumn](tablecolumn.md) + +#### Examples + +```js +Excel.run(function (ctx) { + var tablecolumn = ctx.workbook.tables.getItem('Table1').columns.getItem(0); + tablecolumn.load('name'); + return ctx.sync().then(function() { + console.log(tablecolumn.name); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +#### Examples +```js +Excel.run(function (ctx) { + var tablecolumn = ctx.workbook.tables.getItem['Table1'].columns.getItemAt(0); + tablecolumn.load('name'); + return ctx.sync().then(function() { + console.log(tablecolumn.name); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +### getItemAt(index: number) +Gets a column based on its position in the collection. + +#### Syntax +```js +tableColumnCollectionObject.getItemAt(index); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|index|number|Index value of the object to be retrieved. Zero-indexed.| + +#### Returns +[TableColumn](tablecolumn.md) + +#### Examples +```js +Excel.run(function (ctx) { + var tablecolumn = ctx.workbook.tables.getItem['Table1'].columns.getItemAt(0); + tablecolumn.load('name'); + return ctx.sync().then(function() { + console.log(tablecolumn.name); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +### getItemOrNullObject(key: object) +Gets a column object by Name or ID. If the column does not exist, will return a null object. + +#### Syntax +```js +tableColumnCollectionObject.getItemOrNullObject(key); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|key|object| Column Name or ID.| + +#### Returns +[TableColumn](tablecolumn.md) +### Property access examples + +```js +Excel.run(function (ctx) { + var tablecolumns = ctx.workbook.tables.getItem('Table1').columns; + tablecolumns.load('items'); + return ctx.sync().then(function() { + console.log("tablecolumns Count: " + tablecolumns.count); + for (var i = 0; i < tablecolumns.items.length; i++) + { + console.log(tablecolumns.items[i].name); + } + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); ``` \ No newline at end of file diff --git a/markdown/tablerow.md b/markdown/tablerow.md index e8093b0..dde84e7 100644 --- a/markdown/tablerow.md +++ b/markdown/tablerow.md @@ -1,127 +1,127 @@ -# TableRow Object (JavaScript API for Excel) - -Represents a row in a table. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|index|int|Returns the index number of the row within the rows collection of the table. Zero-indexed. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|values|object[][]|Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[delete()](#delete)|void|Deletes the row from the table.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getRange()](#getrange)|[Range](range.md)|Returns the range object associated with the entire row.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### delete() -Deletes the row from the table. - -#### Syntax -```js -tableRowObject.delete(); -``` - -#### Parameters -None - -#### Returns -void - -#### Examples - -```js -Excel.run(function (ctx) { - var tableName = 'Table1'; - var row = ctx.workbook.tables.getItem(tableName).rows.getItemAt(2); - row.delete(); - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getRange() -Returns the range object associated with the entire row. - -#### Syntax -```js -tableRowObject.getRange(); -``` - -#### Parameters -None - -#### Returns -[Range](range.md) - -#### Examples - -```js -Excel.run(function (ctx) { - var tableName = 'Table1'; - var row = ctx.workbook.tables.getItem(tableName).rows.getItemAt(0); - var rowRange = row.getRange(); - rowRange.load('address'); - return ctx.sync().then(function() { - console.log(rowRange.address); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -### Property access examples - -```js -Excel.run(function (ctx) { - var tableName = 'Table1'; - var row = ctx.workbook.tables.getItem(tableName).rows.getItem(0); - row.load('index'); - return ctx.sync().then(function() { - console.log(row.index); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -```js -Excel.run(function (ctx) { - var tables = ctx.workbook.tables; - var newValues = [["New", "Values", "For", "New", "Row"]]; - var tableName = 'Table1'; - var row = ctx.workbook.tables.getItem(tableName).rows.getItemAt(2); - row.values = newValues; - row.load('values'); - return ctx.sync().then(function() { - console.log(row.values); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); +# TableRow Object (JavaScript API for Excel) + +Represents a row in a table. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|index|int|Returns the index number of the row within the rows collection of the table. Zero-indexed. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|values|object[][]|Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[delete()](#delete)|void|Deletes the row from the table.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getRange()](#getrange)|[Range](range.md)|Returns the range object associated with the entire row.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### delete() +Deletes the row from the table. + +#### Syntax +```js +tableRowObject.delete(); +``` + +#### Parameters +None + +#### Returns +void + +#### Examples + +```js +Excel.run(function (ctx) { + var tableName = 'Table1'; + var row = ctx.workbook.tables.getItem(tableName).rows.getItemAt(2); + row.delete(); + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getRange() +Returns the range object associated with the entire row. + +#### Syntax +```js +tableRowObject.getRange(); +``` + +#### Parameters +None + +#### Returns +[Range](range.md) + +#### Examples + +```js +Excel.run(function (ctx) { + var tableName = 'Table1'; + var row = ctx.workbook.tables.getItem(tableName).rows.getItemAt(0); + var rowRange = row.getRange(); + rowRange.load('address'); + return ctx.sync().then(function() { + console.log(rowRange.address); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +### Property access examples + +```js +Excel.run(function (ctx) { + var tableName = 'Table1'; + var row = ctx.workbook.tables.getItem(tableName).rows.getItem(0); + row.load('index'); + return ctx.sync().then(function() { + console.log(row.index); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +```js +Excel.run(function (ctx) { + var tables = ctx.workbook.tables; + var newValues = [["New", "Values", "For", "New", "Row"]]; + var tableName = 'Table1'; + var row = ctx.workbook.tables.getItem(tableName).rows.getItemAt(2); + row.values = newValues; + row.load('values'); + return ctx.sync().then(function() { + console.log(row.values); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); ``` \ No newline at end of file diff --git a/markdown/tablerowcollection.md b/markdown/tablerowcollection.md index 87cbb10..046558c 100644 --- a/markdown/tablerowcollection.md +++ b/markdown/tablerowcollection.md @@ -1,130 +1,130 @@ -# TableRowCollection Object (JavaScript API for Excel) - -Represents a collection of all the rows that are part of the table. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|count|int|Returns the number of rows in the table. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|items|[TableRow[]](tablerow.md)|A collection of tableRow objects. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[add(index: number, values: object)](#addindex-number-values-object)|[TableRow](tablerow.md)|Adds one or more rows to the table. The return object will be the top of the newly added row(s).|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getCount()](#getcount)|int|Gets the number of rows in the table.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|[getItemAt(index: number)](#getitematindex-number)|[TableRow](tablerow.md)|Gets a row based on its position in the collection.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### add(index: number, values: object) -Adds one or more rows to the table. The return object will be the top of the newly added row(s). - -#### Syntax -```js -tableRowCollectionObject.add(index, values); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|index|number|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.| -|values|object|Optional. A 2-dimensional array of unformatted values of the table row.| - -#### Returns -[TableRow](tablerow.md) - -#### Examples - -```js -Excel.run(function (ctx) { - var tables = ctx.workbook.tables; - var values = [["Sample", "Values", "For", "New", "Row"]]; - var row = tables.getItem("Table1").rows.add(null, values); - row.load('index'); - return ctx.sync().then(function() { - console.log(row.index); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -### getCount() -Gets the number of rows in the table. - -#### Syntax -```js -tableRowCollectionObject.getCount(); -``` - -#### Parameters -None - -#### Returns -int - -### getItemAt(index: number) -Gets a row based on its position in the collection. - -#### Syntax -```js -tableRowCollectionObject.getItemAt(index); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|index|number|Index value of the object to be retrieved. Zero-indexed.| - -#### Returns -[TableRow](tablerow.md) - -#### Examples - -```js -Excel.run(function (ctx) { - var tablerow = ctx.workbook.tables.getItem('Table1').rows.getItemAt(0); - tablerow.load('name'); - return ctx.sync().then(function() { - console.log(tablerow.name); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` -### Property access examples - -```js -Excel.run(function (ctx) { - var tablerows = ctx.workbook.tables.getItem('Table1').rows; - tablerows.load('items'); - return ctx.sync().then(function() { - console.log("tablerows Count: " + tablerows.count); - for (var i = 0; i < tablerows.items.length; i++) - { - console.log(tablerows.items[i].index); - } - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); +# TableRowCollection Object (JavaScript API for Excel) + +Represents a collection of all the rows that are part of the table. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|count|int|Returns the number of rows in the table. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|items|[TableRow[]](tablerow.md)|A collection of tableRow objects. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[add(index: number, values: object)](#addindex-number-values-object)|[TableRow](tablerow.md)|Adds one or more rows to the table. The return object will be the top of the newly added row(s).|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getCount()](#getcount)|int|Gets the number of rows in the table.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|[getItemAt(index: number)](#getitematindex-number)|[TableRow](tablerow.md)|Gets a row based on its position in the collection.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### add(index: number, values: object) +Adds one or more rows to the table. The return object will be the top of the newly added row(s). + +#### Syntax +```js +tableRowCollectionObject.add(index, values); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|index|number|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.| +|values|object|Optional. A 2-dimensional array of unformatted values of the table row.| + +#### Returns +[TableRow](tablerow.md) + +#### Examples + +```js +Excel.run(function (ctx) { + var tables = ctx.workbook.tables; + var values = [["Sample", "Values", "For", "New", "Row"]]; + var row = tables.getItem("Table1").rows.add(null, values); + row.load('index'); + return ctx.sync().then(function() { + console.log(row.index); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +### getCount() +Gets the number of rows in the table. + +#### Syntax +```js +tableRowCollectionObject.getCount(); +``` + +#### Parameters +None + +#### Returns +int + +### getItemAt(index: number) +Gets a row based on its position in the collection. + +#### Syntax +```js +tableRowCollectionObject.getItemAt(index); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|index|number|Index value of the object to be retrieved. Zero-indexed.| + +#### Returns +[TableRow](tablerow.md) + +#### Examples + +```js +Excel.run(function (ctx) { + var tablerow = ctx.workbook.tables.getItem('Table1').rows.getItemAt(0); + tablerow.load('name'); + return ctx.sync().then(function() { + console.log(tablerow.name); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` +### Property access examples + +```js +Excel.run(function (ctx) { + var tablerows = ctx.workbook.tables.getItem('Table1').rows; + tablerows.load('items'); + return ctx.sync().then(function() { + console.log("tablerows Count: " + tablerows.count); + for (var i = 0; i < tablerows.items.length; i++) + { + console.log(tablerows.items[i].index); + } + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); ``` \ No newline at end of file diff --git a/markdown/tablesort.md b/markdown/tablesort.md index 751fa1a..f9c4ace 100644 --- a/markdown/tablesort.md +++ b/markdown/tablesort.md @@ -1,92 +1,92 @@ -# TableSort Object (JavaScript API for Excel) - -Manages sorting operations on Table objects. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|matchCase|bool|Represents whether the casing impacted the last sort of the table. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|method|string|Represents Chinese character ordering method last used to sort the table. Read-only. Possible values are: PinYin, StrokeCount.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|fields|[SortField](sortfield.md)|Represents the current conditions used to last sort the table. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[apply(fields: SortField[], matchCase: bool, method: string)](#applyfields-sortfield-matchcase-bool-method-string)|void|Perform a sort operation.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|[clear()](#clear)|void|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.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|[reapply()](#reapply)|void|Reapplies the current sorting parameters to the table.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### apply(fields: SortField[], matchCase: bool, method: string) -Perform a sort operation. - -#### Syntax -```js -tableSortObject.apply(fields, matchCase, method); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|fields|SortField[]|The list of conditions to sort on.| -|matchCase|bool|Optional. Whether to have the casing impact string ordering.| -|method|string|Optional. The ordering method used for Chinese characters. Possible values are: PinYin, StrokeCount| - -#### Returns -void - -#### Examples -```js -Excel.run(function (ctx) { - var tableName = 'Table1'; - var table = ctx.workbook.tables.getItem(tableName); - table.sort.apply([ - { - key: 2, - ascending: true - }, - ], true); - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -### clear() -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. - -#### Syntax -```js -tableSortObject.clear(); -``` - -#### Parameters -None - -#### Returns -void - -### reapply() -Reapplies the current sorting parameters to the table. - -#### Syntax -```js -tableSortObject.reapply(); -``` - -#### Parameters -None - -#### Returns -void +# TableSort Object (JavaScript API for Excel) + +Manages sorting operations on Table objects. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|matchCase|bool|Represents whether the casing impacted the last sort of the table. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|method|string|Represents Chinese character ordering method last used to sort the table. Read-only. Possible values are: PinYin, StrokeCount.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|fields|[SortField](sortfield.md)|Represents the current conditions used to last sort the table. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[apply(fields: SortField[], matchCase: bool, method: string)](#applyfields-sortfield-matchcase-bool-method-string)|void|Perform a sort operation.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|[clear()](#clear)|void|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.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|[reapply()](#reapply)|void|Reapplies the current sorting parameters to the table.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### apply(fields: SortField[], matchCase: bool, method: string) +Perform a sort operation. + +#### Syntax +```js +tableSortObject.apply(fields, matchCase, method); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|fields|SortField[]|The list of conditions to sort on.| +|matchCase|bool|Optional. Whether to have the casing impact string ordering.| +|method|string|Optional. The ordering method used for Chinese characters. Possible values are: PinYin, StrokeCount| + +#### Returns +void + +#### Examples +```js +Excel.run(function (ctx) { + var tableName = 'Table1'; + var table = ctx.workbook.tables.getItem(tableName); + table.sort.apply([ + { + key: 2, + ascending: true + }, + ], true); + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +### clear() +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. + +#### Syntax +```js +tableSortObject.clear(); +``` + +#### Parameters +None + +#### Returns +void + +### reapply() +Reapplies the current sorting parameters to the table. + +#### Syntax +```js +tableSortObject.reapply(); +``` + +#### Parameters +None + +#### Returns +void diff --git a/markdown/textconditionalformat.md b/markdown/textconditionalformat.md index cfcc369..7fefa3e 100644 --- a/markdown/textconditionalformat.md +++ b/markdown/textconditionalformat.md @@ -1,17 +1,17 @@ -# TextConditionalFormat Object (JavaScript API for Excel) - -Represents a specific text conditional format. - -## Properties - -None - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|format|[ConditionalRangeFormat](conditionalrangeformat.md)|Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|rule|[ConditionalTextComparisonRule](conditionaltextcomparisonrule.md)|The rule of the conditional format.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# TextConditionalFormat Object (JavaScript API for Excel) + +Represents a specific text conditional format. + +## Properties + +None + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|format|[ConditionalRangeFormat](conditionalrangeformat.md)|Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|rule|[ConditionalTextComparisonRule](conditionaltextcomparisonrule.md)|The rule of the conditional format.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/topbottomconditionalformat.md b/markdown/topbottomconditionalformat.md index d76e1f2..098a3c7 100644 --- a/markdown/topbottomconditionalformat.md +++ b/markdown/topbottomconditionalformat.md @@ -1,17 +1,17 @@ -# TopBottomConditionalFormat Object (JavaScript API for Excel) - -Represents a TopBottom conditional format. - -## Properties - -None - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|format|[ConditionalRangeFormat](conditionalrangeformat.md)|Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|rule|[ConditionalTopBottomRule](conditionaltopbottomrule.md)|The criteria of the TopBottom conditional format.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods -None - +# TopBottomConditionalFormat Object (JavaScript API for Excel) + +Represents a TopBottom conditional format. + +## Properties + +None + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|format|[ConditionalRangeFormat](conditionalrangeformat.md)|Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|rule|[ConditionalTopBottomRule](conditionaltopbottomrule.md)|The criteria of the TopBottom conditional format.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods +None + diff --git a/markdown/workbook.md b/markdown/workbook.md index e854393..9f3b703 100644 --- a/markdown/workbook.md +++ b/markdown/workbook.md @@ -1,61 +1,61 @@ -# Workbook Object (JavaScript API for Excel) - -Workbook is the top level object which contains related workbook objects such as worksheets, tables, ranges, etc. - -## Properties - -None - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|application|[Application](application.md)|Represents Excel application instance that contains this workbook. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|bindings|[BindingCollection](bindingcollection.md)|Represents a collection of bindings that are part of the workbook. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|customXmlParts|[CustomXmlPartCollection](customxmlpartcollection.md)|Represents the collection of custom XML parts contained by this workbook. Read-only.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| -|functions|[Functions](functions.md)|Represents Excel application instance that contains this workbook. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|names|[NamedItemCollection](nameditemcollection.md)|Represents a collection of workbook scoped named items (named ranges and constants). Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|pivotTables|[PivotTableCollection](pivottablecollection.md)|Represents a collection of PivotTables associated with the workbook. Read-only.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| -|settings|[SettingCollection](settingcollection.md)|Represents a collection of Settings associated with the workbook. Read-only.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|tables|[TableCollection](tablecollection.md)|Represents a collection of tables associated with the workbook. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|test|[Test](test.md)|For internal use only. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|worksheets|[WorksheetCollection](worksheetcollection.md)|Represents a collection of worksheets associated with the workbook. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[getSelectedRange()](#getselectedrange)|[Range](range.md)|Gets the currently selected range from the workbook.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### getSelectedRange() -Gets the currently selected range from the workbook. - -#### Syntax -```js -workbookObject.getSelectedRange(); -``` - -#### Parameters -None - -#### Returns -[Range](range.md) - -#### Examples - -```js -Excel.run(function (ctx) { - var selectedRange = ctx.workbook.getSelectedRange(); - selectedRange.load('address'); - return ctx.sync().then(function() { - console.log(selectedRange.address); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); +# Workbook Object (JavaScript API for Excel) + +Workbook is the top level object which contains related workbook objects such as worksheets, tables, ranges, etc. + +## Properties + +None + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|application|[Application](application.md)|Represents Excel application instance that contains this workbook. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|bindings|[BindingCollection](bindingcollection.md)|Represents a collection of bindings that are part of the workbook. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|customXmlParts|[CustomXmlPartCollection](customxmlpartcollection.md)|Represents the collection of custom XML parts contained by this workbook. Read-only.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| +|functions|[Functions](functions.md)|Represents Excel application instance that contains this workbook. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|names|[NamedItemCollection](nameditemcollection.md)|Represents a collection of workbook scoped named items (named ranges and constants). Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|pivotTables|[PivotTableCollection](pivottablecollection.md)|Represents a collection of PivotTables associated with the workbook. Read-only.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| +|settings|[SettingCollection](settingcollection.md)|Represents a collection of Settings associated with the workbook. Read-only.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|tables|[TableCollection](tablecollection.md)|Represents a collection of tables associated with the workbook. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|test|[Test](test.md)|For internal use only. Read-only.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|worksheets|[WorksheetCollection](worksheetcollection.md)|Represents a collection of worksheets associated with the workbook. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[getSelectedRange()](#getselectedrange)|[Range](range.md)|Gets the currently selected range from the workbook.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### getSelectedRange() +Gets the currently selected range from the workbook. + +#### Syntax +```js +workbookObject.getSelectedRange(); +``` + +#### Parameters +None + +#### Returns +[Range](range.md) + +#### Examples + +```js +Excel.run(function (ctx) { + var selectedRange = ctx.workbook.getSelectedRange(); + selectedRange.load('address'); + return ctx.sync().then(function() { + console.log(selectedRange.address); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); ``` \ No newline at end of file diff --git a/markdown/worksheet.md b/markdown/worksheet.md index ce807f8..03a7d70 100644 --- a/markdown/worksheet.md +++ b/markdown/worksheet.md @@ -1,365 +1,365 @@ -# Worksheet Object (JavaScript API for Excel) - -An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|id|string|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. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|name|string|The display name of the worksheet.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|position|int|The zero-based position of the worksheet within the workbook.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|visibility|string|The Visibility of the worksheet. Possible values are: Visible, Hidden, VeryHidden.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|charts|[ChartCollection](chartcollection.md)|Returns collection of charts that are part of the worksheet. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|names|[NamedItemCollection](nameditemcollection.md)|Collection of names scoped to the current worksheet. Read-only.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|pivotTables|[PivotTableCollection](pivottablecollection.md)|Collection of PivotTables that are part of the worksheet. Read-only.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| -|protection|[WorksheetProtection](worksheetprotection.md)|Returns sheet protection object for a worksheet. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|tables|[TableCollection](tablecollection.md)|Collection of tables that are part of the worksheet. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[activate()](#activate)|void|Activate the worksheet in the Excel UI.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[calculate(markAllDirty: bool)](#calculatemarkalldirty-bool)|void|Calculates all cells on a worksheet.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| -|[delete()](#delete)|void|Deletes the worksheet from the workbook.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getCell(row: number, column: number)](#getcellrow-number-column-number)|[Range](range.md)|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's stays within the worksheet grid.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getNext(visibleOnly: bool)](#getnextvisibleonly-bool)|[Worksheet](worksheet.md)|Gets the worksheet that follows this one. If there are no worksheets following this one, this method will throw an error.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| -|[getNextOrNullObject(visibleOnly: bool)](#getnextornullobjectvisibleonly-bool)|[Worksheet](worksheet.md)|Gets the worksheet that follows this one. If there are no worksheets following this one, this method will return a null object.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| -|[getPrevious(visibleOnly: bool)](#getpreviousvisibleonly-bool)|[Worksheet](worksheet.md)|Gets the worksheet that precedes this one. If there are no previous worksheets, this method will throw an error.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| -|[getPreviousOrNullObject(visibleOnly: bool)](#getpreviousornullobjectvisibleonly-bool)|[Worksheet](worksheet.md)|Gets the worksheet that precedes this one. If there are no previous worksheets, this method will return a null objet.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| -|[getRange(address: string)](#getrangeaddress-string)|[Range](range.md)|Gets the range object specified by the address or name.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getUsedRange(valuesOnly: bool)](#getusedrangevaluesonly-bool)|[Range](range.md)|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).|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getUsedRangeOrNullObject(valuesOnly: bool)](#getusedrangeornullobjectvaluesonly-bool)|[Range](range.md)|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 a null object.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### activate() -Activate the worksheet in the Excel UI. - -#### Syntax -```js -worksheetObject.activate(); -``` - -#### Parameters -None - -#### Returns -void - -#### Examples - -```js -Excel.run(function (ctx) { - var wSheetName = 'Sheet1'; - var worksheet = ctx.workbook.worksheets.getItem(wSheetName); - worksheet.activate(); - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### calculate(markAllDirty: bool) -Calculates all cells on a worksheet. - -#### Syntax -```js -worksheetObject.calculate(markAllDirty); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|markAllDirty|bool|Boolean to mark as dirty.| - -#### Returns -void - -### delete() -Deletes the worksheet from the workbook. - -#### Syntax -```js -worksheetObject.delete(); -``` - -#### Parameters -None - -#### Returns -void - -#### Examples - -```js -Excel.run(function (ctx) { - var wSheetName = 'Sheet1'; - var worksheet = ctx.workbook.worksheets.getItem(wSheetName); - worksheet.delete(); - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getCell(row: number, column: number) -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's stays within the worksheet grid. - -#### Syntax -```js -worksheetObject.getCell(row, column); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|row|number|The row number of the cell to be retrieved. Zero-indexed.| -|column|number|the column number of the cell to be retrieved. Zero-indexed.| - -#### Returns -[Range](range.md) - -#### Examples - -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "A1:F8"; - var worksheet = ctx.workbook.worksheets.getItem(sheetName); - var cell = worksheet.getCell(0,0); - cell.load('address'); - return ctx.sync().then(function() { - console.log(cell.address); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getNext(visibleOnly: bool) -Gets the worksheet that follows this one. If there are no worksheets following this one, this method will throw an error. - -#### Syntax -```js -worksheetObject.getNext(visibleOnly); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|visibleOnly|bool|Optional. If true, considers only visible worksheets, skipping over any hidden ones.| - -#### Returns -[Worksheet](worksheet.md) - -### getNextOrNullObject(visibleOnly: bool) -Gets the worksheet that follows this one. If there are no worksheets following this one, this method will return a null object. - -#### Syntax -```js -worksheetObject.getNextOrNullObject(visibleOnly); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|visibleOnly|bool|Optional. If true, considers only visible worksheets, skipping over any hidden ones.| - -#### Returns -[Worksheet](worksheet.md) - -### getPrevious(visibleOnly: bool) -Gets the worksheet that precedes this one. If there are no previous worksheets, this method will throw an error. - -#### Syntax -```js -worksheetObject.getPrevious(visibleOnly); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|visibleOnly|bool|Optional. If true, considers only visible worksheets, skipping over any hidden ones.| - -#### Returns -[Worksheet](worksheet.md) - -### getPreviousOrNullObject(visibleOnly: bool) -Gets the worksheet that precedes this one. If there are no previous worksheets, this method will return a null objet. - -#### Syntax -```js -worksheetObject.getPreviousOrNullObject(visibleOnly); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|visibleOnly|bool|Optional. If true, considers only visible worksheets, skipping over any hidden ones.| - -#### Returns -[Worksheet](worksheet.md) - -### getRange(address: string) -Gets the range object specified by the address or name. - -#### Syntax -```js -worksheetObject.getRange(address); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|address|string|Optional. The address or the name of the range. If not specified, the entire worksheet range is returned.| - -#### Returns -[Range](range.md) - -#### Examples -Below example uses range address to get the range object. - -```js -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeAddress = "A1:F8"; - var worksheet = ctx.workbook.worksheets.getItem(sheetName); - var range = worksheet.getRange(rangeAddress); - range.load('cellCount'); - return ctx.sync().then(function() { - console.log(range.cellCount); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -Below example uses a named-range to get the range object. - -```js - -Excel.run(function (ctx) { - var sheetName = "Sheet1"; - var rangeName = 'MyRange'; - var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeName); - range.load('address'); - return ctx.sync().then(function() { - console.log(range.address); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -### getUsedRange(valuesOnly: bool) -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). - -#### Syntax -```js -worksheetObject.getUsedRange(valuesOnly); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|valuesOnly|bool|Optional. Considers only cells with values as used cells (ignoring formatting).| - -#### Returns -[Range](range.md) - -#### Examples - -```js -Excel.run(function (ctx) { - var wSheetName = 'Sheet1'; - var worksheet = ctx.workbook.worksheets.getItem(wSheetName); - var usedRange = worksheet.getUsedRange(); - usedRange.load('address'); - return ctx.sync().then(function() { - console.log(usedRange.address); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getUsedRangeOrNullObject(valuesOnly: bool) -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 a null object. - -#### Syntax -```js -worksheetObject.getUsedRangeOrNullObject(valuesOnly); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|valuesOnly|bool|Optional. Considers only cells with values as used cells.| - -#### Returns -[Range](range.md) -### Property access examples - -Get worksheet properties based on sheet name. - -```js -Excel.run(function (ctx) { - var wSheetName = 'Sheet1'; - var worksheet = ctx.workbook.worksheets.getItem(wSheetName); - worksheet.load('position') - return ctx.sync().then(function() { - console.log(worksheet.position); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - -Set worksheet position. - -```js -Excel.run(function (ctx) { - var wSheetName = 'Sheet1'; - var worksheet = ctx.workbook.worksheets.getItem(wSheetName); - worksheet.position = 2; - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` +# Worksheet Object (JavaScript API for Excel) + +An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|id|string|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. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|name|string|The display name of the worksheet.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|position|int|The zero-based position of the worksheet within the workbook.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|visibility|string|The Visibility of the worksheet. Possible values are: Visible, Hidden, VeryHidden.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|charts|[ChartCollection](chartcollection.md)|Returns collection of charts that are part of the worksheet. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|names|[NamedItemCollection](nameditemcollection.md)|Collection of names scoped to the current worksheet. Read-only.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|pivotTables|[PivotTableCollection](pivottablecollection.md)|Collection of PivotTables that are part of the worksheet. Read-only.|[1.3](../requirement-sets/excel-api-requirement-sets.md)| +|protection|[WorksheetProtection](worksheetprotection.md)|Returns sheet protection object for a worksheet. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|tables|[TableCollection](tablecollection.md)|Collection of tables that are part of the worksheet. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[activate()](#activate)|void|Activate the worksheet in the Excel UI.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[calculate(markAllDirty: bool)](#calculatemarkalldirty-bool)|void|Calculates all cells on a worksheet.|[1.6](../requirement-sets/excel-api-requirement-sets.md)| +|[delete()](#delete)|void|Deletes the worksheet from the workbook.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getCell(row: number, column: number)](#getcellrow-number-column-number)|[Range](range.md)|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's stays within the worksheet grid.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getNext(visibleOnly: bool)](#getnextvisibleonly-bool)|[Worksheet](worksheet.md)|Gets the worksheet that follows this one. If there are no worksheets following this one, this method will throw an error.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| +|[getNextOrNullObject(visibleOnly: bool)](#getnextornullobjectvisibleonly-bool)|[Worksheet](worksheet.md)|Gets the worksheet that follows this one. If there are no worksheets following this one, this method will return a null object.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| +|[getPrevious(visibleOnly: bool)](#getpreviousvisibleonly-bool)|[Worksheet](worksheet.md)|Gets the worksheet that precedes this one. If there are no previous worksheets, this method will throw an error.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| +|[getPreviousOrNullObject(visibleOnly: bool)](#getpreviousornullobjectvisibleonly-bool)|[Worksheet](worksheet.md)|Gets the worksheet that precedes this one. If there are no previous worksheets, this method will return a null objet.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| +|[getRange(address: string)](#getrangeaddress-string)|[Range](range.md)|Gets the range object specified by the address or name.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getUsedRange(valuesOnly: bool)](#getusedrangevaluesonly-bool)|[Range](range.md)|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).|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getUsedRangeOrNullObject(valuesOnly: bool)](#getusedrangeornullobjectvaluesonly-bool)|[Range](range.md)|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 a null object.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### activate() +Activate the worksheet in the Excel UI. + +#### Syntax +```js +worksheetObject.activate(); +``` + +#### Parameters +None + +#### Returns +void + +#### Examples + +```js +Excel.run(function (ctx) { + var wSheetName = 'Sheet1'; + var worksheet = ctx.workbook.worksheets.getItem(wSheetName); + worksheet.activate(); + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### calculate(markAllDirty: bool) +Calculates all cells on a worksheet. + +#### Syntax +```js +worksheetObject.calculate(markAllDirty); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|markAllDirty|bool|Boolean to mark as dirty.| + +#### Returns +void + +### delete() +Deletes the worksheet from the workbook. + +#### Syntax +```js +worksheetObject.delete(); +``` + +#### Parameters +None + +#### Returns +void + +#### Examples + +```js +Excel.run(function (ctx) { + var wSheetName = 'Sheet1'; + var worksheet = ctx.workbook.worksheets.getItem(wSheetName); + worksheet.delete(); + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getCell(row: number, column: number) +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's stays within the worksheet grid. + +#### Syntax +```js +worksheetObject.getCell(row, column); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|row|number|The row number of the cell to be retrieved. Zero-indexed.| +|column|number|the column number of the cell to be retrieved. Zero-indexed.| + +#### Returns +[Range](range.md) + +#### Examples + +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "A1:F8"; + var worksheet = ctx.workbook.worksheets.getItem(sheetName); + var cell = worksheet.getCell(0,0); + cell.load('address'); + return ctx.sync().then(function() { + console.log(cell.address); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getNext(visibleOnly: bool) +Gets the worksheet that follows this one. If there are no worksheets following this one, this method will throw an error. + +#### Syntax +```js +worksheetObject.getNext(visibleOnly); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|visibleOnly|bool|Optional. If true, considers only visible worksheets, skipping over any hidden ones.| + +#### Returns +[Worksheet](worksheet.md) + +### getNextOrNullObject(visibleOnly: bool) +Gets the worksheet that follows this one. If there are no worksheets following this one, this method will return a null object. + +#### Syntax +```js +worksheetObject.getNextOrNullObject(visibleOnly); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|visibleOnly|bool|Optional. If true, considers only visible worksheets, skipping over any hidden ones.| + +#### Returns +[Worksheet](worksheet.md) + +### getPrevious(visibleOnly: bool) +Gets the worksheet that precedes this one. If there are no previous worksheets, this method will throw an error. + +#### Syntax +```js +worksheetObject.getPrevious(visibleOnly); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|visibleOnly|bool|Optional. If true, considers only visible worksheets, skipping over any hidden ones.| + +#### Returns +[Worksheet](worksheet.md) + +### getPreviousOrNullObject(visibleOnly: bool) +Gets the worksheet that precedes this one. If there are no previous worksheets, this method will return a null objet. + +#### Syntax +```js +worksheetObject.getPreviousOrNullObject(visibleOnly); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|visibleOnly|bool|Optional. If true, considers only visible worksheets, skipping over any hidden ones.| + +#### Returns +[Worksheet](worksheet.md) + +### getRange(address: string) +Gets the range object specified by the address or name. + +#### Syntax +```js +worksheetObject.getRange(address); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|address|string|Optional. The address or the name of the range. If not specified, the entire worksheet range is returned.| + +#### Returns +[Range](range.md) + +#### Examples +Below example uses range address to get the range object. + +```js +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeAddress = "A1:F8"; + var worksheet = ctx.workbook.worksheets.getItem(sheetName); + var range = worksheet.getRange(rangeAddress); + range.load('cellCount'); + return ctx.sync().then(function() { + console.log(range.cellCount); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +Below example uses a named-range to get the range object. + +```js + +Excel.run(function (ctx) { + var sheetName = "Sheet1"; + var rangeName = 'MyRange'; + var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeName); + range.load('address'); + return ctx.sync().then(function() { + console.log(range.address); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +### getUsedRange(valuesOnly: bool) +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). + +#### Syntax +```js +worksheetObject.getUsedRange(valuesOnly); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|valuesOnly|bool|Optional. Considers only cells with values as used cells (ignoring formatting).| + +#### Returns +[Range](range.md) + +#### Examples + +```js +Excel.run(function (ctx) { + var wSheetName = 'Sheet1'; + var worksheet = ctx.workbook.worksheets.getItem(wSheetName); + var usedRange = worksheet.getUsedRange(); + usedRange.load('address'); + return ctx.sync().then(function() { + console.log(usedRange.address); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getUsedRangeOrNullObject(valuesOnly: bool) +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 a null object. + +#### Syntax +```js +worksheetObject.getUsedRangeOrNullObject(valuesOnly); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|valuesOnly|bool|Optional. Considers only cells with values as used cells.| + +#### Returns +[Range](range.md) +### Property access examples + +Get worksheet properties based on sheet name. + +```js +Excel.run(function (ctx) { + var wSheetName = 'Sheet1'; + var worksheet = ctx.workbook.worksheets.getItem(wSheetName); + worksheet.load('position') + return ctx.sync().then(function() { + console.log(worksheet.position); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + +Set worksheet position. + +```js +Excel.run(function (ctx) { + var wSheetName = 'Sheet1'; + var worksheet = ctx.workbook.worksheets.getItem(wSheetName); + worksheet.position = 2; + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` diff --git a/markdown/worksheetcollection.md b/markdown/worksheetcollection.md index bce10a3..83f710b 100644 --- a/markdown/worksheetcollection.md +++ b/markdown/worksheetcollection.md @@ -1,196 +1,196 @@ -# WorksheetCollection Object (JavaScript API for Excel) - -Represents a collection of worksheet objects that are part of the workbook. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|items|[Worksheet[]](worksheet.md)|A collection of worksheet objects. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[add(name: string)](#addname-string)|[Worksheet](worksheet.md)|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.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getActiveWorksheet()](#getactiveworksheet)|[Worksheet](worksheet.md)|Gets the currently active worksheet in the workbook.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getCount(visibleOnly: bool)](#getcountvisibleonly-bool)|int|Gets the number of worksheets in the collection.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|[getFirst(visibleOnly: bool)](#getfirstvisibleonly-bool)|[Worksheet](worksheet.md)|Gets the first worksheet in the collection.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| -|[getItem(key: string)](#getitemkey-string)|[Worksheet](worksheet.md)|Gets a worksheet object using its Name or ID.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| -|[getItemOrNullObject(key: string)](#getitemornullobjectkey-string)|[Worksheet](worksheet.md)|Gets a worksheet object using its Name or ID. If the worksheet does not exist, will return a null object.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| -|[getLast(visibleOnly: bool)](#getlastvisibleonly-bool)|[Worksheet](worksheet.md)|Gets the last worksheet in the collection.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### add(name: string) -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. - -#### Syntax -```js -worksheetCollectionObject.add(name); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|name|string|Optional. The name of the worksheet to be added. If specified, name should be unqiue. If not specified, Excel determines the name of the new worksheet.| - -#### Returns -[Worksheet](worksheet.md) - -#### Examples - -```js -Excel.run(function (ctx) { - var wSheetName = 'Sample Name'; - var worksheet = ctx.workbook.worksheets.add(wSheetName); - worksheet.load('name'); - return ctx.sync().then(function() { - console.log(worksheet.name); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getActiveWorksheet() -Gets the currently active worksheet in the workbook. - -#### Syntax -```js -worksheetCollectionObject.getActiveWorksheet(); -``` - -#### Parameters -None - -#### Returns -[Worksheet](worksheet.md) - -#### Examples - -```js -Excel.run(function (ctx) { - var activeWorksheet = ctx.workbook.worksheets.getActiveWorksheet(); - activeWorksheet.load('name'); - return ctx.sync().then(function() { - console.log(activeWorksheet.name); - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` - - -### getCount(visibleOnly: bool) -Gets the number of worksheets in the collection. - -#### Syntax -```js -worksheetCollectionObject.getCount(visibleOnly); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|visibleOnly|bool|Optional. Considers only the visible cells.| - -#### Returns -int - -### getFirst(visibleOnly: bool) -Gets the first worksheet in the collection. - -#### Syntax -```js -worksheetCollectionObject.getFirst(visibleOnly); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|visibleOnly|bool|Optional. If true, considers only visible worksheets, skipping over any hidden ones.| - -#### Returns -[Worksheet](worksheet.md) - -### getItem(key: string) -Gets a worksheet object using its Name or ID. - -#### Syntax -```js -worksheetCollectionObject.getItem(key); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|key|string|The Name or ID of the worksheet.| - -#### Returns -[Worksheet](worksheet.md) - -### getItemOrNullObject(key: string) -Gets a worksheet object using its Name or ID. If the worksheet does not exist, will return a null object. - -#### Syntax -```js -worksheetCollectionObject.getItemOrNullObject(key); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|key|string|The Name or ID of the worksheet.| - -#### Returns -[Worksheet](worksheet.md) - -### getLast(visibleOnly: bool) -Gets the last worksheet in the collection. - -#### Syntax -```js -worksheetCollectionObject.getLast(visibleOnly); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|visibleOnly|bool|Optional. If true, considers only visible worksheets, skipping over any hidden ones.| - -#### Returns -[Worksheet](worksheet.md) -### Property access examples -```js -Excel.run(function (ctx) { - var worksheets = ctx.workbook.worksheets; - worksheets.load('items'); - return ctx.sync().then(function() { - for (var i = 0; i < worksheets.items.length; i++) - { - console.log(worksheets.items[i].name); - console.log(worksheets.items[i].index); - } - }); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); -``` +# WorksheetCollection Object (JavaScript API for Excel) + +Represents a collection of worksheet objects that are part of the workbook. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|items|[Worksheet[]](worksheet.md)|A collection of worksheet objects. Read-only.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[add(name: string)](#addname-string)|[Worksheet](worksheet.md)|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.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getActiveWorksheet()](#getactiveworksheet)|[Worksheet](worksheet.md)|Gets the currently active worksheet in the workbook.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getCount(visibleOnly: bool)](#getcountvisibleonly-bool)|int|Gets the number of worksheets in the collection.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|[getFirst(visibleOnly: bool)](#getfirstvisibleonly-bool)|[Worksheet](worksheet.md)|Gets the first worksheet in the collection.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| +|[getItem(key: string)](#getitemkey-string)|[Worksheet](worksheet.md)|Gets a worksheet object using its Name or ID.|[1.1](../requirement-sets/excel-api-requirement-sets.md)| +|[getItemOrNullObject(key: string)](#getitemornullobjectkey-string)|[Worksheet](worksheet.md)|Gets a worksheet object using its Name or ID. If the worksheet does not exist, will return a null object.|[1.4](../requirement-sets/excel-api-requirement-sets.md)| +|[getLast(visibleOnly: bool)](#getlastvisibleonly-bool)|[Worksheet](worksheet.md)|Gets the last worksheet in the collection.|[1.5](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### add(name: string) +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. + +#### Syntax +```js +worksheetCollectionObject.add(name); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|name|string|Optional. The name of the worksheet to be added. If specified, name should be unqiue. If not specified, Excel determines the name of the new worksheet.| + +#### Returns +[Worksheet](worksheet.md) + +#### Examples + +```js +Excel.run(function (ctx) { + var wSheetName = 'Sample Name'; + var worksheet = ctx.workbook.worksheets.add(wSheetName); + worksheet.load('name'); + return ctx.sync().then(function() { + console.log(worksheet.name); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getActiveWorksheet() +Gets the currently active worksheet in the workbook. + +#### Syntax +```js +worksheetCollectionObject.getActiveWorksheet(); +``` + +#### Parameters +None + +#### Returns +[Worksheet](worksheet.md) + +#### Examples + +```js +Excel.run(function (ctx) { + var activeWorksheet = ctx.workbook.worksheets.getActiveWorksheet(); + activeWorksheet.load('name'); + return ctx.sync().then(function() { + console.log(activeWorksheet.name); + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` + + +### getCount(visibleOnly: bool) +Gets the number of worksheets in the collection. + +#### Syntax +```js +worksheetCollectionObject.getCount(visibleOnly); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|visibleOnly|bool|Optional. Considers only the visible cells.| + +#### Returns +int + +### getFirst(visibleOnly: bool) +Gets the first worksheet in the collection. + +#### Syntax +```js +worksheetCollectionObject.getFirst(visibleOnly); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|visibleOnly|bool|Optional. If true, considers only visible worksheets, skipping over any hidden ones.| + +#### Returns +[Worksheet](worksheet.md) + +### getItem(key: string) +Gets a worksheet object using its Name or ID. + +#### Syntax +```js +worksheetCollectionObject.getItem(key); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|key|string|The Name or ID of the worksheet.| + +#### Returns +[Worksheet](worksheet.md) + +### getItemOrNullObject(key: string) +Gets a worksheet object using its Name or ID. If the worksheet does not exist, will return a null object. + +#### Syntax +```js +worksheetCollectionObject.getItemOrNullObject(key); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|key|string|The Name or ID of the worksheet.| + +#### Returns +[Worksheet](worksheet.md) + +### getLast(visibleOnly: bool) +Gets the last worksheet in the collection. + +#### Syntax +```js +worksheetCollectionObject.getLast(visibleOnly); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|visibleOnly|bool|Optional. If true, considers only visible worksheets, skipping over any hidden ones.| + +#### Returns +[Worksheet](worksheet.md) +### Property access examples +```js +Excel.run(function (ctx) { + var worksheets = ctx.workbook.worksheets; + worksheets.load('items'); + return ctx.sync().then(function() { + for (var i = 0; i < worksheets.items.length; i++) + { + console.log(worksheets.items[i].name); + console.log(worksheets.items[i].index); + } + }); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); +``` diff --git a/markdown/worksheetprotection.md b/markdown/worksheetprotection.md index bf24b57..67e240a 100644 --- a/markdown/worksheetprotection.md +++ b/markdown/worksheetprotection.md @@ -1,69 +1,69 @@ -# WorksheetProtection Object (JavaScript API for Excel) - -Represents the protection of a sheet object. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|protected|bool|Indicates if the worksheet is protected. Read-Only. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -## Relationships -| Relationship | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|options|[WorksheetProtectionOptions](worksheetprotectionoptions.md)|Sheet protection options. Read-Only. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -## Methods - -| Method | Return Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|[protect(options: WorksheetProtectionOptions)](#protectoptions-worksheetprotectionoptions)|void|Protects a worksheet. Fails if the worksheet has been protected.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|[unprotect()](#unprotect)|void|Unprotects a worksheet.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -## Method Details - - -### protect(options: WorksheetProtectionOptions) -Protects a worksheet. Fails if the worksheet has been protected. - -#### Syntax -```js -worksheetProtectionObject.protect(options); -``` - -#### Parameters -| Parameter | Type |Description| -|:---------------|:--------|:----------| -|options|WorksheetProtectionOptions|Optional. sheet protection options.| - -#### Returns -void - -#### Examples -```js -Excel.run(function (ctx) { - var sheet = ctx.workbook.worksheets.getItem("Sheet1"); - var range = sheet.getRange("A1:B3").format.protection.locked = false; - sheet.protection.protect({allowInsertRows:true}); - return ctx.sync(); -}).catch(function(error) { - console.log("Error: " + error); - if (error instanceof OfficeExtension.Error) { - console.log("Debug info: " + JSON.stringify(error.debugInfo)); - } -}); - -``` -### unprotect() -Unprotects a worksheet. - -#### Syntax -```js -worksheetProtectionObject.unprotect(); -``` - -#### Parameters -None - -#### Returns -void +# WorksheetProtection Object (JavaScript API for Excel) + +Represents the protection of a sheet object. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|protected|bool|Indicates if the worksheet is protected. Read-Only. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +## Relationships +| Relationship | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|options|[WorksheetProtectionOptions](worksheetprotectionoptions.md)|Sheet protection options. Read-Only. Read-only.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +## Methods + +| Method | Return Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|[protect(options: WorksheetProtectionOptions)](#protectoptions-worksheetprotectionoptions)|void|Protects a worksheet. Fails if the worksheet has been protected.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|[unprotect()](#unprotect)|void|Unprotects a worksheet.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +## Method Details + + +### protect(options: WorksheetProtectionOptions) +Protects a worksheet. Fails if the worksheet has been protected. + +#### Syntax +```js +worksheetProtectionObject.protect(options); +``` + +#### Parameters +| Parameter | Type |Description| +|:---------------|:--------|:----------| +|options|WorksheetProtectionOptions|Optional. sheet protection options.| + +#### Returns +void + +#### Examples +```js +Excel.run(function (ctx) { + var sheet = ctx.workbook.worksheets.getItem("Sheet1"); + var range = sheet.getRange("A1:B3").format.protection.locked = false; + sheet.protection.protect({allowInsertRows:true}); + return ctx.sync(); +}).catch(function(error) { + console.log("Error: " + error); + if (error instanceof OfficeExtension.Error) { + console.log("Debug info: " + JSON.stringify(error.debugInfo)); + } +}); + +``` +### unprotect() +Unprotects a worksheet. + +#### Syntax +```js +worksheetProtectionObject.unprotect(); +``` + +#### Parameters +None + +#### Returns +void diff --git a/markdown/worksheetprotectionoptions.md b/markdown/worksheetprotectionoptions.md index fe39abf..c1f1cc4 100644 --- a/markdown/worksheetprotectionoptions.md +++ b/markdown/worksheetprotectionoptions.md @@ -1,29 +1,29 @@ -# WorksheetProtectionOptions Object (JavaScript API for Excel) - -Represents the options in sheet protection. - -## Properties - -| Property | Type |Description| Req. Set| -|:---------------|:--------|:----------|:----| -|allowAutoFilter|bool|Represents the worksheet protection option of allowing using auto filter feature.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|allowDeleteColumns|bool|Represents the worksheet protection option of allowing deleting columns.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|allowDeleteRows|bool|Represents the worksheet protection option of allowing deleting rows.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|allowFormatCells|bool|Represents the worksheet protection option of allowing formatting cells.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|allowFormatColumns|bool|Represents the worksheet protection option of allowing formatting columns.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|allowFormatRows|bool|Represents the worksheet protection option of allowing formatting rows.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|allowInsertColumns|bool|Represents the worksheet protection option of allowing inserting columns.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|allowInsertHyperlinks|bool|Represents the worksheet protection option of allowing inserting hyperlinks.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|allowInsertRows|bool|Represents the worksheet protection option of allowing inserting rows.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|allowPivotTables|bool|Represents the worksheet protection option of allowing using PivotTable feature.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| -|allowSort|bool|Represents the worksheet protection option of allowing using sort feature.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| - -_See property access [examples.](#property-access-examples)_ - -## Relationships -None - - -## Methods -None - +# WorksheetProtectionOptions Object (JavaScript API for Excel) + +Represents the options in sheet protection. + +## Properties + +| Property | Type |Description| Req. Set| +|:---------------|:--------|:----------|:----| +|allowAutoFilter|bool|Represents the worksheet protection option of allowing using auto filter feature.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|allowDeleteColumns|bool|Represents the worksheet protection option of allowing deleting columns.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|allowDeleteRows|bool|Represents the worksheet protection option of allowing deleting rows.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|allowFormatCells|bool|Represents the worksheet protection option of allowing formatting cells.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|allowFormatColumns|bool|Represents the worksheet protection option of allowing formatting columns.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|allowFormatRows|bool|Represents the worksheet protection option of allowing formatting rows.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|allowInsertColumns|bool|Represents the worksheet protection option of allowing inserting columns.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|allowInsertHyperlinks|bool|Represents the worksheet protection option of allowing inserting hyperlinks.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|allowInsertRows|bool|Represents the worksheet protection option of allowing inserting rows.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|allowPivotTables|bool|Represents the worksheet protection option of allowing using PivotTable feature.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| +|allowSort|bool|Represents the worksheet protection option of allowing using sort feature.|[1.2](../requirement-sets/excel-api-requirement-sets.md)| + +_See property access [examples.](#property-access-examples)_ + +## Relationships +None + + +## Methods +None + diff --git a/scripts/genJsonFromMetadata.rb b/scripts/genJsonFromMetadata.rb index 7c2b25f..e7fbb10 100644 --- a/scripts/genJsonFromMetadata.rb +++ b/scripts/genJsonFromMetadata.rb @@ -23,7 +23,7 @@ module SpecMaker @processed_files = 0 @json_files_created = 0 -METADATA_FILE_SOURCE = '../../data/ExcelApi_1.7_build.cs' +METADATA_FILE_SOURCE = '../data/ExcelApi_1.7_build.cs' #METADATA_FILE_SOURCE = '../../data/1.5.cs' ENUMS = 'jsonFiles/settings/enums.json' LOADMETHOD = 'jsonFiles/settings/loadMethod.json' diff --git a/scripts/jsonFiles/settings/enums.json b/scripts/jsonFiles/settings/enums.json index 586c45d..43caf8e 100644 --- a/scripts/jsonFiles/settings/enums.json +++ b/scripts/jsonFiles/settings/enums.json @@ -90,6 +90,49 @@ "None": "", "Single": "" }, + "Excel.ChartTextHorizontalAlignment": { + "Center": "", + "Left" : "", + "Right" : "", + "Justify": "", + "Distributed": "" + }, + "Excel.ChartAxisDisplayUnit": { + "None": "Default option. This will reset display unit to the axis, and set unit label invisible.", + "Hundreds": "This will set the axis in units of hundreds.", + "Thousands": "This will set the axis in units of thousands.", + "TenThousands": "This will set the axis in units of tens of thousands.", + "HundredThousands": "This will set the axis in units of hundreds of thousands.", + "Millions": "This will set the axis in units of millions.", + "TenMillions": "This will set the axis in units of tens of millions.", + "HundredMillons": "This will set the axis in units of hundreds of millions.", + "Billions": "This will set the axis in units of billions.", + "Trillions": "This will set the axis in units of trillions.", + "Custom": "This will set the axis in units of custom value." + }, + "Excel.TrendlineType": { + "Linear": "", + "Expontential": "", + "Logarithmic" : "", + "MovingAvg" : "", + "Polynomial" : "", + "Power" : "" + }, + "Excel.AxisType": { + "Category" : "Specifies the axis type. Axis displays categories.", + "Value" : "Specifies the axis type. Axis displays values.", + "SeriesAxis" : "Specifies the axis type. Axis displays data series." + }, + "Excel.XlTimeUnit": { + "Days": "Specifies the unit of time for chart axes and data series, in days.", + "Months": "Specifies the unit of time for chart axes and data series, in months.", + "Years": "Specifies the unit of time for chart axes and data series, in years." + }, + "Excel.XlCategoryType": { + "Automatic": "Specifies the type of the category axis. Excel controls the axis type.", + "TextAxis": "Specifies the type of the category axis. Axis groups data by an arbitrary set of categories.", + "DateAxis": "Specifies the type of the category axis. Axis groups data on a time scale." + }, "Excel.DeleteShiftDirection": { "Up": "", "Left": "" diff --git a/scripts/jsonFiles/source/application.json b/scripts/jsonFiles/source/application.json index f7aa2e5..7b1d1b7 100644 --- a/scripts/jsonFiles/source/application.json +++ b/scripts/jsonFiles/source/application.json @@ -1,70 +1,70 @@ -{ - "name": "Application", - "description": "Represents the Excel application that manages the workbook.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "calculationMode", - "dataType": "string", - "description": "Returns the calculation mode used in the workbook.", - "isReadOnly": true, - "enumNameJs": "Excel.CalculationMode", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "calculate", - "returnType": "void", - "description": "Recalculate all currently opened workbooks in Excel.", - "syntax": "applicationObject.calculate(calculationType);", - "signature": "calculate(calculationType: string)", - "restfulName": "calculate", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "calculationType", - "dataType": "string", - "isCollection": false, - "description": "Specifies the calculation type to use.", - "isRequired": true, - "enumNameJs": "Excel.CalculationType", - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "suspendApiCalculationUntilNextSync", - "returnType": "void", - "description": "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.", - "syntax": "applicationObject.suspendApiCalculationUntilNextSync();", - "signature": "suspendApiCalculationUntilNextSync()", - "restfulName": "suspendApiCalculationUntilNextSync", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.6" - } - ] +{ + "name": "Application", + "description": "Represents the Excel application that manages the workbook.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "calculationMode", + "dataType": "string", + "description": "Returns the calculation mode used in the workbook.", + "isReadOnly": true, + "enumNameJs": "Excel.CalculationMode", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "calculate", + "returnType": "void", + "description": "Recalculate all currently opened workbooks in Excel.", + "syntax": "applicationObject.calculate(calculationType);", + "signature": "calculate(calculationType: string)", + "restfulName": "calculate", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "calculationType", + "dataType": "string", + "isCollection": false, + "description": "Specifies the calculation type to use.", + "isRequired": true, + "enumNameJs": "Excel.CalculationType", + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "suspendApiCalculationUntilNextSync", + "returnType": "void", + "description": "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.", + "syntax": "applicationObject.suspendApiCalculationUntilNextSync();", + "signature": "suspendApiCalculationUntilNextSync()", + "restfulName": "suspendApiCalculationUntilNextSync", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.6" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/binding.json b/scripts/jsonFiles/source/binding.json index 0aa848f..b98be11 100644 --- a/scripts/jsonFiles/source/binding.json +++ b/scripts/jsonFiles/source/binding.json @@ -1,96 +1,96 @@ -{ - "name": "Binding", - "description": "Represents an Office.js binding that is defined in the workbook.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "id", - "dataType": "string", - "description": "Represents binding identifier.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "type", - "dataType": "string", - "description": "Returns the type of the binding.", - "isReadOnly": true, - "enumNameJs": "Excel.BindingType", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "delete", - "returnType": "void", - "description": "Deletes the binding.", - "syntax": "bindingObject.delete();", - "signature": "delete()", - "restfulName": "delete", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.3" - }, - { - "name": "getRange", - "returnType": "Range", - "description": "Returns the range represented by the binding. Will throw an error if binding is not of the correct type.", - "syntax": "bindingObject.getRange();", - "signature": "getRange()", - "restfulName": "Range", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "getTable", - "returnType": "Table", - "description": "Returns the table represented by the binding. Will throw an error if binding is not of the correct type.", - "syntax": "bindingObject.getTable();", - "signature": "getTable()", - "restfulName": "Table", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "getText", - "returnType": "string", - "description": "Returns the text represented by the binding. Will throw an error if binding is not of the correct type.", - "syntax": "bindingObject.getText();", - "signature": "getText()", - "restfulName": "Text", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - } - ] +{ + "name": "Binding", + "description": "Represents an Office.js binding that is defined in the workbook.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "id", + "dataType": "string", + "description": "Represents binding identifier.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "type", + "dataType": "string", + "description": "Returns the type of the binding.", + "isReadOnly": true, + "enumNameJs": "Excel.BindingType", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "delete", + "returnType": "void", + "description": "Deletes the binding.", + "syntax": "bindingObject.delete();", + "signature": "delete()", + "restfulName": "delete", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.3" + }, + { + "name": "getRange", + "returnType": "Range", + "description": "Returns the range represented by the binding. Will throw an error if binding is not of the correct type.", + "syntax": "bindingObject.getRange();", + "signature": "getRange()", + "restfulName": "Range", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "getTable", + "returnType": "Table", + "description": "Returns the table represented by the binding. Will throw an error if binding is not of the correct type.", + "syntax": "bindingObject.getTable();", + "signature": "getTable()", + "restfulName": "Table", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "getText", + "returnType": "string", + "description": "Returns the text represented by the binding. Will throw an error if binding is not of the correct type.", + "syntax": "bindingObject.getText();", + "signature": "getText()", + "restfulName": "Text", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/bindingcollection.json b/scripts/jsonFiles/source/bindingcollection.json index f4510da..85b041f 100644 --- a/scripts/jsonFiles/source/bindingcollection.json +++ b/scripts/jsonFiles/source/bindingcollection.json @@ -1,237 +1,237 @@ -{ - "name": "BindingCollection", - "description": "Represents the collection of all the binding objects that are part of the workbook.", - "isCollection": true, - "collectionOf": "Binding", - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "count", - "dataType": "int", - "description": "Returns the number of bindings in the collection.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "items", - "dataType": "Binding[]", - "description": "A collection of binding objects.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getItem", - "returnType": "Binding", - "description": "Gets a binding object by ID.", - "syntax": "bindingCollectionObject.getItem(id);", - "signature": "getItem(id: string)", - "restfulName": "Item", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "id", - "dataType": "string", - "isCollection": false, - "description": "Id of the binding object to be retrieved.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getItemOrNullObject", - "returnType": "Binding", - "description": "Gets a binding object by ID. If the binding object does not exist, will return a null object.", - "syntax": "bindingCollectionObject.getItemOrNullObject(id);", - "signature": "getItemOrNullObject(id: string)", - "restfulName": "ItemOrNullObject", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "id", - "dataType": "string", - "isCollection": false, - "description": "Id of the binding object to be retrieved.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.4" - }, - { - "name": "getCount", - "returnType": "int", - "description": "Gets the number of bindings in the collection.", - "syntax": "bindingCollectionObject.getCount();", - "signature": "getCount()", - "restfulName": "Count", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.4" - }, - { - "name": "getItemAt", - "returnType": "Binding", - "description": "Gets a binding object based on its position in the items array.", - "syntax": "bindingCollectionObject.getItemAt(index);", - "signature": "getItemAt(index: number)", - "restfulName": "ItemAt", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "index", - "dataType": "number", - "isCollection": false, - "description": "Index value of the object to be retrieved. Zero-indexed.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "add", - "returnType": "Binding", - "description": "Add a new binding to a particular Range.", - "syntax": "bindingCollectionObject.add(range, bindingType, id);", - "signature": "add(range: Range or string, bindingType: string, id: string)", - "restfulName": "add", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "range", - "dataType": "Range or string", - "isCollection": false, - "description": "Range to bind the binding to. May be an Excel Range object, or a string. If string, must contain the full address, including the sheet name", - "isRequired": true, - "enumNameJs": null, - "notes": null - }, - { - "name": "bindingType", - "dataType": "string", - "isCollection": false, - "description": "Type of binding.", - "isRequired": true, - "enumNameJs": "Excel.BindingType", - "notes": null - }, - { - "name": "id", - "dataType": "string", - "isCollection": false, - "description": "Name of binding.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.3" - }, - { - "name": "addFromNamedItem", - "returnType": "Binding", - "description": "Add a new binding based on a named item in the workbook.", - "syntax": "bindingCollectionObject.addFromNamedItem(name, bindingType, id);", - "signature": "addFromNamedItem(name: string, bindingType: string, id: string)", - "restfulName": "addFromNamedItem", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "name", - "dataType": "string", - "isCollection": false, - "description": "Name from which to create binding.", - "isRequired": true, - "enumNameJs": null, - "notes": null - }, - { - "name": "bindingType", - "dataType": "string", - "isCollection": false, - "description": "Type of binding.", - "isRequired": true, - "enumNameJs": "Excel.BindingType", - "notes": null - }, - { - "name": "id", - "dataType": "string", - "isCollection": false, - "description": "Name of binding.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.3" - }, - { - "name": "addFromSelection", - "returnType": "Binding", - "description": "Add a new binding based on the current selection.", - "syntax": "bindingCollectionObject.addFromSelection(bindingType, id);", - "signature": "addFromSelection(bindingType: string, id: string)", - "restfulName": "addFromSelection", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "bindingType", - "dataType": "string", - "isCollection": false, - "description": "Type of binding.", - "isRequired": true, - "enumNameJs": "Excel.BindingType", - "notes": null - }, - { - "name": "id", - "dataType": "string", - "isCollection": false, - "description": "Name of binding.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.3" - } - ] +{ + "name": "BindingCollection", + "description": "Represents the collection of all the binding objects that are part of the workbook.", + "isCollection": true, + "collectionOf": "Binding", + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "count", + "dataType": "int", + "description": "Returns the number of bindings in the collection.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "items", + "dataType": "Binding[]", + "description": "A collection of binding objects.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getItem", + "returnType": "Binding", + "description": "Gets a binding object by ID.", + "syntax": "bindingCollectionObject.getItem(id);", + "signature": "getItem(id: string)", + "restfulName": "Item", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "id", + "dataType": "string", + "isCollection": false, + "description": "Id of the binding object to be retrieved.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getItemOrNullObject", + "returnType": "Binding", + "description": "Gets a binding object by ID. If the binding object does not exist, will return a null object.", + "syntax": "bindingCollectionObject.getItemOrNullObject(id);", + "signature": "getItemOrNullObject(id: string)", + "restfulName": "ItemOrNullObject", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "id", + "dataType": "string", + "isCollection": false, + "description": "Id of the binding object to be retrieved.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.4" + }, + { + "name": "getCount", + "returnType": "int", + "description": "Gets the number of bindings in the collection.", + "syntax": "bindingCollectionObject.getCount();", + "signature": "getCount()", + "restfulName": "Count", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.4" + }, + { + "name": "getItemAt", + "returnType": "Binding", + "description": "Gets a binding object based on its position in the items array.", + "syntax": "bindingCollectionObject.getItemAt(index);", + "signature": "getItemAt(index: number)", + "restfulName": "ItemAt", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "index", + "dataType": "number", + "isCollection": false, + "description": "Index value of the object to be retrieved. Zero-indexed.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "add", + "returnType": "Binding", + "description": "Add a new binding to a particular Range.", + "syntax": "bindingCollectionObject.add(range, bindingType, id);", + "signature": "add(range: Range or string, bindingType: string, id: string)", + "restfulName": "add", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "range", + "dataType": "Range or string", + "isCollection": false, + "description": "Range to bind the binding to. May be an Excel Range object, or a string. If string, must contain the full address, including the sheet name", + "isRequired": true, + "enumNameJs": null, + "notes": null + }, + { + "name": "bindingType", + "dataType": "string", + "isCollection": false, + "description": "Type of binding.", + "isRequired": true, + "enumNameJs": "Excel.BindingType", + "notes": null + }, + { + "name": "id", + "dataType": "string", + "isCollection": false, + "description": "Name of binding.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.3" + }, + { + "name": "addFromNamedItem", + "returnType": "Binding", + "description": "Add a new binding based on a named item in the workbook.", + "syntax": "bindingCollectionObject.addFromNamedItem(name, bindingType, id);", + "signature": "addFromNamedItem(name: string, bindingType: string, id: string)", + "restfulName": "addFromNamedItem", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "name", + "dataType": "string", + "isCollection": false, + "description": "Name from which to create binding.", + "isRequired": true, + "enumNameJs": null, + "notes": null + }, + { + "name": "bindingType", + "dataType": "string", + "isCollection": false, + "description": "Type of binding.", + "isRequired": true, + "enumNameJs": "Excel.BindingType", + "notes": null + }, + { + "name": "id", + "dataType": "string", + "isCollection": false, + "description": "Name of binding.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.3" + }, + { + "name": "addFromSelection", + "returnType": "Binding", + "description": "Add a new binding based on the current selection.", + "syntax": "bindingCollectionObject.addFromSelection(bindingType, id);", + "signature": "addFromSelection(bindingType: string, id: string)", + "restfulName": "addFromSelection", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "bindingType", + "dataType": "string", + "isCollection": false, + "description": "Type of binding.", + "isRequired": true, + "enumNameJs": "Excel.BindingType", + "notes": null + }, + { + "name": "id", + "dataType": "string", + "isCollection": false, + "description": "Name of binding.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.3" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/bindingdatachangedeventargs.json b/scripts/jsonFiles/source/bindingdatachangedeventargs.json index d2aebe6..7beecb9 100644 --- a/scripts/jsonFiles/source/bindingdatachangedeventargs.json +++ b/scripts/jsonFiles/source/bindingdatachangedeventargs.json @@ -1,35 +1,35 @@ -{ - "name": "BindingDataChangedEventArgs", - "description": "Provides information about the binding that raised the DataChanged event.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "binding", - "dataType": "Binding", - "description": "Gets the Binding object that represents the binding that raised the DataChanged event.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "BindingDataChangedEventArgs", + "description": "Provides information about the binding that raised the DataChanged event.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "binding", + "dataType": "Binding", + "description": "Gets the Binding object that represents the binding that raised the DataChanged event.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/bindingselectionchangedeventargs.json b/scripts/jsonFiles/source/bindingselectionchangedeventargs.json index b327464..fefb767 100644 --- a/scripts/jsonFiles/source/bindingselectionchangedeventargs.json +++ b/scripts/jsonFiles/source/bindingselectionchangedeventargs.json @@ -1,83 +1,83 @@ -{ - "name": "BindingSelectionChangedEventArgs", - "description": "Provides information about the binding that raised the SelectionChanged event.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "binding", - "dataType": "Binding", - "description": "Gets the Binding object that represents the binding that raised the SelectionChanged event.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "startRow", - "dataType": "int", - "description": "Gets the index of the first row of the selection (zero-based).", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "startColumn", - "dataType": "int", - "description": "Gets the index of the first column of the selection (zero-based).", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "rowCount", - "dataType": "int", - "description": "Gets the number of rows selected.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "columnCount", - "dataType": "int", - "description": "Gets the number of columns selected.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "BindingSelectionChangedEventArgs", + "description": "Provides information about the binding that raised the SelectionChanged event.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "binding", + "dataType": "Binding", + "description": "Gets the Binding object that represents the binding that raised the SelectionChanged event.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "startRow", + "dataType": "int", + "description": "Gets the index of the first row of the selection (zero-based).", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "startColumn", + "dataType": "int", + "description": "Gets the index of the first column of the selection (zero-based).", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "rowCount", + "dataType": "int", + "description": "Gets the number of rows selected.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "columnCount", + "dataType": "int", + "description": "Gets the number of columns selected.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/cellvalueconditionalformat.json b/scripts/jsonFiles/source/cellvalueconditionalformat.json index df3a83d..2b123a1 100644 --- a/scripts/jsonFiles/source/cellvalueconditionalformat.json +++ b/scripts/jsonFiles/source/cellvalueconditionalformat.json @@ -1,47 +1,47 @@ -{ - "name": "CellValueConditionalFormat", - "description": "Represents a cell value conditional format.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "rule", - "dataType": "ConditionalCellValueRule", - "description": "Represents the Rule object on this conditional format.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "format", - "dataType": "ConditionalRangeFormat", - "description": "Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "CellValueConditionalFormat", + "description": "Represents a cell value conditional format.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "rule", + "dataType": "ConditionalCellValueRule", + "description": "Represents the Rule object on this conditional format.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "format", + "dataType": "ConditionalRangeFormat", + "description": "Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/chart.json b/scripts/jsonFiles/source/chart.json index 1b5ff19..5e4a762 100644 --- a/scripts/jsonFiles/source/chart.json +++ b/scripts/jsonFiles/source/chart.json @@ -1,294 +1,294 @@ -{ - "name": "Chart", - "description": "Represents a chart object in a workbook.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "id", - "dataType": "string", - "description": "Gets a chart based on its position in the collection.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "axes", - "dataType": "ChartAxes", - "description": "Represents chart axes.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "dataLabels", - "dataType": "ChartDataLabels", - "description": "Represents the datalabels on the chart.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "height", - "dataType": "double", - "description": "Represents the height, in points, of the chart object.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "left", - "dataType": "double", - "description": "The distance, in points, from the left side of the chart to the worksheet origin.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "legend", - "dataType": "ChartLegend", - "description": "Represents the legend for the chart.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "name", - "dataType": "string", - "description": "Represents the name of a chart object.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "series", - "dataType": "ChartSeriesCollection", - "description": "Represents either a single series or collection of series in the chart.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "title", - "dataType": "ChartTitle", - "description": "Represents the title of the specified chart, including the text, visibility, position and formating of the title.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "top", - "dataType": "double", - "description": "Represents 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).", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "width", - "dataType": "double", - "description": "Represents the width, in points, of the chart object.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "format", - "dataType": "ChartAreaFormat", - "description": "Encapsulates the format properties for the chart area.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "worksheet", - "dataType": "Worksheet", - "description": "The worksheet containing the current chart.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.2", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "delete", - "returnType": "void", - "description": "Deletes the chart object.", - "syntax": "chartObject.delete();", - "signature": "delete()", - "restfulName": "delete", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "setData", - "returnType": "void", - "description": "Resets the source data for the chart.", - "syntax": "chartObject.setData(sourceData, seriesBy);", - "signature": "setData(sourceData: object, seriesBy: string)", - "restfulName": "setData", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "sourceData", - "dataType": "object", - "isCollection": false, - "description": "The Range object corresponding to the source data.", - "isRequired": true, - "enumNameJs": null, - "notes": null - }, - { - "name": "seriesBy", - "dataType": "string", - "isCollection": false, - "description": "Specifies the way columns or rows are used as data series on the chart. Can be one of the following: Auto (default), Rows, Columns.", - "isRequired": false, - "enumNameJs": "Excel.ChartSeriesBy", - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "setPosition", - "returnType": "void", - "description": "Positions the chart relative to cells on the worksheet.", - "syntax": "chartObject.setPosition(startCell, endCell);", - "signature": "setPosition(startCell: object, endCell: object)", - "restfulName": "setPosition", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "startCell", - "dataType": "object", - "isCollection": false, - "description": "The start cell. This is where the chart will be moved to. The start cell is the top-left or top-right cell, depending on the user's right-to-left display settings.", - "isRequired": true, - "enumNameJs": null, - "notes": null - }, - { - "name": "endCell", - "dataType": "object", - "isCollection": false, - "description": "(Optional) The end cell. If specified, the chart's width and height will be set to fully cover up this cell/range.", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getImage", - "returnType": "System.IO.Stream", - "description": "Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions.", - "syntax": "chartObject.getImage(height, width, fittingMode);", - "signature": "getImage(height: number, width: number, fittingMode: string)", - "restfulName": "Image", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "height", - "dataType": "number", - "isCollection": false, - "description": "(Optional) The desired height of the resulting image.", - "isRequired": false, - "enumNameJs": null, - "notes": null - }, - { - "name": "width", - "dataType": "number", - "isCollection": false, - "description": "(Optional) The desired width of the resulting image.", - "isRequired": false, - "enumNameJs": null, - "notes": null - }, - { - "name": "fittingMode", - "dataType": "string", - "isCollection": false, - "description": "(Optional) The method used to scale the chart to the specified to the specified dimensions (if both height and width are set).\"", - "isRequired": false, - "enumNameJs": "Excel.ImageFittingMode", - "notes": null - } - ], - "reqSet": "1.2" - } - ] +{ + "name": "Chart", + "description": "Represents a chart object in a workbook.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "id", + "dataType": "string", + "description": "Gets a chart based on its position in the collection.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "axes", + "dataType": "ChartAxes", + "description": "Represents chart axes.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "dataLabels", + "dataType": "ChartDataLabels", + "description": "Represents the datalabels on the chart.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "height", + "dataType": "double", + "description": "Represents the height, in points, of the chart object.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "left", + "dataType": "double", + "description": "The distance, in points, from the left side of the chart to the worksheet origin.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "legend", + "dataType": "ChartLegend", + "description": "Represents the legend for the chart.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "name", + "dataType": "string", + "description": "Represents the name of a chart object.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "series", + "dataType": "ChartSeriesCollection", + "description": "Represents either a single series or collection of series in the chart.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "title", + "dataType": "ChartTitle", + "description": "Represents the title of the specified chart, including the text, visibility, position and formating of the title.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "top", + "dataType": "double", + "description": "Represents 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).", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "width", + "dataType": "double", + "description": "Represents the width, in points, of the chart object.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "format", + "dataType": "ChartAreaFormat", + "description": "Encapsulates the format properties for the chart area.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "worksheet", + "dataType": "Worksheet", + "description": "The worksheet containing the current chart.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.2", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "delete", + "returnType": "void", + "description": "Deletes the chart object.", + "syntax": "chartObject.delete();", + "signature": "delete()", + "restfulName": "delete", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "setData", + "returnType": "void", + "description": "Resets the source data for the chart.", + "syntax": "chartObject.setData(sourceData, seriesBy);", + "signature": "setData(sourceData: object, seriesBy: string)", + "restfulName": "setData", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "sourceData", + "dataType": "object", + "isCollection": false, + "description": "The Range object corresponding to the source data.", + "isRequired": true, + "enumNameJs": null, + "notes": null + }, + { + "name": "seriesBy", + "dataType": "string", + "isCollection": false, + "description": "Specifies the way columns or rows are used as data series on the chart. Can be one of the following: Auto (default), Rows, Columns.", + "isRequired": false, + "enumNameJs": "Excel.ChartSeriesBy", + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "setPosition", + "returnType": "void", + "description": "Positions the chart relative to cells on the worksheet.", + "syntax": "chartObject.setPosition(startCell, endCell);", + "signature": "setPosition(startCell: object, endCell: object)", + "restfulName": "setPosition", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "startCell", + "dataType": "object", + "isCollection": false, + "description": "The start cell. This is where the chart will be moved to. The start cell is the top-left or top-right cell, depending on the user's right-to-left display settings.", + "isRequired": true, + "enumNameJs": null, + "notes": null + }, + { + "name": "endCell", + "dataType": "object", + "isCollection": false, + "description": "(Optional) The end cell. If specified, the chart's width and height will be set to fully cover up this cell/range.", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getImage", + "returnType": "System.IO.Stream", + "description": "Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions.", + "syntax": "chartObject.getImage(height, width, fittingMode);", + "signature": "getImage(height: number, width: number, fittingMode: string)", + "restfulName": "Image", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "height", + "dataType": "number", + "isCollection": false, + "description": "(Optional) The desired height of the resulting image.", + "isRequired": false, + "enumNameJs": null, + "notes": null + }, + { + "name": "width", + "dataType": "number", + "isCollection": false, + "description": "(Optional) The desired width of the resulting image.", + "isRequired": false, + "enumNameJs": null, + "notes": null + }, + { + "name": "fittingMode", + "dataType": "string", + "isCollection": false, + "description": "(Optional) The method used to scale the chart to the specified to the specified dimensions (if both height and width are set).\"", + "isRequired": false, + "enumNameJs": "Excel.ImageFittingMode", + "notes": null + } + ], + "reqSet": "1.2" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartareaformat.json b/scripts/jsonFiles/source/chartareaformat.json index e62cb13..7b19172 100644 --- a/scripts/jsonFiles/source/chartareaformat.json +++ b/scripts/jsonFiles/source/chartareaformat.json @@ -1,47 +1,47 @@ -{ - "name": "ChartAreaFormat", - "description": "Encapsulates the format properties for the overall chart area.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "fill", - "dataType": "ChartFill", - "description": "Represents the fill format of an object, which includes background formatting information.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "font", - "dataType": "ChartFont", - "description": "Represents the font attributes (font name, font size, color, etc.) for the current object.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ChartAreaFormat", + "description": "Encapsulates the format properties for the overall chart area.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "fill", + "dataType": "ChartFill", + "description": "Represents the fill format of an object, which includes background formatting information.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "font", + "dataType": "ChartFont", + "description": "Represents the font attributes (font name, font size, color, etc.) for the current object.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartaxes.json b/scripts/jsonFiles/source/chartaxes.json index 48f79ef..8236ec9 100644 --- a/scripts/jsonFiles/source/chartaxes.json +++ b/scripts/jsonFiles/source/chartaxes.json @@ -1,59 +1,59 @@ -{ - "name": "ChartAxes", - "description": "Represents the chart axes.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "categoryAxis", - "dataType": "ChartAxis", - "description": "Represents the category axis in a chart.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "seriesAxis", - "dataType": "ChartAxis", - "description": "Represents the series axis of a 3-dimensional chart.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "valueAxis", - "dataType": "ChartAxis", - "description": "Represents the value axis in an axis.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ChartAxes", + "description": "Represents the chart axes.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "categoryAxis", + "dataType": "ChartAxis", + "description": "Represents the category axis in a chart.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "seriesAxis", + "dataType": "ChartAxis", + "description": "Represents the series axis of a 3-dimensional chart.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "valueAxis", + "dataType": "ChartAxis", + "description": "Represents the value axis in an axis.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartaxis.json b/scripts/jsonFiles/source/chartaxis.json index 34dc71a..b09b6f2 100644 --- a/scripts/jsonFiles/source/chartaxis.json +++ b/scripts/jsonFiles/source/chartaxis.json @@ -1,119 +1,227 @@ -{ - "name": "ChartAxis", - "description": "Represents a single axis in a chart.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "format", - "dataType": "ChartAxisFormat", - "description": "Represents the formatting of a chart object, which includes line and font formatting.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "majorGridlines", - "dataType": "ChartGridlines", - "description": "Returns a gridlines object that represents the major gridlines for the specified axis.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "majorUnit", - "dataType": "object", - "description": "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.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "maximum", - "dataType": "object", - "description": "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.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "minimum", - "dataType": "object", - "description": "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.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "minorGridlines", - "dataType": "ChartGridlines", - "description": "Returns a Gridlines object that represents the minor gridlines for the specified axis.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "minorUnit", - "dataType": "object", - "description": "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.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "title", - "dataType": "ChartAxisTitle", - "description": "Represents the axis title.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ChartAxis", + "description": "Represents a single axis in a chart.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "format", + "dataType": "ChartAxisFormat", + "description": "Represents the formatting of a chart object, which includes line and font formatting.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "majorGridlines", + "dataType": "ChartGridlines", + "description": "Returns a gridlines object that represents the major gridlines for the specified axis.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "majorUnit", + "dataType": "object", + "description": "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.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "maximum", + "dataType": "object", + "description": "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.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "minimum", + "dataType": "object", + "description": "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.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "minorGridlines", + "dataType": "ChartGridlines", + "description": "Returns a Gridlines object that represents the minor gridlines for the specified axis.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "minorUnit", + "dataType": "object", + "description": "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.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "title", + "dataType": "ChartAxisTitle", + "description": "Represents the axis title.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "displayUnit", + "dataType": "string", + "description": "Represents the axis display unit.", + "isReadOnly": false, + "enumNameJs": "Excel.ChartAxisDisplayUnit", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.9", + "isKey": null, + "notes": null + }, + { + "name": "showDisplayUnitLabel", + "dataType": "bool", + "description": "Represents whether the axis display unit label is visible.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.9", + "isKey": null, + "notes": null + }, + { + "name": "customDisplayUnit", + "dataType": "double", + "description": "Represents the custom axis display unit value.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.9", + "isKey": null, + "notes": null + }, + { + "name": "type", + "dataType": "string", + "description": "Represents the axis type.", + "isReadOnly": true, + "enumNameJs": "Excel.AxisType", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.9", + "isKey": null, + "notes": null + }, + { + "name": "majorUnitScale", + "dataType": "string", + "description": "Returns or sets the major unit scale value for the category axis when the CategoryType property is set to TimeScale.", + "isReadOnly": false, + "enumNameJs": "Excel.XlTimeUnit", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.9", + "isKey": null, + "notes": null + }, + { + "name": "minorUnitScale", + "dataType": "string", + "description": "Returns or sets the minor unit scale value for the category axis when the CategoryType property is set to TimeScale.", + "isReadOnly": false, + "enumNameJs": "Excel.XlTimeUnit", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.9", + "isKey": null, + "notes": null + }, + { + "name": "baseUnit", + "dataType": "string", + "description": "Returns or sets the base unit for the specified category axis.", + "isReadOnly": false, + "enumNameJs": "Excel.XlTimeUnit", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.9", + "isKey": null, + "notes": null + }, + { + "name": "categoryNames", + "dataType": "string", + "description": "Returns or sets all the category names for the specified axis, as a text array.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.9", + "isKey": null, + "notes": null + }, + { + "name": "categoryType", + "dataType": "string", + "description": "Returns or sets the category axis type.", + "isReadOnly": false, + "enumNameJs": "Excel.XlCategoryType", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.9", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartaxisformat.json b/scripts/jsonFiles/source/chartaxisformat.json index 6f61822..f8796d7 100644 --- a/scripts/jsonFiles/source/chartaxisformat.json +++ b/scripts/jsonFiles/source/chartaxisformat.json @@ -1,47 +1,47 @@ -{ - "name": "ChartAxisFormat", - "description": "Encapsulates the format properties for the chart axis.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "font", - "dataType": "ChartFont", - "description": "Represents the font attributes (font name, font size, color, etc.) for a chart axis element.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "line", - "dataType": "ChartLineFormat", - "description": "Represents chart line formatting.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ChartAxisFormat", + "description": "Encapsulates the format properties for the chart axis.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "font", + "dataType": "ChartFont", + "description": "Represents the font attributes (font name, font size, color, etc.) for a chart axis element.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "line", + "dataType": "ChartLineFormat", + "description": "Represents chart line formatting.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartaxistitle.json b/scripts/jsonFiles/source/chartaxistitle.json index 6e1e297..ebd4e52 100644 --- a/scripts/jsonFiles/source/chartaxistitle.json +++ b/scripts/jsonFiles/source/chartaxistitle.json @@ -1,59 +1,59 @@ -{ - "name": "ChartAxisTitle", - "description": "Represents the title of a chart axis.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "format", - "dataType": "ChartAxisTitleFormat", - "description": "Represents the formatting of chart axis title.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "text", - "dataType": "string", - "description": "Represents the axis title.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "visible", - "dataType": "bool", - "description": "A boolean that specifies the visibility of an axis title.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ChartAxisTitle", + "description": "Represents the title of a chart axis.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "format", + "dataType": "ChartAxisTitleFormat", + "description": "Represents the formatting of chart axis title.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "text", + "dataType": "string", + "description": "Represents the axis title.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "visible", + "dataType": "bool", + "description": "A boolean that specifies the visibility of an axis title.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartaxistitleformat.json b/scripts/jsonFiles/source/chartaxistitleformat.json index 66520bb..072d341 100644 --- a/scripts/jsonFiles/source/chartaxistitleformat.json +++ b/scripts/jsonFiles/source/chartaxistitleformat.json @@ -1,35 +1,35 @@ -{ - "name": "ChartAxisTitleFormat", - "description": "Represents the chart axis title formatting.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "font", - "dataType": "ChartFont", - "description": "Represents the font attributes, such as font name, font size, color, etc. of chart axis title object.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ChartAxisTitleFormat", + "description": "Represents the chart axis title formatting.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "font", + "dataType": "ChartFont", + "description": "Represents the font attributes, such as font name, font size, color, etc. of chart axis title object.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartborder.json b/scripts/jsonFiles/source/chartborder.json new file mode 100644 index 0000000..95aef8e --- /dev/null +++ b/scripts/jsonFiles/source/chartborder.json @@ -0,0 +1,57 @@ +{ + "name": "ChartBorder", + "description": "Represents the border formatting for a chart element.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.9", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": null, + "methods": [ + { + "name": "clear", + "returnType": "void", + "description": "Clear the border color of a chart element.", + "syntax": "chartBorderObject.clear();", + "signature": "clear()", + "restfulName": "clear", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.9" + }, + { + "name": "setSolidColor", + "returnType": "void", + "description": "Sets the border formatting of a chart element to a uniform color.", + "syntax": "chartBorderObject.setSolidColor(color);", + "signature": "setSolidColor(color: string)", + "restfulName": "setSolidColor", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "color", + "dataType": "string", + "isCollection": false, + "description": "HTML color code representing the color of the border line, of the form #RRGGBB (e.g. \"FFA500\") or as a named HTML color (e.g. \"orange\").", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.9" + } + ] +} \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartcollection.json b/scripts/jsonFiles/source/chartcollection.json index 6eb647d..0509392 100644 --- a/scripts/jsonFiles/source/chartcollection.json +++ b/scripts/jsonFiles/source/chartcollection.json @@ -1,166 +1,166 @@ -{ - "name": "ChartCollection", - "description": "A collection of all the chart objects on a worksheet.", - "isCollection": true, - "collectionOf": "Chart", - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "count", - "dataType": "int", - "description": "Returns the number of charts in the worksheet.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "items", - "dataType": "Chart[]", - "description": "A collection of chart objects.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getItem", - "returnType": "Chart", - "description": "Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned.", - "syntax": "chartCollectionObject.getItem(name);", - "signature": "getItem(name: string)", - "restfulName": "Item", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "name", - "dataType": "string", - "isCollection": false, - "description": "Name of the chart to be retrieved.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getItemOrNullObject", - "returnType": "Chart", - "description": "Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned.", - "syntax": "chartCollectionObject.getItemOrNullObject(name);", - "signature": "getItemOrNullObject(name: string)", - "restfulName": "ItemOrNullObject", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "name", - "dataType": "string", - "isCollection": false, - "description": "Name of the chart to be retrieved.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.4" - }, - { - "name": "add", - "returnType": "Chart", - "description": "Creates a new chart.", - "syntax": "chartCollectionObject.add(type, sourceData, seriesBy);", - "signature": "add(type: string, sourceData: object, seriesBy: string)", - "restfulName": "add", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "type", - "dataType": "string", - "isCollection": false, - "description": "Represents the type of a chart.", - "isRequired": true, - "enumNameJs": "Excel.ChartType", - "notes": null - }, - { - "name": "sourceData", - "dataType": "object", - "isCollection": false, - "description": "The Range object corresponding to the source data.", - "isRequired": true, - "enumNameJs": null, - "notes": null - }, - { - "name": "seriesBy", - "dataType": "string", - "isCollection": false, - "description": "Specifies the way columns or rows are used as data series on the chart.", - "isRequired": false, - "enumNameJs": "Excel.ChartSeriesBy", - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getCount", - "returnType": "int", - "description": "Returns the number of charts in the worksheet.", - "syntax": "chartCollectionObject.getCount();", - "signature": "getCount()", - "restfulName": "Count", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.4" - }, - { - "name": "getItemAt", - "returnType": "Chart", - "description": "Gets a chart based on its position in the collection.", - "syntax": "chartCollectionObject.getItemAt(index);", - "signature": "getItemAt(index: number)", - "restfulName": "ItemAt", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "index", - "dataType": "number", - "isCollection": false, - "description": "Index value of the object to be retrieved. Zero-indexed.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - } - ] +{ + "name": "ChartCollection", + "description": "A collection of all the chart objects on a worksheet.", + "isCollection": true, + "collectionOf": "Chart", + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "count", + "dataType": "int", + "description": "Returns the number of charts in the worksheet.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "items", + "dataType": "Chart[]", + "description": "A collection of chart objects.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getItem", + "returnType": "Chart", + "description": "Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned.", + "syntax": "chartCollectionObject.getItem(name);", + "signature": "getItem(name: string)", + "restfulName": "Item", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "name", + "dataType": "string", + "isCollection": false, + "description": "Name of the chart to be retrieved.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getItemOrNullObject", + "returnType": "Chart", + "description": "Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned.", + "syntax": "chartCollectionObject.getItemOrNullObject(name);", + "signature": "getItemOrNullObject(name: string)", + "restfulName": "ItemOrNullObject", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "name", + "dataType": "string", + "isCollection": false, + "description": "Name of the chart to be retrieved.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.4" + }, + { + "name": "add", + "returnType": "Chart", + "description": "Creates a new chart.", + "syntax": "chartCollectionObject.add(type, sourceData, seriesBy);", + "signature": "add(type: string, sourceData: object, seriesBy: string)", + "restfulName": "add", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "type", + "dataType": "string", + "isCollection": false, + "description": "Represents the type of a chart.", + "isRequired": true, + "enumNameJs": "Excel.ChartType", + "notes": null + }, + { + "name": "sourceData", + "dataType": "object", + "isCollection": false, + "description": "The Range object corresponding to the source data.", + "isRequired": true, + "enumNameJs": null, + "notes": null + }, + { + "name": "seriesBy", + "dataType": "string", + "isCollection": false, + "description": "Specifies the way columns or rows are used as data series on the chart.", + "isRequired": false, + "enumNameJs": "Excel.ChartSeriesBy", + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getCount", + "returnType": "int", + "description": "Returns the number of charts in the worksheet.", + "syntax": "chartCollectionObject.getCount();", + "signature": "getCount()", + "restfulName": "Count", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.4" + }, + { + "name": "getItemAt", + "returnType": "Chart", + "description": "Gets a chart based on its position in the collection.", + "syntax": "chartCollectionObject.getItemAt(index);", + "signature": "getItemAt(index: number)", + "restfulName": "ItemAt", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "index", + "dataType": "number", + "isCollection": false, + "description": "Index value of the object to be retrieved. Zero-indexed.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartdatalabelformat.json b/scripts/jsonFiles/source/chartdatalabelformat.json index 9a590c4..909c301 100644 --- a/scripts/jsonFiles/source/chartdatalabelformat.json +++ b/scripts/jsonFiles/source/chartdatalabelformat.json @@ -1,47 +1,47 @@ -{ - "name": "ChartDataLabelFormat", - "description": "Encapsulates the format properties for the chart data labels.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "font", - "dataType": "ChartFont", - "description": "Represents the font attributes (font name, font size, color, etc.) for a chart data label.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "fill", - "dataType": "ChartFill", - "description": "Represents the fill format of the current chart data label.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ChartDataLabelFormat", + "description": "Encapsulates the format properties for the chart data labels.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "font", + "dataType": "ChartFont", + "description": "Represents the font attributes (font name, font size, color, etc.) for a chart data label.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "fill", + "dataType": "ChartFill", + "description": "Represents the fill format of the current chart data label.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartdatalabels.json b/scripts/jsonFiles/source/chartdatalabels.json index 7da7927..314daa1 100644 --- a/scripts/jsonFiles/source/chartdatalabels.json +++ b/scripts/jsonFiles/source/chartdatalabels.json @@ -1,131 +1,131 @@ -{ - "name": "ChartDataLabels", - "description": "Represents a collection of all the data labels on a chart point.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "format", - "dataType": "ChartDataLabelFormat", - "description": "Represents the format of chart data labels, which includes fill and font formatting.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "position", - "dataType": "string", - "description": "DataLabelPosition value that represents the position of the data label.", - "isReadOnly": false, - "enumNameJs": "Excel.ChartDataLabelPosition", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "showValue", - "dataType": "bool", - "description": "Boolean value representing if the data label value is visible or not.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "showSeriesName", - "dataType": "bool", - "description": "Boolean value representing if the data label series name is visible or not.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "showCategoryName", - "dataType": "bool", - "description": "Boolean value representing if the data label category name is visible or not.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "showLegendKey", - "dataType": "bool", - "description": "Boolean value representing if the data label legend key is visible or not.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "showPercentage", - "dataType": "bool", - "description": "Boolean value representing if the data label percentage is visible or not.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "showBubbleSize", - "dataType": "bool", - "description": "Boolean value representing if the data label bubble size is visible or not.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "separator", - "dataType": "string", - "description": "String representing the separator used for the data labels on a chart.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ChartDataLabels", + "description": "Represents a collection of all the data labels on a chart point.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "format", + "dataType": "ChartDataLabelFormat", + "description": "Represents the format of chart data labels, which includes fill and font formatting.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "position", + "dataType": "string", + "description": "DataLabelPosition value that represents the position of the data label.", + "isReadOnly": false, + "enumNameJs": "Excel.ChartDataLabelPosition", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "showValue", + "dataType": "bool", + "description": "Boolean value representing if the data label value is visible or not.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "showSeriesName", + "dataType": "bool", + "description": "Boolean value representing if the data label series name is visible or not.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "showCategoryName", + "dataType": "bool", + "description": "Boolean value representing if the data label category name is visible or not.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "showLegendKey", + "dataType": "bool", + "description": "Boolean value representing if the data label legend key is visible or not.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "showPercentage", + "dataType": "bool", + "description": "Boolean value representing if the data label percentage is visible or not.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "showBubbleSize", + "dataType": "bool", + "description": "Boolean value representing if the data label bubble size is visible or not.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "separator", + "dataType": "string", + "description": "String representing the separator used for the data labels on a chart.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartfill.json b/scripts/jsonFiles/source/chartfill.json index ce8d830..42ebde9 100644 --- a/scripts/jsonFiles/source/chartfill.json +++ b/scripts/jsonFiles/source/chartfill.json @@ -1,57 +1,57 @@ -{ - "name": "ChartFill", - "description": "Represents the fill formatting for a chart element.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": null, - "methods": [ - { - "name": "clear", - "returnType": "void", - "description": "Clear the fill color of a chart element.", - "syntax": "chartFillObject.clear();", - "signature": "clear()", - "restfulName": "clear", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "setSolidColor", - "returnType": "void", - "description": "Sets the fill formatting of a chart element to a uniform color.", - "syntax": "chartFillObject.setSolidColor(color);", - "signature": "setSolidColor(color: string)", - "restfulName": "setSolidColor", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "color", - "dataType": "string", - "isCollection": false, - "description": "HTML color code representing the color of the border line, of the form #RRGGBB (e.g. \"FFA500\") or as a named HTML color (e.g. \"orange\").", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - } - ] +{ + "name": "ChartFill", + "description": "Represents the fill formatting for a chart element.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": null, + "methods": [ + { + "name": "clear", + "returnType": "void", + "description": "Clear the fill color of a chart element.", + "syntax": "chartFillObject.clear();", + "signature": "clear()", + "restfulName": "clear", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "setSolidColor", + "returnType": "void", + "description": "Sets the fill formatting of a chart element to a uniform color.", + "syntax": "chartFillObject.setSolidColor(color);", + "signature": "setSolidColor(color: string)", + "restfulName": "setSolidColor", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "color", + "dataType": "string", + "isCollection": false, + "description": "HTML color code representing the color of the border line, of the form #RRGGBB (e.g. \"FFA500\") or as a named HTML color (e.g. \"orange\").", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartfont.json b/scripts/jsonFiles/source/chartfont.json index 2b837e0..5a614fd 100644 --- a/scripts/jsonFiles/source/chartfont.json +++ b/scripts/jsonFiles/source/chartfont.json @@ -1,95 +1,95 @@ -{ - "name": "ChartFont", - "description": "This object represents the font attributes (font name, font size, color, etc.) for a chart object.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "bold", - "dataType": "bool", - "description": "Represents the bold status of font.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "color", - "dataType": "string", - "description": "HTML color code representation of the text color. E.g. #FF0000 represents Red.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "italic", - "dataType": "bool", - "description": "Represents the italic status of the font.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "name", - "dataType": "string", - "description": "Font name (e.g. \"Calibri\")", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "size", - "dataType": "double", - "description": "Size of the font (e.g. 11)", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "underline", - "dataType": "string", - "description": "Type of underline applied to the font.", - "isReadOnly": false, - "enumNameJs": "Excel.ChartUnderlineStyle", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ChartFont", + "description": "This object represents the font attributes (font name, font size, color, etc.) for a chart object.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "bold", + "dataType": "bool", + "description": "Represents the bold status of font.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "color", + "dataType": "string", + "description": "HTML color code representation of the text color. E.g. #FF0000 represents Red.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "italic", + "dataType": "bool", + "description": "Represents the italic status of the font.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "name", + "dataType": "string", + "description": "Font name (e.g. \"Calibri\")", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "size", + "dataType": "double", + "description": "Size of the font (e.g. 11)", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "underline", + "dataType": "string", + "description": "Type of underline applied to the font.", + "isReadOnly": false, + "enumNameJs": "Excel.ChartUnderlineStyle", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartformatstring.json b/scripts/jsonFiles/source/chartformatstring.json new file mode 100644 index 0000000..d5a609d --- /dev/null +++ b/scripts/jsonFiles/source/chartformatstring.json @@ -0,0 +1,35 @@ +{ + "name": "ChartFormatString", + "description": "Represents the characters in chart object like chart title, chart axis title, etc.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.9", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "font", + "dataType": "ChartFont", + "description": "Represents the font attributes, such as font name, font size, color, etc. of chart characters object.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.9", + "isKey": null, + "notes": null + } + ], + "methods": null +} \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartgridlines.json b/scripts/jsonFiles/source/chartgridlines.json index 499f154..a13fb46 100644 --- a/scripts/jsonFiles/source/chartgridlines.json +++ b/scripts/jsonFiles/source/chartgridlines.json @@ -1,47 +1,47 @@ -{ - "name": "ChartGridlines", - "description": "Represents major or minor gridlines on a chart axis.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "visible", - "dataType": "bool", - "description": "Boolean value representing if the axis gridlines are visible or not.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "format", - "dataType": "ChartGridlinesFormat", - "description": "Represents the formatting of chart gridlines.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ChartGridlines", + "description": "Represents major or minor gridlines on a chart axis.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "visible", + "dataType": "bool", + "description": "Boolean value representing if the axis gridlines are visible or not.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "format", + "dataType": "ChartGridlinesFormat", + "description": "Represents the formatting of chart gridlines.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartgridlinesformat.json b/scripts/jsonFiles/source/chartgridlinesformat.json index 0f3301d..8982e37 100644 --- a/scripts/jsonFiles/source/chartgridlinesformat.json +++ b/scripts/jsonFiles/source/chartgridlinesformat.json @@ -1,35 +1,35 @@ -{ - "name": "ChartGridlinesFormat", - "description": "Encapsulates the format properties for chart gridlines.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "line", - "dataType": "ChartLineFormat", - "description": "Represents chart line formatting.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ChartGridlinesFormat", + "description": "Encapsulates the format properties for chart gridlines.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "line", + "dataType": "ChartLineFormat", + "description": "Represents chart line formatting.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartlegend.json b/scripts/jsonFiles/source/chartlegend.json index a19b6b1..deade35 100644 --- a/scripts/jsonFiles/source/chartlegend.json +++ b/scripts/jsonFiles/source/chartlegend.json @@ -1,71 +1,71 @@ -{ - "name": "ChartLegend", - "description": "Represents the legend in a chart.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "format", - "dataType": "ChartLegendFormat", - "description": "Represents the formatting of a chart legend, which includes fill and font formatting.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "visible", - "dataType": "bool", - "description": "A boolean value the represents the visibility of a ChartLegend object.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "position", - "dataType": "string", - "description": "Represents the position of the legend on the chart.", - "isReadOnly": false, - "enumNameJs": "Excel.ChartLegendPosition", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "overlay", - "dataType": "bool", - "description": "Boolean value for whether the chart legend should overlap with the main body of the chart.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ChartLegend", + "description": "Represents the legend in a chart.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "format", + "dataType": "ChartLegendFormat", + "description": "Represents the formatting of a chart legend, which includes fill and font formatting.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "visible", + "dataType": "bool", + "description": "A boolean value the represents the visibility of a ChartLegend object.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "position", + "dataType": "string", + "description": "Represents the position of the legend on the chart.", + "isReadOnly": false, + "enumNameJs": "Excel.ChartLegendPosition", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "overlay", + "dataType": "bool", + "description": "Boolean value for whether the chart legend should overlap with the main body of the chart.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartlegendformat.json b/scripts/jsonFiles/source/chartlegendformat.json index 9c88f10..da1516e 100644 --- a/scripts/jsonFiles/source/chartlegendformat.json +++ b/scripts/jsonFiles/source/chartlegendformat.json @@ -1,47 +1,47 @@ -{ - "name": "ChartLegendFormat", - "description": "Encapsulates the format properties of a chart legend.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "font", - "dataType": "ChartFont", - "description": "Represents the font attributes such as font name, font size, color, etc. of a chart legend.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "fill", - "dataType": "ChartFill", - "description": "Represents the fill format of an object, which includes background formating information.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ChartLegendFormat", + "description": "Encapsulates the format properties of a chart legend.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "font", + "dataType": "ChartFont", + "description": "Represents the font attributes such as font name, font size, color, etc. of a chart legend.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "fill", + "dataType": "ChartFill", + "description": "Represents the fill format of an object, which includes background formating information.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartlineformat.json b/scripts/jsonFiles/source/chartlineformat.json index d01f1a6..e928c37 100644 --- a/scripts/jsonFiles/source/chartlineformat.json +++ b/scripts/jsonFiles/source/chartlineformat.json @@ -1,48 +1,48 @@ -{ - "name": "ChartLineFormat", - "description": "Enapsulates the formatting options for line elements.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "color", - "dataType": "string", - "description": "HTML color code representing the color of lines in the chart.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "clear", - "returnType": "void", - "description": "Clear the line format of a chart element.", - "syntax": "chartLineFormatObject.clear();", - "signature": "clear()", - "restfulName": "clear", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - } - ] +{ + "name": "ChartLineFormat", + "description": "Enapsulates the formatting options for line elements.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "color", + "dataType": "string", + "description": "HTML color code representing the color of lines in the chart.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "clear", + "returnType": "void", + "description": "Clear the line format of a chart element.", + "syntax": "chartLineFormatObject.clear();", + "signature": "clear()", + "restfulName": "clear", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartpoint.json b/scripts/jsonFiles/source/chartpoint.json index 8b59bd5..4e84490 100644 --- a/scripts/jsonFiles/source/chartpoint.json +++ b/scripts/jsonFiles/source/chartpoint.json @@ -1,47 +1,47 @@ -{ - "name": "ChartPoint", - "description": "Represents a point of a series in a chart.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "format", - "dataType": "ChartPointFormat", - "description": "Encapsulates the format properties chart point.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "value", - "dataType": "object", - "description": "Returns the value of a chart point.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ChartPoint", + "description": "Represents a point of a series in a chart.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "format", + "dataType": "ChartPointFormat", + "description": "Encapsulates the format properties chart point.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "value", + "dataType": "object", + "description": "Returns the value of a chart point.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartpointformat.json b/scripts/jsonFiles/source/chartpointformat.json index 9e1f5e8..c7c93e3 100644 --- a/scripts/jsonFiles/source/chartpointformat.json +++ b/scripts/jsonFiles/source/chartpointformat.json @@ -1,35 +1,47 @@ -{ - "name": "ChartPointFormat", - "description": "Represents formatting object for chart points.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "fill", - "dataType": "ChartFill", - "description": "Represents the fill format of a chart, which includes background formating information.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ChartPointFormat", + "description": "Represents formatting object for chart points.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "fill", + "dataType": "ChartFill", + "description": "Represents the fill format of a chart, which includes background formating information.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "border", + "dataType": "ChartBorder", + "description": "Represents the border format of a chart point, which includes border formating information. Read-only", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.9", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartpointscollection.json b/scripts/jsonFiles/source/chartpointscollection.json index 857b542..bcefafa 100644 --- a/scripts/jsonFiles/source/chartpointscollection.json +++ b/scripts/jsonFiles/source/chartpointscollection.json @@ -1,82 +1,82 @@ -{ - "name": "ChartPointsCollection", - "description": "A collection of all the chart points within a series inside a chart.", - "isCollection": true, - "collectionOf": "ChartPoint", - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "count", - "dataType": "int", - "description": "Returns the number of chart points in the series.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "items", - "dataType": "ChartPoint[]", - "description": "A collection of chartPoints objects.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getCount", - "returnType": "int", - "description": "Returns the number of chart points in the series.", - "syntax": "chartPointsCollectionObject.getCount();", - "signature": "getCount()", - "restfulName": "Count", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.4" - }, - { - "name": "getItemAt", - "returnType": "ChartPoint", - "description": "Retrieve a point based on its position within the series.", - "syntax": "chartPointsCollectionObject.getItemAt(index);", - "signature": "getItemAt(index: number)", - "restfulName": "ItemAt", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "index", - "dataType": "number", - "isCollection": false, - "description": "Index value of the object to be retrieved. Zero-indexed.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - } - ] +{ + "name": "ChartPointsCollection", + "description": "A collection of all the chart points within a series inside a chart.", + "isCollection": true, + "collectionOf": "ChartPoint", + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "count", + "dataType": "int", + "description": "Returns the number of chart points in the series.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "items", + "dataType": "ChartPoint[]", + "description": "A collection of chartPoints objects.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getCount", + "returnType": "int", + "description": "Returns the number of chart points in the series.", + "syntax": "chartPointsCollectionObject.getCount();", + "signature": "getCount()", + "restfulName": "Count", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.4" + }, + { + "name": "getItemAt", + "returnType": "ChartPoint", + "description": "Retrieve a point based on its position within the series.", + "syntax": "chartPointsCollectionObject.getItemAt(index);", + "signature": "getItemAt(index: number)", + "restfulName": "ItemAt", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "index", + "dataType": "number", + "isCollection": false, + "description": "Index value of the object to be retrieved. Zero-indexed.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartseries.json b/scripts/jsonFiles/source/chartseries.json index 62ef06c..7b29242 100644 --- a/scripts/jsonFiles/source/chartseries.json +++ b/scripts/jsonFiles/source/chartseries.json @@ -1,59 +1,150 @@ -{ - "name": "ChartSeries", - "description": "Represents a series in a chart.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "format", - "dataType": "ChartSeriesFormat", - "description": "Represents the formatting of a chart series, which includes fill and line formatting.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "name", - "dataType": "string", - "description": "Represents the name of a series in a chart.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "points", - "dataType": "ChartPointsCollection", - "description": "Represents a collection of all points in the series.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ChartSeries", + "description": "Represents a series in a chart.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "format", + "dataType": "ChartSeriesFormat", + "description": "Represents the formatting of a chart series, which includes fill and line formatting.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "name", + "dataType": "string", + "description": "Represents the name of a series in a chart.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "points", + "dataType": "ChartPointsCollection", + "description": "Represents a collection of all points in the series.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "trendlines", + "dataType": "ChartTrendlineCollection", + "description": "Represents a collection of Trendlines in the series.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": true, + "reqSet": "1.9", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "delete", + "returnType": "void", + "description": "Deletes the chart series.", + "syntax": "chartSeriesObject.delete();", + "signature": "delete()", + "restfulName": "delete", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.9" + }, + { + "name": "setXAxisValues", + "returnType": "void", + "description": "Set values of X axis for a chart series. Only works for scatter charts.", + "syntax": "chartSeriesObject.setXAxisValues(sourceData);", + "signature": "setXAxisValues(sourceData: Range)", + "restfulName": "setXAxisValues", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "sourceData", + "dataType": "Range", + "isCollection": false, + "description": "The Range object corresponding to the source data.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.9" + }, + { + "name": "setValues", + "returnType": "void", + "description": "Set values for a chart series. For scatter chart, it means Y axis values.", + "syntax": "chartSeriesObject.setValues(sourceData);", + "signature": "setValues(sourceData: Range)", + "restfulName": "setValues", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "sourceData", + "dataType": "Range", + "isCollection": false, + "description": "The Range object corresponding to the source data.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.9" + }, + { + "name": "setBubbleSizes", + "returnType": "void", + "description": "Set bubble sizes for a chart series. Only works for bubble charts.", + "syntax": "chartSeriesObject.setBubbleSizes(sourceData);", + "signature": "setBubbleSizes(sourceData: Range)", + "restfulName": "setBubbleSizes", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "sourceData", + "dataType": "Range", + "isCollection": false, + "description": "The Range object corresponding to the source data.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.9" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartseriescollection.json b/scripts/jsonFiles/source/chartseriescollection.json index e8b4a06..7acdd95 100644 --- a/scripts/jsonFiles/source/chartseriescollection.json +++ b/scripts/jsonFiles/source/chartseriescollection.json @@ -1,82 +1,113 @@ -{ - "name": "ChartSeriesCollection", - "description": "Represents a collection of chart series.", - "isCollection": true, - "collectionOf": "ChartSeries", - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "count", - "dataType": "int", - "description": "Returns the number of series in the collection.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "items", - "dataType": "ChartSeries[]", - "description": "A collection of chartSeries objects.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getCount", - "returnType": "int", - "description": "Returns the number of series in the collection.", - "syntax": "chartSeriesCollectionObject.getCount();", - "signature": "getCount()", - "restfulName": "Count", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.4" - }, - { - "name": "getItemAt", - "returnType": "ChartSeries", - "description": "Retrieves a series based on its position in the collection", - "syntax": "chartSeriesCollectionObject.getItemAt(index);", - "signature": "getItemAt(index: number)", - "restfulName": "ItemAt", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "index", - "dataType": "number", - "isCollection": false, - "description": "Index value of the object to be retrieved. Zero-indexed.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - } - ] +{ + "name": "ChartSeriesCollection", + "description": "Represents a collection of chart series.", + "isCollection": true, + "collectionOf": "ChartSeries", + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "count", + "dataType": "int", + "description": "Returns the number of series in the collection.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "items", + "dataType": "ChartSeries[]", + "description": "A collection of chartSeries objects.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "add", + "returnType": "ChartSeries", + "description": "Add a new series to the collection.", + "syntax": "chartSeriesCollectionObject.add(name, index);", + "signature": "add(name: string, index: number)", + "restfulName": "add", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "name", + "dataType": "string", + "isCollection": false, + "description": "Name of the series.", + "isRequired": false, + "enumNameJs": null, + "notes": null + }, + { + "name": "index", + "dataType": "number", + "isCollection": false, + "description": "Index value of the series to be added. Zero-indexed.", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.9" + }, + { + "name": "getCount", + "returnType": "int", + "description": "Returns the number of series in the collection.", + "syntax": "chartSeriesCollectionObject.getCount();", + "signature": "getCount()", + "restfulName": "Count", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.4" + }, + { + "name": "getItemAt", + "returnType": "ChartSeries", + "description": "Retrieves a series based on its position in the collection.c", + "syntax": "chartSeriesCollectionObject.getItemAt(index);", + "signature": "getItemAt(index: number)", + "restfulName": "ItemAt", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "index", + "dataType": "number", + "isCollection": false, + "description": "Index value of the object to be retrieved. Zero-indexed.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/chartseriesformat.json b/scripts/jsonFiles/source/chartseriesformat.json index 3dc1302..fb75f63 100644 --- a/scripts/jsonFiles/source/chartseriesformat.json +++ b/scripts/jsonFiles/source/chartseriesformat.json @@ -1,47 +1,47 @@ -{ - "name": "ChartSeriesFormat", - "description": "encapsulates the format properties for the chart series", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "fill", - "dataType": "ChartFill", - "description": "Represents the fill format of a chart series, which includes background formating information.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "line", - "dataType": "ChartLineFormat", - "description": "Represents line formatting.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ChartSeriesFormat", + "description": "encapsulates the format properties for the chart series", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "fill", + "dataType": "ChartFill", + "description": "Represents the fill format of a chart series, which includes background formating information.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "line", + "dataType": "ChartLineFormat", + "description": "Represents line formatting.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/charttitle.json b/scripts/jsonFiles/source/charttitle.json index a659a44..bd397af 100644 --- a/scripts/jsonFiles/source/charttitle.json +++ b/scripts/jsonFiles/source/charttitle.json @@ -1,71 +1,115 @@ -{ - "name": "ChartTitle", - "description": "Represents a chart title object of a chart.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "format", - "dataType": "ChartTitleFormat", - "description": "Represents the formatting of a chart title, which includes fill and font formatting.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "overlay", - "dataType": "bool", - "description": "Boolean value representing if the chart title will overlay the chart or not.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "text", - "dataType": "string", - "description": "Represents the title text of a chart.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "visible", - "dataType": "bool", - "description": "A boolean value the represents the visibility of a chart title object.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ChartTitle", + "description": "Represents a chart title object of a chart.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "format", + "dataType": "ChartTitleFormat", + "description": "Represents the formatting of a chart title, which includes fill and font formatting.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "overlay", + "dataType": "bool", + "description": "Boolean value representing if the chart title will overlay the chart or not.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "text", + "dataType": "string", + "description": "Represents the title text of a chart.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "visible", + "dataType": "bool", + "description": "A boolean value the represents the visibility of a chart title object.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "horizontalAlignment", + "dataType": "string", + "description": "Represents the horizontal alignment for chart title.", + "isReadOnly": false, + "enumNameJs": "Excel.ChartTextHorizontalAlignment", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.9", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getSubstring", + "returnType": "ChartFormatString", + "description": "Get the characters of a chart title. Line break '\\n' also counts one charater.", + "syntax": "chartTitleObject.getSubstring(start, start);", + "signature": "getSubstring(start: number, start: number)", + "restfulName": "Substring", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "start", + "dataType": "number", + "isCollection": false, + "description": "The start index of the sub string", + "isRequired": true, + "enumNameJs": null, + "notes": null + }, + { + "name": "start", + "dataType": "number", + "isCollection": false, + "description": "The length of the sub string", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.9" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/charttitleformat.json b/scripts/jsonFiles/source/charttitleformat.json index 4459706..c773f37 100644 --- a/scripts/jsonFiles/source/charttitleformat.json +++ b/scripts/jsonFiles/source/charttitleformat.json @@ -1,47 +1,47 @@ -{ - "name": "ChartTitleFormat", - "description": "Provides access to the office art formatting for chart title.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "font", - "dataType": "ChartFont", - "description": "Represents the font attributes (font name, font size, color, etc.) for an object.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "fill", - "dataType": "ChartFill", - "description": "Represents the fill format of an object, which includes background formating information.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ChartTitleFormat", + "description": "Provides access to the office art formatting for chart title.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "font", + "dataType": "ChartFont", + "description": "Represents the font attributes (font name, font size, color, etc.) for an object.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "fill", + "dataType": "ChartFill", + "description": "Represents the fill format of an object, which includes background formating information.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/charttrendline.json b/scripts/jsonFiles/source/charttrendline.json new file mode 100644 index 0000000..b11d4e2 --- /dev/null +++ b/scripts/jsonFiles/source/charttrendline.json @@ -0,0 +1,71 @@ +{ + "name": "ChartTrendline", + "description": "This object represents the attributes for a chart trendline object.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.9", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "format", + "dataType": "ChartTrendlineFormat", + "description": "Represents the formatting of a chart trendline.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.9", + "isKey": null, + "notes": null + }, + { + "name": "type", + "dataType": "string", + "description": "Represents the Type of a chart trendline.", + "isReadOnly": false, + "enumNameJs": "Excel.TrendlineType", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.9", + "isKey": null, + "notes": null + }, + { + "name": "polynomialOrder", + "dataType": "int", + "description": "Represents the PolynomialOrder of a chart trendline, specific for trendline with Polynomial type.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.9", + "isKey": null, + "notes": null + }, + { + "name": "movingAveragePeriod", + "dataType": "int", + "description": "Represents the MovingAveragePeriod of a chart trendline, specific for trendline with MovingAverage type.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.9", + "isKey": null, + "notes": null + } + ], + "methods": null +} \ No newline at end of file diff --git a/scripts/jsonFiles/source/charttrendlinecollection.json b/scripts/jsonFiles/source/charttrendlinecollection.json new file mode 100644 index 0000000..767ae91 --- /dev/null +++ b/scripts/jsonFiles/source/charttrendlinecollection.json @@ -0,0 +1,70 @@ +{ + "name": "ChartTrendlineCollection", + "description": "Represents a collection of Chart Trendlines.", + "isCollection": true, + "collectionOf": "ChartTrendline", + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.9", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "items", + "dataType": "ChartTrendline[]", + "description": "A collection of chartTrendline objects.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": false, + "reqSet": "1.9", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getCount", + "returnType": "int", + "description": "Returns the number of trendlines in the collection.", + "syntax": "chartTrendlineCollectionObject.getCount();", + "signature": "getCount()", + "restfulName": "Count", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.9" + }, + { + "name": "add", + "returnType": "ChartTrendline", + "description": "Adds a new trendline to trendline collection.", + "syntax": "chartTrendlineCollectionObject.add(type);", + "signature": "add(type: string)", + "restfulName": "add", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "type", + "dataType": "string", + "isCollection": false, + "description": "TrendlineType.", + "isRequired": false, + "enumNameJs": "Excel.TrendlineType", + "notes": null + } + ], + "reqSet": "1.9" + } + ] +} \ No newline at end of file diff --git a/scripts/jsonFiles/source/charttrendlineformat.json b/scripts/jsonFiles/source/charttrendlineformat.json new file mode 100644 index 0000000..fa1da49 --- /dev/null +++ b/scripts/jsonFiles/source/charttrendlineformat.json @@ -0,0 +1,35 @@ +{ + "name": "ChartTrendlineFormat", + "description": "Encapsulates the format properties for chart trendline.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.9", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "line", + "dataType": "ChartLineFormat", + "description": "Represents chart line formatting.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.9", + "isKey": null, + "notes": null + } + ], + "methods": null +} \ No newline at end of file diff --git a/scripts/jsonFiles/source/colorscaleconditionalformat.json b/scripts/jsonFiles/source/colorscaleconditionalformat.json index 0e4aa69..2100755 100644 --- a/scripts/jsonFiles/source/colorscaleconditionalformat.json +++ b/scripts/jsonFiles/source/colorscaleconditionalformat.json @@ -1,47 +1,47 @@ -{ - "name": "ColorScaleConditionalFormat", - "description": "Represents an IconSet criteria for conditional formatting.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "threeColorScale", - "dataType": "bool", - "description": "If true the color scale will have three points (minimum, midpoint, maximum), otherwise it will have two (minimum, maximum).", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "criteria", - "dataType": "ConditionalColorScaleCriteria", - "description": "The criteria of the color scale. Midpoint is optional when using a two point color scale.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ColorScaleConditionalFormat", + "description": "Represents an IconSet criteria for conditional formatting.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "threeColorScale", + "dataType": "bool", + "description": "If true the color scale will have three points (minimum, midpoint, maximum), otherwise it will have two (minimum, maximum).", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "criteria", + "dataType": "ConditionalColorScaleCriteria", + "description": "The criteria of the color scale. Midpoint is optional when using a two point color scale.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/conditionalcellvaluerule.json b/scripts/jsonFiles/source/conditionalcellvaluerule.json index 203bb3c..aa0e37b 100644 --- a/scripts/jsonFiles/source/conditionalcellvaluerule.json +++ b/scripts/jsonFiles/source/conditionalcellvaluerule.json @@ -1,59 +1,59 @@ -{ - "name": "ConditionalCellValueRule", - "description": "Represents a Cell Value Conditional Format Rule", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "operator", - "dataType": "string", - "description": "The operator of the text conditional format.", - "isReadOnly": false, - "enumNameJs": "Excel.ConditionalCellValueOperator", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "formula1", - "dataType": "object", - "description": "The formula, if required, to evaluate the conditional format rule on.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "formula2", - "dataType": "object", - "description": "The formula, if required, to evaluate the conditional format rule on.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ConditionalCellValueRule", + "description": "Represents a Cell Value Conditional Format Rule", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "operator", + "dataType": "string", + "description": "The operator of the text conditional format.", + "isReadOnly": false, + "enumNameJs": "Excel.ConditionalCellValueOperator", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "formula1", + "dataType": "object", + "description": "The formula, if required, to evaluate the conditional format rule on.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "formula2", + "dataType": "object", + "description": "The formula, if required, to evaluate the conditional format rule on.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/conditionalcolorscalecriteria.json b/scripts/jsonFiles/source/conditionalcolorscalecriteria.json index 7230ec0..78bade9 100644 --- a/scripts/jsonFiles/source/conditionalcolorscalecriteria.json +++ b/scripts/jsonFiles/source/conditionalcolorscalecriteria.json @@ -1,59 +1,59 @@ -{ - "name": "ConditionalColorScaleCriteria", - "description": "Represents the criteria of the color scale.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "minimum", - "dataType": "ConditionalColorScaleCriterion", - "description": "The minimum point Color Scale Criterion.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "midpoint", - "dataType": "ConditionalColorScaleCriterion", - "description": "The midpoint Color Scale Criterion if the color scale is a 3-color scale.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "maximum", - "dataType": "ConditionalColorScaleCriterion", - "description": "The maximum point Color Scale Criterion.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ConditionalColorScaleCriteria", + "description": "Represents the criteria of the color scale.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "minimum", + "dataType": "ConditionalColorScaleCriterion", + "description": "The minimum point Color Scale Criterion.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "midpoint", + "dataType": "ConditionalColorScaleCriterion", + "description": "The midpoint Color Scale Criterion if the color scale is a 3-color scale.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "maximum", + "dataType": "ConditionalColorScaleCriterion", + "description": "The maximum point Color Scale Criterion.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/conditionalcolorscalecriterion.json b/scripts/jsonFiles/source/conditionalcolorscalecriterion.json index 9d01adb..1fc7f96 100644 --- a/scripts/jsonFiles/source/conditionalcolorscalecriterion.json +++ b/scripts/jsonFiles/source/conditionalcolorscalecriterion.json @@ -1,59 +1,59 @@ -{ - "name": "ConditionalColorScaleCriterion", - "description": "Represents a Color Scale Criterion which contains a type, value and a color.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "type", - "dataType": "string", - "description": "What the icon conditional formula should be based on.", - "isReadOnly": false, - "enumNameJs": "Excel.ConditionalFormatColorCriterionType", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "formula", - "dataType": "object", - "description": "A number, a formula, or null (if Type is LowestValue).", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "color", - "dataType": "string", - "description": "HTML color code representation of the color scale color. E.g. #FF0000 represents Red.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ConditionalColorScaleCriterion", + "description": "Represents a Color Scale Criterion which contains a type, value and a color.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "type", + "dataType": "string", + "description": "What the icon conditional formula should be based on.", + "isReadOnly": false, + "enumNameJs": "Excel.ConditionalFormatColorCriterionType", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "formula", + "dataType": "object", + "description": "A number, a formula, or null (if Type is LowestValue).", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "color", + "dataType": "string", + "description": "HTML color code representation of the color scale color. E.g. #FF0000 represents Red.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/conditionaldatabarnegativeformat.json b/scripts/jsonFiles/source/conditionaldatabarnegativeformat.json index 3b24081..fd22205 100644 --- a/scripts/jsonFiles/source/conditionaldatabarnegativeformat.json +++ b/scripts/jsonFiles/source/conditionaldatabarnegativeformat.json @@ -1,71 +1,71 @@ -{ - "name": "ConditionalDataBarNegativeFormat", - "description": "Represents a conditional format DataBar Format for the negative side of the data bar.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "borderColor", - "dataType": "string", - "description": "HTML color code representing the color of the border line, of the form #RRGGBB (e.g. \"FFA500\") or as a named HTML color (e.g. \"orange\").", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "matchPositiveBorderColor", - "dataType": "bool", - "description": "Boolean representation of whether or not the negative DataBar has the same border color as the positive DataBar.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "fillColor", - "dataType": "string", - "description": "HTML color code representing the fill color, of the form #RRGGBB (e.g. \"FFA500\") or as a named HTML color (e.g. \"orange\").", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "matchPositiveFillColor", - "dataType": "bool", - "description": "Boolean representation of whether or not the negative DataBar has the same fill color as the positive DataBar.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ConditionalDataBarNegativeFormat", + "description": "Represents a conditional format DataBar Format for the negative side of the data bar.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "borderColor", + "dataType": "string", + "description": "HTML color code representing the color of the border line, of the form #RRGGBB (e.g. \"FFA500\") or as a named HTML color (e.g. \"orange\").", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "matchPositiveBorderColor", + "dataType": "bool", + "description": "Boolean representation of whether or not the negative DataBar has the same border color as the positive DataBar.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "fillColor", + "dataType": "string", + "description": "HTML color code representing the fill color, of the form #RRGGBB (e.g. \"FFA500\") or as a named HTML color (e.g. \"orange\").", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "matchPositiveFillColor", + "dataType": "bool", + "description": "Boolean representation of whether or not the negative DataBar has the same fill color as the positive DataBar.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/conditionaldatabarpositiveformat.json b/scripts/jsonFiles/source/conditionaldatabarpositiveformat.json index 109c9dd..7a7a59b 100644 --- a/scripts/jsonFiles/source/conditionaldatabarpositiveformat.json +++ b/scripts/jsonFiles/source/conditionaldatabarpositiveformat.json @@ -1,59 +1,59 @@ -{ - "name": "ConditionalDataBarPositiveFormat", - "description": "Represents a conditional format DataBar Format for the positive side of the data bar.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "borderColor", - "dataType": "string", - "description": "HTML color code representing the color of the border line, of the form #RRGGBB (e.g. \"FFA500\") or as a named HTML color (e.g. \"orange\").", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "fillColor", - "dataType": "string", - "description": "HTML color code representing the fill color, of the form #RRGGBB (e.g. \"FFA500\") or as a named HTML color (e.g. \"orange\").", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "gradientFill", - "dataType": "bool", - "description": "Boolean representation of whether or not the DataBar has a gradient.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ConditionalDataBarPositiveFormat", + "description": "Represents a conditional format DataBar Format for the positive side of the data bar.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "borderColor", + "dataType": "string", + "description": "HTML color code representing the color of the border line, of the form #RRGGBB (e.g. \"FFA500\") or as a named HTML color (e.g. \"orange\").", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "fillColor", + "dataType": "string", + "description": "HTML color code representing the fill color, of the form #RRGGBB (e.g. \"FFA500\") or as a named HTML color (e.g. \"orange\").", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "gradientFill", + "dataType": "bool", + "description": "Boolean representation of whether or not the DataBar has a gradient.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/conditionaldatabarrule.json b/scripts/jsonFiles/source/conditionaldatabarrule.json index fa4fe74..e3b9258 100644 --- a/scripts/jsonFiles/source/conditionaldatabarrule.json +++ b/scripts/jsonFiles/source/conditionaldatabarrule.json @@ -1,47 +1,47 @@ -{ - "name": "ConditionalDataBarRule", - "description": "Represents a rule-type for a Data Bar.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "type", - "dataType": "string", - "description": "The type of rule for the databar.", - "isReadOnly": false, - "enumNameJs": "Excel.ConditionalFormatRuleType", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "formula", - "dataType": "object", - "description": "The formula, if required, to evaluate the databar rule on.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ConditionalDataBarRule", + "description": "Represents a rule-type for a Data Bar.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "type", + "dataType": "string", + "description": "The type of rule for the databar.", + "isReadOnly": false, + "enumNameJs": "Excel.ConditionalFormatRuleType", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "formula", + "dataType": "object", + "description": "The formula, if required, to evaluate the databar rule on.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/conditionalformat.json b/scripts/jsonFiles/source/conditionalformat.json index 1a8a655..9d9e92c 100644 --- a/scripts/jsonFiles/source/conditionalformat.json +++ b/scripts/jsonFiles/source/conditionalformat.json @@ -1,288 +1,288 @@ -{ - "name": "ConditionalFormat", - "description": "An object encapsulating a conditional format's range, format, rule, and other properties.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "stopIfTrue", - "dataType": "bool", - "description": "If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "priority", - "dataType": "int", - "description": "The priority (or index) within the conditional format collection that this conditional format currently exists in. Changing this also", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "type", - "dataType": "string", - "description": "A type of conditional format. Only one can be set at a time. Read-Only.", - "isReadOnly": true, - "enumNameJs": "Excel.ConditionalFormatType", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "dataBar", - "dataType": "DataBarConditionalFormat", - "description": "Returns the data bar properties if the current conditional format is a data bar.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "dataBarOrNullObject", - "dataType": "DataBarConditionalFormat", - "description": "Returns the data bar properties if the current conditional format is a data bar.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "custom", - "dataType": "CustomConditionalFormat", - "description": "Returns the custom conditional format properties if the current conditional format is a custom type.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "customOrNullObject", - "dataType": "CustomConditionalFormat", - "description": "Returns the custom conditional format properties if the current conditional format is a custom type.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "iconSet", - "dataType": "IconSetConditionalFormat", - "description": "Returns the IconSet conditional format properties if the current conditional format is an IconSet type.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "iconSetOrNullObject", - "dataType": "IconSetConditionalFormat", - "description": "Returns the IconSet conditional format properties if the current conditional format is an IconSet type.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "colorScale", - "dataType": "ColorScaleConditionalFormat", - "description": "Returns the ColorScale conditional format properties if the current conditional format is an ColorScale type.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "colorScaleOrNullObject", - "dataType": "ColorScaleConditionalFormat", - "description": "Returns the ColorScale conditional format properties if the current conditional format is an ColorScale type.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "topBottom", - "dataType": "TopBottomConditionalFormat", - "description": "Returns the TopBottom conditional format properties if the current conditional format is an TopBottom type.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "topBottomOrNullObject", - "dataType": "TopBottomConditionalFormat", - "description": "Returns the TopBottom conditional format properties if the current conditional format is an TopBottom type.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "preset", - "dataType": "PresetCriteriaConditionalFormat", - "description": "Returns the preset criteria conditional format such as above averagebelow averageunique valuescontains blanknonblankerrornoerror properties.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "presetOrNullObject", - "dataType": "PresetCriteriaConditionalFormat", - "description": "Returns the preset criteria conditional format such as above averagebelow averageunique valuescontains blanknonblankerrornoerror properties.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "textComparison", - "dataType": "TextConditionalFormat", - "description": "Returns the specific text conditional format properties if the current conditional format is a text type.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "textComparisonOrNullObject", - "dataType": "TextConditionalFormat", - "description": "Returns the specific text conditional format properties if the current conditional format is a text type.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "cellValue", - "dataType": "CellValueConditionalFormat", - "description": "Returns the cell value conditional format properties if the current conditional format is a CellValue type.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "cellValueOrNullObject", - "dataType": "CellValueConditionalFormat", - "description": "Returns the cell value conditional format properties if the current conditional format is a CellValue type.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getRange", - "returnType": "Range", - "description": "Returns the range the conditonal format is applied to or a null object if the range is discontiguous. Read-only.", - "syntax": "conditionalFormatObject.getRange();", - "signature": "getRange()", - "restfulName": "Range", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.6" - }, - { - "name": "getRangeOrNullObject", - "returnType": "Range", - "description": "Returns the range the conditonal format is applied to or a null object if the range is discontiguous. Read-only.", - "syntax": "conditionalFormatObject.getRangeOrNullObject();", - "signature": "getRangeOrNullObject()", - "restfulName": "RangeOrNullObject", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.6" - }, - { - "name": "delete", - "returnType": "void", - "description": "Deletes this conditional format.", - "syntax": "conditionalFormatObject.delete();", - "signature": "delete()", - "restfulName": "delete", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.6" - } - ] +{ + "name": "ConditionalFormat", + "description": "An object encapsulating a conditional format's range, format, rule, and other properties.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "stopIfTrue", + "dataType": "bool", + "description": "If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "priority", + "dataType": "int", + "description": "The priority (or index) within the conditional format collection that this conditional format currently exists in. Changing this also", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "type", + "dataType": "string", + "description": "A type of conditional format. Only one can be set at a time. Read-Only.", + "isReadOnly": true, + "enumNameJs": "Excel.ConditionalFormatType", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "dataBar", + "dataType": "DataBarConditionalFormat", + "description": "Returns the data bar properties if the current conditional format is a data bar.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "dataBarOrNullObject", + "dataType": "DataBarConditionalFormat", + "description": "Returns the data bar properties if the current conditional format is a data bar.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "custom", + "dataType": "CustomConditionalFormat", + "description": "Returns the custom conditional format properties if the current conditional format is a custom type.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "customOrNullObject", + "dataType": "CustomConditionalFormat", + "description": "Returns the custom conditional format properties if the current conditional format is a custom type.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "iconSet", + "dataType": "IconSetConditionalFormat", + "description": "Returns the IconSet conditional format properties if the current conditional format is an IconSet type.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "iconSetOrNullObject", + "dataType": "IconSetConditionalFormat", + "description": "Returns the IconSet conditional format properties if the current conditional format is an IconSet type.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "colorScale", + "dataType": "ColorScaleConditionalFormat", + "description": "Returns the ColorScale conditional format properties if the current conditional format is an ColorScale type.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "colorScaleOrNullObject", + "dataType": "ColorScaleConditionalFormat", + "description": "Returns the ColorScale conditional format properties if the current conditional format is an ColorScale type.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "topBottom", + "dataType": "TopBottomConditionalFormat", + "description": "Returns the TopBottom conditional format properties if the current conditional format is an TopBottom type.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "topBottomOrNullObject", + "dataType": "TopBottomConditionalFormat", + "description": "Returns the TopBottom conditional format properties if the current conditional format is an TopBottom type.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "preset", + "dataType": "PresetCriteriaConditionalFormat", + "description": "Returns the preset criteria conditional format such as above averagebelow averageunique valuescontains blanknonblankerrornoerror properties.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "presetOrNullObject", + "dataType": "PresetCriteriaConditionalFormat", + "description": "Returns the preset criteria conditional format such as above averagebelow averageunique valuescontains blanknonblankerrornoerror properties.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "textComparison", + "dataType": "TextConditionalFormat", + "description": "Returns the specific text conditional format properties if the current conditional format is a text type.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "textComparisonOrNullObject", + "dataType": "TextConditionalFormat", + "description": "Returns the specific text conditional format properties if the current conditional format is a text type.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "cellValue", + "dataType": "CellValueConditionalFormat", + "description": "Returns the cell value conditional format properties if the current conditional format is a CellValue type.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "cellValueOrNullObject", + "dataType": "CellValueConditionalFormat", + "description": "Returns the cell value conditional format properties if the current conditional format is a CellValue type.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getRange", + "returnType": "Range", + "description": "Returns the range the conditonal format is applied to or a null object if the range is discontiguous. Read-only.", + "syntax": "conditionalFormatObject.getRange();", + "signature": "getRange()", + "restfulName": "Range", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.6" + }, + { + "name": "getRangeOrNullObject", + "returnType": "Range", + "description": "Returns the range the conditonal format is applied to or a null object if the range is discontiguous. Read-only.", + "syntax": "conditionalFormatObject.getRangeOrNullObject();", + "signature": "getRangeOrNullObject()", + "restfulName": "RangeOrNullObject", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.6" + }, + { + "name": "delete", + "returnType": "void", + "description": "Deletes this conditional format.", + "syntax": "conditionalFormatObject.delete();", + "signature": "delete()", + "restfulName": "delete", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.6" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/conditionalformatcollection.json b/scripts/jsonFiles/source/conditionalformatcollection.json index e73b0af..f4d6f1a 100644 --- a/scripts/jsonFiles/source/conditionalformatcollection.json +++ b/scripts/jsonFiles/source/conditionalformatcollection.json @@ -1,104 +1,104 @@ -{ - "name": "ConditionalFormatCollection", - "description": "Represents a collection of all the conditional formats that are overlap the range.", - "isCollection": true, - "collectionOf": "ConditionalFormat", - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "items", - "dataType": "ConditionalFormat[]", - "description": "A collection of conditionalFormat objects.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getItemAt", - "returnType": "ConditionalFormat", - "description": "Returns a conditional format at the given index.", - "syntax": "conditionalFormatCollectionObject.getItemAt(index);", - "signature": "getItemAt(index: number)", - "restfulName": "ItemAt", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "index", - "dataType": "number", - "isCollection": false, - "description": "Index of the conditional formats to be retrieved.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.6" - }, - { - "name": "getCount", - "returnType": "int", - "description": "Returns the number of conditional formats in the workbook. Read-only.", - "syntax": "conditionalFormatCollectionObject.getCount();", - "signature": "getCount()", - "restfulName": "Count", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.6" - }, - { - "name": "clearAll", - "returnType": "void", - "description": "Clears all conditional formats active on the current specified range.", - "syntax": "conditionalFormatCollectionObject.clearAll();", - "signature": "clearAll()", - "restfulName": "clearAll", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.6" - }, - { - "name": "add", - "returnType": "ConditionalFormat", - "description": "Adds a new conditional format to the collection at the firsttop priority.", - "syntax": "conditionalFormatCollectionObject.add(type);", - "signature": "add(type: string)", - "restfulName": "add", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "type", - "dataType": "string", - "isCollection": false, - "description": "The type of conditional format being added.", - "isRequired": true, - "enumNameJs": "Excel.ConditionalFormatType", - "notes": null - } - ], - "reqSet": "1.6" - } - ] +{ + "name": "ConditionalFormatCollection", + "description": "Represents a collection of all the conditional formats that are overlap the range.", + "isCollection": true, + "collectionOf": "ConditionalFormat", + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "items", + "dataType": "ConditionalFormat[]", + "description": "A collection of conditionalFormat objects.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getItemAt", + "returnType": "ConditionalFormat", + "description": "Returns a conditional format at the given index.", + "syntax": "conditionalFormatCollectionObject.getItemAt(index);", + "signature": "getItemAt(index: number)", + "restfulName": "ItemAt", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "index", + "dataType": "number", + "isCollection": false, + "description": "Index of the conditional formats to be retrieved.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.6" + }, + { + "name": "getCount", + "returnType": "int", + "description": "Returns the number of conditional formats in the workbook. Read-only.", + "syntax": "conditionalFormatCollectionObject.getCount();", + "signature": "getCount()", + "restfulName": "Count", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.6" + }, + { + "name": "clearAll", + "returnType": "void", + "description": "Clears all conditional formats active on the current specified range.", + "syntax": "conditionalFormatCollectionObject.clearAll();", + "signature": "clearAll()", + "restfulName": "clearAll", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.6" + }, + { + "name": "add", + "returnType": "ConditionalFormat", + "description": "Adds a new conditional format to the collection at the firsttop priority.", + "syntax": "conditionalFormatCollectionObject.add(type);", + "signature": "add(type: string)", + "restfulName": "add", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "type", + "dataType": "string", + "isCollection": false, + "description": "The type of conditional format being added.", + "isRequired": true, + "enumNameJs": "Excel.ConditionalFormatType", + "notes": null + } + ], + "reqSet": "1.6" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/conditionalformatrule.json b/scripts/jsonFiles/source/conditionalformatrule.json index eed4509..6be035f 100644 --- a/scripts/jsonFiles/source/conditionalformatrule.json +++ b/scripts/jsonFiles/source/conditionalformatrule.json @@ -1,59 +1,59 @@ -{ - "name": "ConditionalFormatRule", - "description": "Represents a rule, for all traditional ruleformat pairings.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "formula", - "dataType": "object", - "description": "The formula, if required, to evaluate the conditional format rule on.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "formulaLocal", - "dataType": "object", - "description": "The formula, if required, to evaluate the conditional format rule on in the user's language.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "formulaR1C1", - "dataType": "object", - "description": "The formula, if required, to evaluate the conditional format rule on in R1C1-style notation.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ConditionalFormatRule", + "description": "Represents a rule, for all traditional ruleformat pairings.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "formula", + "dataType": "object", + "description": "The formula, if required, to evaluate the conditional format rule on.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "formulaLocal", + "dataType": "object", + "description": "The formula, if required, to evaluate the conditional format rule on in the user's language.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "formulaR1C1", + "dataType": "object", + "description": "The formula, if required, to evaluate the conditional format rule on in R1C1-style notation.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/conditionaliconcriterion.json b/scripts/jsonFiles/source/conditionaliconcriterion.json index 3b5bfd1..02e97db 100644 --- a/scripts/jsonFiles/source/conditionaliconcriterion.json +++ b/scripts/jsonFiles/source/conditionaliconcriterion.json @@ -1,71 +1,71 @@ -{ - "name": "ConditionalIconCriterion", - "description": "Represents an Icon Criterion which contains a type, value, an Operator, and an optional custom icon, if not using an iconset.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "type", - "dataType": "ConditionalFormatIconRuleType", - "description": "What the icon conditional formula should be based on.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "formula", - "dataType": "object", - "description": "A number or a formula depending on the type.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "operator", - "dataType": "string", - "description": "GreaterThan or GreaterThanOrEqual for each of the rule type for the Icon conditional format.", - "isReadOnly": false, - "enumNameJs": "Excel.ConditionalIconCriterionOperator", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "customIcon", - "dataType": "Icon", - "description": "The custom icon for the current criterion if different from the default IconSet, else null will be returned.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ConditionalIconCriterion", + "description": "Represents an Icon Criterion which contains a type, value, an Operator, and an optional custom icon, if not using an iconset.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "type", + "dataType": "ConditionalFormatIconRuleType", + "description": "What the icon conditional formula should be based on.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "formula", + "dataType": "object", + "description": "A number or a formula depending on the type.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "operator", + "dataType": "string", + "description": "GreaterThan or GreaterThanOrEqual for each of the rule type for the Icon conditional format.", + "isReadOnly": false, + "enumNameJs": "Excel.ConditionalIconCriterionOperator", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "customIcon", + "dataType": "Icon", + "description": "The custom icon for the current criterion if different from the default IconSet, else null will be returned.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/conditionalpresetcriteriarule.json b/scripts/jsonFiles/source/conditionalpresetcriteriarule.json index db43643..1917613 100644 --- a/scripts/jsonFiles/source/conditionalpresetcriteriarule.json +++ b/scripts/jsonFiles/source/conditionalpresetcriteriarule.json @@ -1,35 +1,35 @@ -{ - "name": "ConditionalPresetCriteriaRule", - "description": "Represents the Preset Criteria Conditional Format Rule", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "criterion", - "dataType": "string", - "description": "The criterion of the conditional format.", - "isReadOnly": false, - "enumNameJs": "Excel.ConditionalFormatPresetCriterion", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ConditionalPresetCriteriaRule", + "description": "Represents the Preset Criteria Conditional Format Rule", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "criterion", + "dataType": "string", + "description": "The criterion of the conditional format.", + "isReadOnly": false, + "enumNameJs": "Excel.ConditionalFormatPresetCriterion", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/conditionalrangeborder.json b/scripts/jsonFiles/source/conditionalrangeborder.json index 41c9496..7e976f8 100644 --- a/scripts/jsonFiles/source/conditionalrangeborder.json +++ b/scripts/jsonFiles/source/conditionalrangeborder.json @@ -1,71 +1,71 @@ -{ - "name": "ConditionalRangeBorder", - "description": "Represents the border of an object.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "id", - "dataType": "string", - "description": "Represents border identifier.", - "isReadOnly": true, - "enumNameJs": "Excel.ConditionalRangeBorderIndex", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "color", - "dataType": "string", - "description": "HTML color code representing the color of the border line, of the form #RRGGBB (e.g. \"FFA500\") or as a named HTML color (e.g. \"orange\").", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "style", - "dataType": "string", - "description": "One of the constants of line style specifying the line style for the border.", - "isReadOnly": false, - "enumNameJs": "Excel.BorderLineStyle", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "sideIndex", - "dataType": "string", - "description": "Constant value that indicates the specific side of the border.", - "isReadOnly": true, - "enumNameJs": "Excel.ConditionalRangeBorderIndex", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ConditionalRangeBorder", + "description": "Represents the border of an object.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "id", + "dataType": "string", + "description": "Represents border identifier.", + "isReadOnly": true, + "enumNameJs": "Excel.ConditionalRangeBorderIndex", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "color", + "dataType": "string", + "description": "HTML color code representing the color of the border line, of the form #RRGGBB (e.g. \"FFA500\") or as a named HTML color (e.g. \"orange\").", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "style", + "dataType": "string", + "description": "One of the constants of line style specifying the line style for the border.", + "isReadOnly": false, + "enumNameJs": "Excel.BorderLineStyle", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "sideIndex", + "dataType": "string", + "description": "Constant value that indicates the specific side of the border.", + "isReadOnly": true, + "enumNameJs": "Excel.ConditionalRangeBorderIndex", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/conditionalrangebordercollection.json b/scripts/jsonFiles/source/conditionalrangebordercollection.json index aff4ef8..17bcc95 100644 --- a/scripts/jsonFiles/source/conditionalrangebordercollection.json +++ b/scripts/jsonFiles/source/conditionalrangebordercollection.json @@ -1,140 +1,140 @@ -{ - "name": "ConditionalRangeBorderCollection", - "description": "Represents the border objects that make up range border.", - "isCollection": true, - "collectionOf": "ConditionalRangeBorder", - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "count", - "dataType": "int", - "description": "Number of border objects in the collection.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "top", - "dataType": "ConditionalRangeBorder", - "description": "Gets the top border", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "bottom", - "dataType": "ConditionalRangeBorder", - "description": "Gets the top border", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "left", - "dataType": "ConditionalRangeBorder", - "description": "Gets the top border", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "right", - "dataType": "ConditionalRangeBorder", - "description": "Gets the top border", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "items", - "dataType": "ConditionalRangeBorder[]", - "description": "A collection of conditionalRangeBorder objects.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getItem", - "returnType": "ConditionalRangeBorder", - "description": "Gets a border object using its name", - "syntax": "conditionalRangeBorderCollectionObject.getItem(index);", - "signature": "getItem(index: string)", - "restfulName": "Item", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "index", - "dataType": "string", - "isCollection": false, - "description": "Index value of the border object to be retrieved.", - "isRequired": true, - "enumNameJs": "Excel.ConditionalRangeBorderIndex", - "notes": null - } - ], - "reqSet": "1.6" - }, - { - "name": "getItemAt", - "returnType": "ConditionalRangeBorder", - "description": "Gets a border object using its index", - "syntax": "conditionalRangeBorderCollectionObject.getItemAt(index);", - "signature": "getItemAt(index: number)", - "restfulName": "ItemAt", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "index", - "dataType": "number", - "isCollection": false, - "description": "Index value of the object to be retrieved. Zero-indexed.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.6" - } - ] +{ + "name": "ConditionalRangeBorderCollection", + "description": "Represents the border objects that make up range border.", + "isCollection": true, + "collectionOf": "ConditionalRangeBorder", + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "count", + "dataType": "int", + "description": "Number of border objects in the collection.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "top", + "dataType": "ConditionalRangeBorder", + "description": "Gets the top border", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "bottom", + "dataType": "ConditionalRangeBorder", + "description": "Gets the top border", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "left", + "dataType": "ConditionalRangeBorder", + "description": "Gets the top border", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "right", + "dataType": "ConditionalRangeBorder", + "description": "Gets the top border", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "items", + "dataType": "ConditionalRangeBorder[]", + "description": "A collection of conditionalRangeBorder objects.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getItem", + "returnType": "ConditionalRangeBorder", + "description": "Gets a border object using its name", + "syntax": "conditionalRangeBorderCollectionObject.getItem(index);", + "signature": "getItem(index: string)", + "restfulName": "Item", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "index", + "dataType": "string", + "isCollection": false, + "description": "Index value of the border object to be retrieved.", + "isRequired": true, + "enumNameJs": "Excel.ConditionalRangeBorderIndex", + "notes": null + } + ], + "reqSet": "1.6" + }, + { + "name": "getItemAt", + "returnType": "ConditionalRangeBorder", + "description": "Gets a border object using its index", + "syntax": "conditionalRangeBorderCollectionObject.getItemAt(index);", + "signature": "getItemAt(index: number)", + "restfulName": "ItemAt", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "index", + "dataType": "number", + "isCollection": false, + "description": "Index value of the object to be retrieved. Zero-indexed.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.6" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/conditionalrangefill.json b/scripts/jsonFiles/source/conditionalrangefill.json index 1369c08..c9d2f9a 100644 --- a/scripts/jsonFiles/source/conditionalrangefill.json +++ b/scripts/jsonFiles/source/conditionalrangefill.json @@ -1,48 +1,48 @@ -{ - "name": "ConditionalRangeFill", - "description": "Represents the background of a conditional range object.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "color", - "dataType": "string", - "description": "HTML color code representing the color of the fill, of the form #RRGGBB (e.g. \"FFA500\") or as a named HTML color (e.g. \"orange\").", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "clear", - "returnType": "void", - "description": "Resets the fill.", - "syntax": "conditionalRangeFillObject.clear();", - "signature": "clear()", - "restfulName": "clear", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.6" - } - ] +{ + "name": "ConditionalRangeFill", + "description": "Represents the background of a conditional range object.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "color", + "dataType": "string", + "description": "HTML color code representing the color of the fill, of the form #RRGGBB (e.g. \"FFA500\") or as a named HTML color (e.g. \"orange\").", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "clear", + "returnType": "void", + "description": "Resets the fill.", + "syntax": "conditionalRangeFillObject.clear();", + "signature": "clear()", + "restfulName": "clear", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.6" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/conditionalrangefont.json b/scripts/jsonFiles/source/conditionalrangefont.json index 64a3f6f..eff5a47 100644 --- a/scripts/jsonFiles/source/conditionalrangefont.json +++ b/scripts/jsonFiles/source/conditionalrangefont.json @@ -1,96 +1,96 @@ -{ - "name": "ConditionalRangeFont", - "description": "This object represents the font attributes (font style,, color, etc.) for an object.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "bold", - "dataType": "bool", - "description": "Represents the bold status of font.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "color", - "dataType": "string", - "description": "HTML color code representation of the text color. E.g. #FF0000 represents Red.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "italic", - "dataType": "bool", - "description": "Represents the italic status of the font.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "strikethrough", - "dataType": "bool", - "description": "Represents the strikethrough status of the font.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "underline", - "dataType": "string", - "description": "Type of underline applied to the font.", - "isReadOnly": false, - "enumNameJs": "Excel.ConditionalRangeFontUnderlineStyle", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "clear", - "returnType": "void", - "description": "Resets the font formats.", - "syntax": "conditionalRangeFontObject.clear();", - "signature": "clear()", - "restfulName": "clear", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.6" - } - ] +{ + "name": "ConditionalRangeFont", + "description": "This object represents the font attributes (font style,, color, etc.) for an object.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "bold", + "dataType": "bool", + "description": "Represents the bold status of font.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "color", + "dataType": "string", + "description": "HTML color code representation of the text color. E.g. #FF0000 represents Red.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "italic", + "dataType": "bool", + "description": "Represents the italic status of the font.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "strikethrough", + "dataType": "bool", + "description": "Represents the strikethrough status of the font.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "underline", + "dataType": "string", + "description": "Type of underline applied to the font.", + "isReadOnly": false, + "enumNameJs": "Excel.ConditionalRangeFontUnderlineStyle", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "clear", + "returnType": "void", + "description": "Resets the font formats.", + "syntax": "conditionalRangeFontObject.clear();", + "signature": "clear()", + "restfulName": "clear", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.6" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/conditionalrangeformat.json b/scripts/jsonFiles/source/conditionalrangeformat.json index bd26bd6..edfe70f 100644 --- a/scripts/jsonFiles/source/conditionalrangeformat.json +++ b/scripts/jsonFiles/source/conditionalrangeformat.json @@ -1,71 +1,71 @@ -{ - "name": "ConditionalRangeFormat", - "description": "A format object encapsulating the conditional formats range's font, fill, borders, and other properties.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "fill", - "dataType": "ConditionalRangeFill", - "description": "Returns the fill object defined on the overall conditional format range.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "borders", - "dataType": "ConditionalRangeBorderCollection", - "description": "Collection of border objects that apply to the overall conditional format range.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "font", - "dataType": "ConditionalRangeFont", - "description": "Returns the font object defined on the overall conditional format range.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "numberFormat", - "dataType": "object", - "description": "Represents Excel's number format code for the given range. Cleared if null is passed in.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ConditionalRangeFormat", + "description": "A format object encapsulating the conditional formats range's font, fill, borders, and other properties.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "fill", + "dataType": "ConditionalRangeFill", + "description": "Returns the fill object defined on the overall conditional format range.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "borders", + "dataType": "ConditionalRangeBorderCollection", + "description": "Collection of border objects that apply to the overall conditional format range.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "font", + "dataType": "ConditionalRangeFont", + "description": "Returns the font object defined on the overall conditional format range.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "numberFormat", + "dataType": "object", + "description": "Represents Excel's number format code for the given range. Cleared if null is passed in.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/conditionaltextcomparisonrule.json b/scripts/jsonFiles/source/conditionaltextcomparisonrule.json index ed1b0c6..e604623 100644 --- a/scripts/jsonFiles/source/conditionaltextcomparisonrule.json +++ b/scripts/jsonFiles/source/conditionaltextcomparisonrule.json @@ -1,47 +1,47 @@ -{ - "name": "ConditionalTextComparisonRule", - "description": "Represents a Cell Value Conditional Format Rule", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "operator", - "dataType": "string", - "description": "The operator of the text conditional format.", - "isReadOnly": false, - "enumNameJs": "Excel.ConditionalTextOperator", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "text", - "dataType": "string", - "description": "The Text value of conditional format.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ConditionalTextComparisonRule", + "description": "Represents a Cell Value Conditional Format Rule", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "operator", + "dataType": "string", + "description": "The operator of the text conditional format.", + "isReadOnly": false, + "enumNameJs": "Excel.ConditionalTextOperator", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "text", + "dataType": "string", + "description": "The Text value of conditional format.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/conditionaltopbottomrule.json b/scripts/jsonFiles/source/conditionaltopbottomrule.json index 9b1cdbd..9facbf1 100644 --- a/scripts/jsonFiles/source/conditionaltopbottomrule.json +++ b/scripts/jsonFiles/source/conditionaltopbottomrule.json @@ -1,47 +1,47 @@ -{ - "name": "ConditionalTopBottomRule", - "description": "Represents the rule of the topbottom conditional format.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "type", - "dataType": "string", - "description": "Format values based on the top or bottom rank.", - "isReadOnly": false, - "enumNameJs": "Excel.ConditionalTopBottomCriterionType", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "rank", - "dataType": "int", - "description": "The rank between 1 and 1000 for numeric ranks or 1 and 100 for percent ranks.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "ConditionalTopBottomRule", + "description": "Represents the rule of the topbottom conditional format.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "type", + "dataType": "string", + "description": "Format values based on the top or bottom rank.", + "isReadOnly": false, + "enumNameJs": "Excel.ConditionalTopBottomCriterionType", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "rank", + "dataType": "int", + "description": "The rank between 1 and 1000 for numeric ranks or 1 and 100 for percent ranks.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/customconditionalformat.json b/scripts/jsonFiles/source/customconditionalformat.json index 845502c..3a3cff1 100644 --- a/scripts/jsonFiles/source/customconditionalformat.json +++ b/scripts/jsonFiles/source/customconditionalformat.json @@ -1,47 +1,47 @@ -{ - "name": "CustomConditionalFormat", - "description": "Represents a custom conditional format type.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "rule", - "dataType": "ConditionalFormatRule", - "description": "Represents the Rule object on this conditional format.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "format", - "dataType": "ConditionalRangeFormat", - "description": "Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "CustomConditionalFormat", + "description": "Represents a custom conditional format type.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "rule", + "dataType": "ConditionalFormatRule", + "description": "Represents the Rule object on this conditional format.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "format", + "dataType": "ConditionalRangeFormat", + "description": "Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/customxmlpart.json b/scripts/jsonFiles/source/customxmlpart.json index b4d6f56..4698213 100644 --- a/scripts/jsonFiles/source/customxmlpart.json +++ b/scripts/jsonFiles/source/customxmlpart.json @@ -1,94 +1,94 @@ -{ - "name": "CustomXmlPart", - "description": "Represents a custom XML part object in a workbook.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.5", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "id", - "dataType": "string", - "description": "The custom XML part's ID.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.5", - "isKey": null, - "notes": null - }, - { - "name": "namespaceUri", - "dataType": "string", - "description": "The custom XML part's namespace URI.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.5", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "delete", - "returnType": "void", - "description": "Deletes the custom XML part.", - "syntax": "customXmlPartObject.delete();", - "signature": "delete()", - "restfulName": "delete", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.5" - }, - { - "name": "getXml", - "returnType": "string", - "description": "Gets the custom XML part's full XML content.", - "syntax": "customXmlPartObject.getXml();", - "signature": "getXml()", - "restfulName": "Xml", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.5" - }, - { - "name": "setXml", - "returnType": "void", - "description": "Sets the custom XML part's full XML content.", - "syntax": "customXmlPartObject.setXml(xml);", - "signature": "setXml(xml: string)", - "restfulName": "setXml", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "xml", - "dataType": "string", - "isCollection": false, - "description": "XML content for the part.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.5" - } - ] +{ + "name": "CustomXmlPart", + "description": "Represents a custom XML part object in a workbook.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.5", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "id", + "dataType": "string", + "description": "The custom XML part's ID.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.5", + "isKey": null, + "notes": null + }, + { + "name": "namespaceUri", + "dataType": "string", + "description": "The custom XML part's namespace URI.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.5", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "delete", + "returnType": "void", + "description": "Deletes the custom XML part.", + "syntax": "customXmlPartObject.delete();", + "signature": "delete()", + "restfulName": "delete", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.5" + }, + { + "name": "getXml", + "returnType": "string", + "description": "Gets the custom XML part's full XML content.", + "syntax": "customXmlPartObject.getXml();", + "signature": "getXml()", + "restfulName": "Xml", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.5" + }, + { + "name": "setXml", + "returnType": "void", + "description": "Sets the custom XML part's full XML content.", + "syntax": "customXmlPartObject.setXml(xml);", + "signature": "setXml(xml: string)", + "restfulName": "setXml", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "xml", + "dataType": "string", + "isCollection": false, + "description": "XML content for the part.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.5" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/customxmlpartcollection.json b/scripts/jsonFiles/source/customxmlpartcollection.json index 0d41b9a..5ab62e6 100644 --- a/scripts/jsonFiles/source/customxmlpartcollection.json +++ b/scripts/jsonFiles/source/customxmlpartcollection.json @@ -1,136 +1,136 @@ -{ - "name": "CustomXmlPartCollection", - "description": "A collection of custom XML parts.", - "isCollection": true, - "collectionOf": "CustomXmlPart", - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.5", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "items", - "dataType": "CustomXmlPart[]", - "description": "A collection of customXmlPart objects.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": false, - "reqSet": "1.5", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getItem", - "returnType": "CustomXmlPart", - "description": "Gets a custom XML part based on its ID.", - "syntax": "customXmlPartCollectionObject.getItem(id);", - "signature": "getItem(id: string)", - "restfulName": "Item", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "id", - "dataType": "string", - "isCollection": false, - "description": "ID of the object to be retrieved.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.5" - }, - { - "name": "add", - "returnType": "CustomXmlPart", - "description": "Adds a new custom XML part to the workbook.", - "syntax": "customXmlPartCollectionObject.add(xml);", - "signature": "add(xml: string)", - "restfulName": "add", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "xml", - "dataType": "string", - "isCollection": false, - "description": "XML content. Must be a valid XML fragment.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.5" - }, - { - "name": "getByNamespace", - "returnType": "CustomXmlPartScopedCollection", - "description": "Gets a new scoped collection of custom XML parts whose namespaces match the given namespace.", - "syntax": "customXmlPartCollectionObject.getByNamespace(namespaceUri);", - "signature": "getByNamespace(namespaceUri: string)", - "restfulName": "ByNamespace", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "namespaceUri", - "dataType": "string", - "isCollection": false, - "description": "", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.5" - }, - { - "name": "getCount", - "returnType": "int", - "description": "Gets the number of CustomXml parts in the collection.", - "syntax": "customXmlPartCollectionObject.getCount();", - "signature": "getCount()", - "restfulName": "Count", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.5" - }, - { - "name": "getItemOrNullObject", - "returnType": "CustomXmlPart", - "description": "Gets a custom XML part based on its ID.", - "syntax": "customXmlPartCollectionObject.getItemOrNullObject(id);", - "signature": "getItemOrNullObject(id: string)", - "restfulName": "ItemOrNullObject", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "id", - "dataType": "string", - "isCollection": false, - "description": "ID of the object to be retrieved.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.5" - } - ] +{ + "name": "CustomXmlPartCollection", + "description": "A collection of custom XML parts.", + "isCollection": true, + "collectionOf": "CustomXmlPart", + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.5", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "items", + "dataType": "CustomXmlPart[]", + "description": "A collection of customXmlPart objects.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": false, + "reqSet": "1.5", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getItem", + "returnType": "CustomXmlPart", + "description": "Gets a custom XML part based on its ID.", + "syntax": "customXmlPartCollectionObject.getItem(id);", + "signature": "getItem(id: string)", + "restfulName": "Item", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "id", + "dataType": "string", + "isCollection": false, + "description": "ID of the object to be retrieved.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.5" + }, + { + "name": "add", + "returnType": "CustomXmlPart", + "description": "Adds a new custom XML part to the workbook.", + "syntax": "customXmlPartCollectionObject.add(xml);", + "signature": "add(xml: string)", + "restfulName": "add", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "xml", + "dataType": "string", + "isCollection": false, + "description": "XML content. Must be a valid XML fragment.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.5" + }, + { + "name": "getByNamespace", + "returnType": "CustomXmlPartScopedCollection", + "description": "Gets a new scoped collection of custom XML parts whose namespaces match the given namespace.", + "syntax": "customXmlPartCollectionObject.getByNamespace(namespaceUri);", + "signature": "getByNamespace(namespaceUri: string)", + "restfulName": "ByNamespace", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "namespaceUri", + "dataType": "string", + "isCollection": false, + "description": "", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.5" + }, + { + "name": "getCount", + "returnType": "int", + "description": "Gets the number of CustomXml parts in the collection.", + "syntax": "customXmlPartCollectionObject.getCount();", + "signature": "getCount()", + "restfulName": "Count", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.5" + }, + { + "name": "getItemOrNullObject", + "returnType": "CustomXmlPart", + "description": "Gets a custom XML part based on its ID.", + "syntax": "customXmlPartCollectionObject.getItemOrNullObject(id);", + "signature": "getItemOrNullObject(id: string)", + "restfulName": "ItemOrNullObject", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "id", + "dataType": "string", + "isCollection": false, + "description": "ID of the object to be retrieved.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.5" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/customxmlpartscopedcollection.json b/scripts/jsonFiles/source/customxmlpartscopedcollection.json index 56567b3..dcdd7c2 100644 --- a/scripts/jsonFiles/source/customxmlpartscopedcollection.json +++ b/scripts/jsonFiles/source/customxmlpartscopedcollection.json @@ -1,116 +1,116 @@ -{ - "name": "CustomXmlPartScopedCollection", - "description": "A scoped collection of custom XML parts.", - "isCollection": true, - "collectionOf": "CustomXmlPart", - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.5", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "items", - "dataType": "CustomXmlPartScoped[]", - "description": "A collection of customXmlPartScoped objects.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": false, - "reqSet": "1.5", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getItem", - "returnType": "CustomXmlPart", - "description": "Gets a custom XML part based on its ID.", - "syntax": "customXmlPartScopedCollectionObject.getItem(id);", - "signature": "getItem(id: string)", - "restfulName": "Item", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "id", - "dataType": "string", - "isCollection": false, - "description": "ID of the object to be retrieved.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.5" - }, - { - "name": "getCount", - "returnType": "int", - "description": "Gets the number of CustomXML parts in this collection.", - "syntax": "customXmlPartScopedCollectionObject.getCount();", - "signature": "getCount()", - "restfulName": "Count", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.5" - }, - { - "name": "getItemOrNullObject", - "returnType": "CustomXmlPart", - "description": "Gets a custom XML part based on its ID.", - "syntax": "customXmlPartScopedCollectionObject.getItemOrNullObject(id);", - "signature": "getItemOrNullObject(id: string)", - "restfulName": "ItemOrNullObject", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "id", - "dataType": "string", - "isCollection": false, - "description": "ID of the object to be retrieved.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.5" - }, - { - "name": "getOnlyItem", - "returnType": "CustomXmlPart", - "description": "If the collection contains exactly one item, this method returns it.", - "syntax": "customXmlPartScopedCollectionObject.getOnlyItem();", - "signature": "getOnlyItem()", - "restfulName": "OnlyItem", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.5" - }, - { - "name": "getOnlyItemOrNullObject", - "returnType": "CustomXmlPart", - "description": "If the collection contains exactly one item, this method returns it.", - "syntax": "customXmlPartScopedCollectionObject.getOnlyItemOrNullObject();", - "signature": "getOnlyItemOrNullObject()", - "restfulName": "OnlyItemOrNullObject", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.5" - } - ] +{ + "name": "CustomXmlPartScopedCollection", + "description": "A scoped collection of custom XML parts.", + "isCollection": true, + "collectionOf": "CustomXmlPart", + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.5", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "items", + "dataType": "CustomXmlPartScoped[]", + "description": "A collection of customXmlPartScoped objects.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": false, + "reqSet": "1.5", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getItem", + "returnType": "CustomXmlPart", + "description": "Gets a custom XML part based on its ID.", + "syntax": "customXmlPartScopedCollectionObject.getItem(id);", + "signature": "getItem(id: string)", + "restfulName": "Item", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "id", + "dataType": "string", + "isCollection": false, + "description": "ID of the object to be retrieved.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.5" + }, + { + "name": "getCount", + "returnType": "int", + "description": "Gets the number of CustomXML parts in this collection.", + "syntax": "customXmlPartScopedCollectionObject.getCount();", + "signature": "getCount()", + "restfulName": "Count", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.5" + }, + { + "name": "getItemOrNullObject", + "returnType": "CustomXmlPart", + "description": "Gets a custom XML part based on its ID.", + "syntax": "customXmlPartScopedCollectionObject.getItemOrNullObject(id);", + "signature": "getItemOrNullObject(id: string)", + "restfulName": "ItemOrNullObject", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "id", + "dataType": "string", + "isCollection": false, + "description": "ID of the object to be retrieved.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.5" + }, + { + "name": "getOnlyItem", + "returnType": "CustomXmlPart", + "description": "If the collection contains exactly one item, this method returns it.", + "syntax": "customXmlPartScopedCollectionObject.getOnlyItem();", + "signature": "getOnlyItem()", + "restfulName": "OnlyItem", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.5" + }, + { + "name": "getOnlyItemOrNullObject", + "returnType": "CustomXmlPart", + "description": "If the collection contains exactly one item, this method returns it.", + "syntax": "customXmlPartScopedCollectionObject.getOnlyItemOrNullObject();", + "signature": "getOnlyItemOrNullObject()", + "restfulName": "OnlyItemOrNullObject", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.5" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/databarconditionalformat.json b/scripts/jsonFiles/source/databarconditionalformat.json index d1dfcab..e864480 100644 --- a/scripts/jsonFiles/source/databarconditionalformat.json +++ b/scripts/jsonFiles/source/databarconditionalformat.json @@ -1,119 +1,119 @@ -{ - "name": "DataBarConditionalFormat", - "description": "Represents an Excel Conditional Data Bar Type.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "showDataBarOnly", - "dataType": "bool", - "description": "If true, hides the values from the cells where the data bar is applied.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "axisFormat", - "dataType": "string", - "description": "Representation of how the axis is determined for an Excel data bar.", - "isReadOnly": false, - "enumNameJs": "Excel.ConditionalDataBarAxisFormat", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "axisColor", - "dataType": "string", - "description": "HTML color code representing the color of the Axis line, of the form #RRGGBB (e.g. \"FFA500\") or as a named HTML color (e.g. \"orange\").", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "barDirection", - "dataType": "string", - "description": "Represents the direction that the data bar graphic should be based on.", - "isReadOnly": false, - "enumNameJs": "Excel.ConditionalDataBarDirection", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "positiveFormat", - "dataType": "ConditionalDataBarPositiveFormat", - "description": "Representation of all values to the right of the axis in an Excel data bar.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "negativeFormat", - "dataType": "ConditionalDataBarNegativeFormat", - "description": "Representation of all values to the left of the axis in an Excel data bar.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "lowerBoundRule", - "dataType": "ConditionalDataBarRule", - "description": "The rule for what consistutes the lower bound (and how to calculate it, if applicable) for a data bar.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "upperBoundRule", - "dataType": "ConditionalDataBarRule", - "description": "The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "DataBarConditionalFormat", + "description": "Represents an Excel Conditional Data Bar Type.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "showDataBarOnly", + "dataType": "bool", + "description": "If true, hides the values from the cells where the data bar is applied.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "axisFormat", + "dataType": "string", + "description": "Representation of how the axis is determined for an Excel data bar.", + "isReadOnly": false, + "enumNameJs": "Excel.ConditionalDataBarAxisFormat", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "axisColor", + "dataType": "string", + "description": "HTML color code representing the color of the Axis line, of the form #RRGGBB (e.g. \"FFA500\") or as a named HTML color (e.g. \"orange\").", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "barDirection", + "dataType": "string", + "description": "Represents the direction that the data bar graphic should be based on.", + "isReadOnly": false, + "enumNameJs": "Excel.ConditionalDataBarDirection", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "positiveFormat", + "dataType": "ConditionalDataBarPositiveFormat", + "description": "Representation of all values to the right of the axis in an Excel data bar.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "negativeFormat", + "dataType": "ConditionalDataBarNegativeFormat", + "description": "Representation of all values to the left of the axis in an Excel data bar.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "lowerBoundRule", + "dataType": "ConditionalDataBarRule", + "description": "The rule for what consistutes the lower bound (and how to calculate it, if applicable) for a data bar.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "upperBoundRule", + "dataType": "ConditionalDataBarRule", + "description": "The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/filter.json b/scripts/jsonFiles/source/filter.json index 3a67e43..1999104 100644 --- a/scripts/jsonFiles/source/filter.json +++ b/scripts/jsonFiles/source/filter.json @@ -1,308 +1,308 @@ -{ - "name": "Filter", - "description": "Manages the filtering of a table's column.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.2", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "criteria", - "dataType": "FilterCriteria", - "description": "The currently applied filter on the given column.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.2", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "apply", - "returnType": "void", - "description": "Apply the given filter criteria on the given column.", - "syntax": "filterObject.apply(criteria);", - "signature": "apply(criteria: FilterCriteria)", - "restfulName": "apply", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "criteria", - "dataType": "FilterCriteria", - "isCollection": false, - "description": "The criteria to apply.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.2" - }, - { - "name": "applyBottomItemsFilter", - "returnType": "void", - "description": "Apply a \"Bottom Item\" filter to the column for the given number of elements.", - "syntax": "filterObject.applyBottomItemsFilter(count);", - "signature": "applyBottomItemsFilter(count: number)", - "restfulName": "applyBottomItemsFilter", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "count", - "dataType": "number", - "isCollection": false, - "description": "The number of elements from the bottom to show.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.2" - }, - { - "name": "applyBottomPercentFilter", - "returnType": "void", - "description": "Apply a \"Bottom Percent\" filter to the column for the given percentage of elements.", - "syntax": "filterObject.applyBottomPercentFilter(percent);", - "signature": "applyBottomPercentFilter(percent: number)", - "restfulName": "applyBottomPercentFilter", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "percent", - "dataType": "number", - "isCollection": false, - "description": "The percentage of elements from the bottom to show.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.2" - }, - { - "name": "applyCellColorFilter", - "returnType": "void", - "description": "Apply a \"Cell Color\" filter to the column for the given color.", - "syntax": "filterObject.applyCellColorFilter(color);", - "signature": "applyCellColorFilter(color: string)", - "restfulName": "applyCellColorFilter", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "color", - "dataType": "string", - "isCollection": false, - "description": "The background color of the cells to show.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.2" - }, - { - "name": "applyDynamicFilter", - "returnType": "void", - "description": "Apply a \"Dynamic\" filter to the column.", - "syntax": "filterObject.applyDynamicFilter(criteria);", - "signature": "applyDynamicFilter(criteria: string)", - "restfulName": "applyDynamicFilter", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "criteria", - "dataType": "string", - "isCollection": false, - "description": "The dynamic criteria to apply.", - "isRequired": true, - "enumNameJs": "Excel.DynamicFilterCriteria", - "notes": null - } - ], - "reqSet": "1.2" - }, - { - "name": "applyFontColorFilter", - "returnType": "void", - "description": "Apply a \"Font Color\" filter to the column for the given color.", - "syntax": "filterObject.applyFontColorFilter(color);", - "signature": "applyFontColorFilter(color: string)", - "restfulName": "applyFontColorFilter", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "color", - "dataType": "string", - "isCollection": false, - "description": "The font color of the cells to show.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.2" - }, - { - "name": "applyValuesFilter", - "returnType": "void", - "description": "Apply a \"Values\" filter to the column for the given values.", - "syntax": "filterObject.applyValuesFilter(values);", - "signature": "applyValuesFilter(values: object[])", - "restfulName": "applyValuesFilter", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "values", - "dataType": "object[]", - "isCollection": true, - "description": "The list of values to show.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.2" - }, - { - "name": "applyTopItemsFilter", - "returnType": "void", - "description": "Apply a \"Top Item\" filter to the column for the given number of elements.", - "syntax": "filterObject.applyTopItemsFilter(count);", - "signature": "applyTopItemsFilter(count: number)", - "restfulName": "applyTopItemsFilter", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "count", - "dataType": "number", - "isCollection": false, - "description": "The number of elements from the top to show.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.2" - }, - { - "name": "applyTopPercentFilter", - "returnType": "void", - "description": "Apply a \"Top Percent\" filter to the column for the given percentage of elements.", - "syntax": "filterObject.applyTopPercentFilter(percent);", - "signature": "applyTopPercentFilter(percent: number)", - "restfulName": "applyTopPercentFilter", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "percent", - "dataType": "number", - "isCollection": false, - "description": "The percentage of elements from the top to show.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.2" - }, - { - "name": "applyIconFilter", - "returnType": "void", - "description": "Apply a \"Icon\" filter to the column for the given icon.", - "syntax": "filterObject.applyIconFilter(icon);", - "signature": "applyIconFilter(icon: Icon)", - "restfulName": "applyIconFilter", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "icon", - "dataType": "Icon", - "isCollection": false, - "description": "The icons of the cells to show.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.2" - }, - { - "name": "applyCustomFilter", - "returnType": "void", - "description": "Apply a \"Icon\" filter to the column for the given criteria strings.", - "syntax": "filterObject.applyCustomFilter(criteria1, criteria2, oper);", - "signature": "applyCustomFilter(criteria1: string, criteria2: string, oper: string)", - "restfulName": "applyCustomFilter", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "criteria1", - "dataType": "string", - "isCollection": false, - "description": "The first criteria string.", - "isRequired": true, - "enumNameJs": null, - "notes": null - }, - { - "name": "criteria2", - "dataType": "string", - "isCollection": false, - "description": "The second criteria string.", - "isRequired": false, - "enumNameJs": null, - "notes": null - }, - { - "name": "oper", - "dataType": "string", - "isCollection": false, - "description": "The operator that describes how the two criteria are joined.", - "isRequired": false, - "enumNameJs": "Excel.FilterOperator", - "notes": null - } - ], - "reqSet": "1.2" - }, - { - "name": "clear", - "returnType": "void", - "description": "Clear the filter on the given column.", - "syntax": "filterObject.clear();", - "signature": "clear()", - "restfulName": "clear", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.2" - } - ] +{ + "name": "Filter", + "description": "Manages the filtering of a table's column.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.2", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "criteria", + "dataType": "FilterCriteria", + "description": "The currently applied filter on the given column.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.2", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "apply", + "returnType": "void", + "description": "Apply the given filter criteria on the given column.", + "syntax": "filterObject.apply(criteria);", + "signature": "apply(criteria: FilterCriteria)", + "restfulName": "apply", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "criteria", + "dataType": "FilterCriteria", + "isCollection": false, + "description": "The criteria to apply.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.2" + }, + { + "name": "applyBottomItemsFilter", + "returnType": "void", + "description": "Apply a \"Bottom Item\" filter to the column for the given number of elements.", + "syntax": "filterObject.applyBottomItemsFilter(count);", + "signature": "applyBottomItemsFilter(count: number)", + "restfulName": "applyBottomItemsFilter", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "count", + "dataType": "number", + "isCollection": false, + "description": "The number of elements from the bottom to show.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.2" + }, + { + "name": "applyBottomPercentFilter", + "returnType": "void", + "description": "Apply a \"Bottom Percent\" filter to the column for the given percentage of elements.", + "syntax": "filterObject.applyBottomPercentFilter(percent);", + "signature": "applyBottomPercentFilter(percent: number)", + "restfulName": "applyBottomPercentFilter", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "percent", + "dataType": "number", + "isCollection": false, + "description": "The percentage of elements from the bottom to show.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.2" + }, + { + "name": "applyCellColorFilter", + "returnType": "void", + "description": "Apply a \"Cell Color\" filter to the column for the given color.", + "syntax": "filterObject.applyCellColorFilter(color);", + "signature": "applyCellColorFilter(color: string)", + "restfulName": "applyCellColorFilter", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "color", + "dataType": "string", + "isCollection": false, + "description": "The background color of the cells to show.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.2" + }, + { + "name": "applyDynamicFilter", + "returnType": "void", + "description": "Apply a \"Dynamic\" filter to the column.", + "syntax": "filterObject.applyDynamicFilter(criteria);", + "signature": "applyDynamicFilter(criteria: string)", + "restfulName": "applyDynamicFilter", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "criteria", + "dataType": "string", + "isCollection": false, + "description": "The dynamic criteria to apply.", + "isRequired": true, + "enumNameJs": "Excel.DynamicFilterCriteria", + "notes": null + } + ], + "reqSet": "1.2" + }, + { + "name": "applyFontColorFilter", + "returnType": "void", + "description": "Apply a \"Font Color\" filter to the column for the given color.", + "syntax": "filterObject.applyFontColorFilter(color);", + "signature": "applyFontColorFilter(color: string)", + "restfulName": "applyFontColorFilter", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "color", + "dataType": "string", + "isCollection": false, + "description": "The font color of the cells to show.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.2" + }, + { + "name": "applyValuesFilter", + "returnType": "void", + "description": "Apply a \"Values\" filter to the column for the given values.", + "syntax": "filterObject.applyValuesFilter(values);", + "signature": "applyValuesFilter(values: object[])", + "restfulName": "applyValuesFilter", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "values", + "dataType": "object[]", + "isCollection": true, + "description": "The list of values to show.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.2" + }, + { + "name": "applyTopItemsFilter", + "returnType": "void", + "description": "Apply a \"Top Item\" filter to the column for the given number of elements.", + "syntax": "filterObject.applyTopItemsFilter(count);", + "signature": "applyTopItemsFilter(count: number)", + "restfulName": "applyTopItemsFilter", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "count", + "dataType": "number", + "isCollection": false, + "description": "The number of elements from the top to show.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.2" + }, + { + "name": "applyTopPercentFilter", + "returnType": "void", + "description": "Apply a \"Top Percent\" filter to the column for the given percentage of elements.", + "syntax": "filterObject.applyTopPercentFilter(percent);", + "signature": "applyTopPercentFilter(percent: number)", + "restfulName": "applyTopPercentFilter", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "percent", + "dataType": "number", + "isCollection": false, + "description": "The percentage of elements from the top to show.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.2" + }, + { + "name": "applyIconFilter", + "returnType": "void", + "description": "Apply a \"Icon\" filter to the column for the given icon.", + "syntax": "filterObject.applyIconFilter(icon);", + "signature": "applyIconFilter(icon: Icon)", + "restfulName": "applyIconFilter", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "icon", + "dataType": "Icon", + "isCollection": false, + "description": "The icons of the cells to show.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.2" + }, + { + "name": "applyCustomFilter", + "returnType": "void", + "description": "Apply a \"Icon\" filter to the column for the given criteria strings.", + "syntax": "filterObject.applyCustomFilter(criteria1, criteria2, oper);", + "signature": "applyCustomFilter(criteria1: string, criteria2: string, oper: string)", + "restfulName": "applyCustomFilter", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "criteria1", + "dataType": "string", + "isCollection": false, + "description": "The first criteria string.", + "isRequired": true, + "enumNameJs": null, + "notes": null + }, + { + "name": "criteria2", + "dataType": "string", + "isCollection": false, + "description": "The second criteria string.", + "isRequired": false, + "enumNameJs": null, + "notes": null + }, + { + "name": "oper", + "dataType": "string", + "isCollection": false, + "description": "The operator that describes how the two criteria are joined.", + "isRequired": false, + "enumNameJs": "Excel.FilterOperator", + "notes": null + } + ], + "reqSet": "1.2" + }, + { + "name": "clear", + "returnType": "void", + "description": "Clear the filter on the given column.", + "syntax": "filterObject.clear();", + "signature": "clear()", + "restfulName": "clear", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.2" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/filtercriteria.json b/scripts/jsonFiles/source/filtercriteria.json index b768b40..9c394bd 100644 --- a/scripts/jsonFiles/source/filtercriteria.json +++ b/scripts/jsonFiles/source/filtercriteria.json @@ -1,119 +1,119 @@ -{ - "name": "FilterCriteria", - "description": "Represents the filtering criteria applied to a column.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.2", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "criterion1", - "dataType": "string", - "description": "The first criterion used to filter data. Used as an operator in the case of \"custom\" filtering.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "criterion2", - "dataType": "string", - "description": "The second criterion used to filter data. Only used as an operator in the case of \"custom\" filtering.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "color", - "dataType": "string", - "description": "The HTML color string used to filter cells. Used with \"cellColor\" and \"fontColor\" filtering.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "operator", - "dataType": "string", - "description": "The operator used to combine criterion 1 and 2 when using \"custom\" filtering.", - "isReadOnly": false, - "enumNameJs": "Excel.FilterOperator", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "icon", - "dataType": "Icon", - "description": "The icon used to filter cells. Used with \"icon\" filtering.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "dynamicCriteria", - "dataType": "string", - "description": "The dynamic criteria from the Excel.DynamicFilterCriteria set to apply on this column. Used with \"dynamic\" filtering.", - "isReadOnly": false, - "enumNameJs": "Excel.DynamicFilterCriteria", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "values", - "dataType": "object[]", - "description": "The set of values to be used as part of \"values\" filtering.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "filterOn", - "dataType": "string", - "description": "The property used by the filter to determine whether the values should stay visible.", - "isReadOnly": false, - "enumNameJs": "Excel.FilterOn", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "FilterCriteria", + "description": "Represents the filtering criteria applied to a column.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.2", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "criterion1", + "dataType": "string", + "description": "The first criterion used to filter data. Used as an operator in the case of \"custom\" filtering.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "criterion2", + "dataType": "string", + "description": "The second criterion used to filter data. Only used as an operator in the case of \"custom\" filtering.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "color", + "dataType": "string", + "description": "The HTML color string used to filter cells. Used with \"cellColor\" and \"fontColor\" filtering.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "operator", + "dataType": "string", + "description": "The operator used to combine criterion 1 and 2 when using \"custom\" filtering.", + "isReadOnly": false, + "enumNameJs": "Excel.FilterOperator", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "icon", + "dataType": "Icon", + "description": "The icon used to filter cells. Used with \"icon\" filtering.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "dynamicCriteria", + "dataType": "string", + "description": "The dynamic criteria from the Excel.DynamicFilterCriteria set to apply on this column. Used with \"dynamic\" filtering.", + "isReadOnly": false, + "enumNameJs": "Excel.DynamicFilterCriteria", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "values", + "dataType": "object[]", + "description": "The set of values to be used as part of \"values\" filtering.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "filterOn", + "dataType": "string", + "description": "The property used by the filter to determine whether the values should stay visible.", + "isReadOnly": false, + "enumNameJs": "Excel.FilterOn", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/filterdatetime.json b/scripts/jsonFiles/source/filterdatetime.json index b39dd8d..1b12957 100644 --- a/scripts/jsonFiles/source/filterdatetime.json +++ b/scripts/jsonFiles/source/filterdatetime.json @@ -1,47 +1,47 @@ -{ - "name": "FilterDatetime", - "description": "Represents how to filter a date when filtering on values.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.2", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "date", - "dataType": "string", - "description": "The date in ISO8601 format used to filter data.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "specificity", - "dataType": "string", - "description": "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 2009.", - "isReadOnly": false, - "enumNameJs": "Excel.FilterDatetimeSpecificity", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "FilterDatetime", + "description": "Represents how to filter a date when filtering on values.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.2", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "date", + "dataType": "string", + "description": "The date in ISO8601 format used to filter data.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "specificity", + "dataType": "string", + "description": "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 2009.", + "isReadOnly": false, + "enumNameJs": "Excel.FilterDatetimeSpecificity", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/formatprotection.json b/scripts/jsonFiles/source/formatprotection.json index 32dc6d5..d554c97 100644 --- a/scripts/jsonFiles/source/formatprotection.json +++ b/scripts/jsonFiles/source/formatprotection.json @@ -1,47 +1,47 @@ -{ - "name": "FormatProtection", - "description": "Represents the format protection of a range object.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.2", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "locked", - "dataType": "bool", - "description": "Indicates if Excel locks the cells in the object. A null value indicates that the entire range doesn't have uniform lock setting.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "formulaHidden", - "dataType": "bool", - "description": "Indicates if Excel hides the formula for the cells in the range. A null value indicates that the entire range doesn't have uniform formula hidden setting.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "FormatProtection", + "description": "Represents the format protection of a range object.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.2", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "locked", + "dataType": "bool", + "description": "Indicates if Excel locks the cells in the object. A null value indicates that the entire range doesn't have uniform lock setting.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "formulaHidden", + "dataType": "bool", + "description": "Indicates if Excel hides the formula for the cells in the range. A null value indicates that the entire range doesn't have uniform formula hidden setting.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/icon.json b/scripts/jsonFiles/source/icon.json index 461b6b6..3b03c6e 100644 --- a/scripts/jsonFiles/source/icon.json +++ b/scripts/jsonFiles/source/icon.json @@ -1,47 +1,47 @@ -{ - "name": "Icon", - "description": "Represents a cell icon.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.2", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "set", - "dataType": "string", - "description": "Represents the set that the icon is part of.", - "isReadOnly": false, - "enumNameJs": "Excel.IconSet", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "index", - "dataType": "int", - "description": "Represents the index of the icon in the given set.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "Icon", + "description": "Represents a cell icon.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.2", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "set", + "dataType": "string", + "description": "Represents the set that the icon is part of.", + "isReadOnly": false, + "enumNameJs": "Excel.IconSet", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "index", + "dataType": "int", + "description": "Represents the index of the icon in the given set.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/iconsetconditionalformat.json b/scripts/jsonFiles/source/iconsetconditionalformat.json index 9f970b7..b98a019 100644 --- a/scripts/jsonFiles/source/iconsetconditionalformat.json +++ b/scripts/jsonFiles/source/iconsetconditionalformat.json @@ -1,71 +1,71 @@ -{ - "name": "IconSetConditionalFormat", - "description": "Represents an IconSet criteria for conditional formatting.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "reverseIconOrder", - "dataType": "bool", - "description": "If true, reverses the icon orders for the IconSet. Note that this cannot be set if custom icons are used.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "showIconOnly", - "dataType": "bool", - "description": "If true, hides the values and only shows icons.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "style", - "dataType": "string", - "description": "If set, displays the IconSet option for the conditional format.", - "isReadOnly": false, - "enumNameJs": "Excel.IconSet", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "criteria", - "dataType": "ConditionalIconCriterion", - "description": "An array of Criteria and IconSets 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.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "IconSetConditionalFormat", + "description": "Represents an IconSet criteria for conditional formatting.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "reverseIconOrder", + "dataType": "bool", + "description": "If true, reverses the icon orders for the IconSet. Note that this cannot be set if custom icons are used.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "showIconOnly", + "dataType": "bool", + "description": "If true, hides the values and only shows icons.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "style", + "dataType": "string", + "description": "If set, displays the IconSet option for the conditional format.", + "isReadOnly": false, + "enumNameJs": "Excel.IconSet", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "criteria", + "dataType": "ConditionalIconCriterion", + "description": "An array of Criteria and IconSets 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.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/nameditem.json b/scripts/jsonFiles/source/nameditem.json index f5ee40f..bf31458 100644 --- a/scripts/jsonFiles/source/nameditem.json +++ b/scripts/jsonFiles/source/nameditem.json @@ -1,156 +1,156 @@ -{ - "name": "NamedItem", - "description": "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, reference to a range. This object can be used to obtain range object associated with names.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "name", - "dataType": "string", - "description": "The name of the object.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "type", - "dataType": "string", - "description": "Indicates the type of the value returned by the name's formula.", - "isReadOnly": true, - "enumNameJs": "Excel.NamedItemType", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "value", - "dataType": "object", - "description": "Represents the value computed by the name's formula. For a named range, will return the range address.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "visible", - "dataType": "bool", - "description": "Specifies whether the object is visible or not.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "comment", - "dataType": "string", - "description": "Represents the comment associated with this name.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.4", - "isKey": null, - "notes": null - }, - { - "name": "scope", - "dataType": "string", - "description": "Indicates whether the name is scoped to the workbook or to a specific worksheet.", - "isReadOnly": true, - "enumNameJs": "Excel.NamedItemScope", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.4", - "isKey": null, - "notes": null - }, - { - "name": "worksheet", - "dataType": "Worksheet", - "description": "Returns the worksheet on which the named item is scoped to. Throws an error if the items is scoped to the workbook instead.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.4", - "isKey": null, - "notes": null - }, - { - "name": "worksheetOrNullObject", - "dataType": "Worksheet", - "description": "Returns the worksheet on which the named item is scoped to. Returns a null object if the item is scoped to the workbook instead.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.4", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getRange", - "returnType": "Range", - "description": "Returns the range object that is associated with the name. Throws an error if the named item's type is not a range.", - "syntax": "namedItemObject.getRange();", - "signature": "getRange()", - "restfulName": "Range", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "getRangeOrNullObject", - "returnType": "Range", - "description": "Returns the range object that is associated with the name. Returns a null object if the named item's type is not a range.", - "syntax": "namedItemObject.getRangeOrNullObject();", - "signature": "getRangeOrNullObject()", - "restfulName": "RangeOrNullObject", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.4" - }, - { - "name": "delete", - "returnType": "void", - "description": "Deletes the given name.", - "syntax": "namedItemObject.delete();", - "signature": "delete()", - "restfulName": "delete", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.4" - } - ] +{ + "name": "NamedItem", + "description": "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, reference to a range. This object can be used to obtain range object associated with names.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "name", + "dataType": "string", + "description": "The name of the object.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "type", + "dataType": "string", + "description": "Indicates the type of the value returned by the name's formula.", + "isReadOnly": true, + "enumNameJs": "Excel.NamedItemType", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "value", + "dataType": "object", + "description": "Represents the value computed by the name's formula. For a named range, will return the range address.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "visible", + "dataType": "bool", + "description": "Specifies whether the object is visible or not.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "comment", + "dataType": "string", + "description": "Represents the comment associated with this name.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.4", + "isKey": null, + "notes": null + }, + { + "name": "scope", + "dataType": "string", + "description": "Indicates whether the name is scoped to the workbook or to a specific worksheet.", + "isReadOnly": true, + "enumNameJs": "Excel.NamedItemScope", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.4", + "isKey": null, + "notes": null + }, + { + "name": "worksheet", + "dataType": "Worksheet", + "description": "Returns the worksheet on which the named item is scoped to. Throws an error if the items is scoped to the workbook instead.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.4", + "isKey": null, + "notes": null + }, + { + "name": "worksheetOrNullObject", + "dataType": "Worksheet", + "description": "Returns the worksheet on which the named item is scoped to. Returns a null object if the item is scoped to the workbook instead.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.4", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getRange", + "returnType": "Range", + "description": "Returns the range object that is associated with the name. Throws an error if the named item's type is not a range.", + "syntax": "namedItemObject.getRange();", + "signature": "getRange()", + "restfulName": "Range", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "getRangeOrNullObject", + "returnType": "Range", + "description": "Returns the range object that is associated with the name. Returns a null object if the named item's type is not a range.", + "syntax": "namedItemObject.getRangeOrNullObject();", + "signature": "getRangeOrNullObject()", + "restfulName": "RangeOrNullObject", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.4" + }, + { + "name": "delete", + "returnType": "void", + "description": "Deletes the given name.", + "syntax": "namedItemObject.delete();", + "signature": "delete()", + "restfulName": "delete", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.4" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/nameditemcollection.json b/scripts/jsonFiles/source/nameditemcollection.json index 88ec276..10fef5e 100644 --- a/scripts/jsonFiles/source/nameditemcollection.json +++ b/scripts/jsonFiles/source/nameditemcollection.json @@ -1,172 +1,172 @@ -{ - "name": "NamedItemCollection", - "description": "A collection of all the nameditem objects that are part of the workbook or worksheet, depending on how it was reached.", - "isCollection": true, - "collectionOf": "NamedItem", - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "items", - "dataType": "NamedItem[]", - "description": "A collection of namedItem objects.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getItem", - "returnType": "NamedItem", - "description": "Gets a nameditem object using its name", - "syntax": "namedItemCollectionObject.getItem(name);", - "signature": "getItem(name: string)", - "restfulName": "Item", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "name", - "dataType": "string", - "isCollection": false, - "description": "nameditem name.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getItemOrNullObject", - "returnType": "NamedItem", - "description": "Gets a nameditem object using its name. If the nameditem object does not exist, will return a null object.", - "syntax": "namedItemCollectionObject.getItemOrNullObject(name);", - "signature": "getItemOrNullObject(name: string)", - "restfulName": "ItemOrNullObject", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "name", - "dataType": "string", - "isCollection": false, - "description": "nameditem name.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.4" - }, - { - "name": "add", - "returnType": "NamedItem", - "description": "Adds a new name to the collection of the given scope.", - "syntax": "namedItemCollectionObject.add(name, reference, comment);", - "signature": "add(name: string, reference: Range or string, comment: string)", - "restfulName": "add", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "name", - "dataType": "string", - "isCollection": false, - "description": "The name of the named item.", - "isRequired": true, - "enumNameJs": null, - "notes": null - }, - { - "name": "reference", - "dataType": "Range or string", - "isCollection": false, - "description": "The formula or the range that the name will refer to.", - "isRequired": true, - "enumNameJs": null, - "notes": null - }, - { - "name": "comment", - "dataType": "string", - "isCollection": false, - "description": "The comment associated with the named item", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.4" - }, - { - "name": "addFormulaLocal", - "returnType": "NamedItem", - "description": "Adds a new name to the collection of the given scope using the user's locale for the formula.", - "syntax": "namedItemCollectionObject.addFormulaLocal(name, formula, comment);", - "signature": "addFormulaLocal(name: string, formula: string, comment: string)", - "restfulName": "addFormulaLocal", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "name", - "dataType": "string", - "isCollection": false, - "description": "The \"name\" of the named item.", - "isRequired": true, - "enumNameJs": null, - "notes": null - }, - { - "name": "formula", - "dataType": "string", - "isCollection": false, - "description": "The formula in the user's locale that the name will refer to.", - "isRequired": true, - "enumNameJs": null, - "notes": null - }, - { - "name": "comment", - "dataType": "string", - "isCollection": false, - "description": "The comment associated with the named item", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.4" - }, - { - "name": "getCount", - "returnType": "int", - "description": "Gets the number of named items in the collection.", - "syntax": "namedItemCollectionObject.getCount();", - "signature": "getCount()", - "restfulName": "Count", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.4" - } - ] +{ + "name": "NamedItemCollection", + "description": "A collection of all the nameditem objects that are part of the workbook or worksheet, depending on how it was reached.", + "isCollection": true, + "collectionOf": "NamedItem", + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "items", + "dataType": "NamedItem[]", + "description": "A collection of namedItem objects.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getItem", + "returnType": "NamedItem", + "description": "Gets a nameditem object using its name", + "syntax": "namedItemCollectionObject.getItem(name);", + "signature": "getItem(name: string)", + "restfulName": "Item", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "name", + "dataType": "string", + "isCollection": false, + "description": "nameditem name.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getItemOrNullObject", + "returnType": "NamedItem", + "description": "Gets a nameditem object using its name. If the nameditem object does not exist, will return a null object.", + "syntax": "namedItemCollectionObject.getItemOrNullObject(name);", + "signature": "getItemOrNullObject(name: string)", + "restfulName": "ItemOrNullObject", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "name", + "dataType": "string", + "isCollection": false, + "description": "nameditem name.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.4" + }, + { + "name": "add", + "returnType": "NamedItem", + "description": "Adds a new name to the collection of the given scope.", + "syntax": "namedItemCollectionObject.add(name, reference, comment);", + "signature": "add(name: string, reference: Range or string, comment: string)", + "restfulName": "add", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "name", + "dataType": "string", + "isCollection": false, + "description": "The name of the named item.", + "isRequired": true, + "enumNameJs": null, + "notes": null + }, + { + "name": "reference", + "dataType": "Range or string", + "isCollection": false, + "description": "The formula or the range that the name will refer to.", + "isRequired": true, + "enumNameJs": null, + "notes": null + }, + { + "name": "comment", + "dataType": "string", + "isCollection": false, + "description": "The comment associated with the named item", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.4" + }, + { + "name": "addFormulaLocal", + "returnType": "NamedItem", + "description": "Adds a new name to the collection of the given scope using the user's locale for the formula.", + "syntax": "namedItemCollectionObject.addFormulaLocal(name, formula, comment);", + "signature": "addFormulaLocal(name: string, formula: string, comment: string)", + "restfulName": "addFormulaLocal", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "name", + "dataType": "string", + "isCollection": false, + "description": "The \"name\" of the named item.", + "isRequired": true, + "enumNameJs": null, + "notes": null + }, + { + "name": "formula", + "dataType": "string", + "isCollection": false, + "description": "The formula in the user's locale that the name will refer to.", + "isRequired": true, + "enumNameJs": null, + "notes": null + }, + { + "name": "comment", + "dataType": "string", + "isCollection": false, + "description": "The comment associated with the named item", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.4" + }, + { + "name": "getCount", + "returnType": "int", + "description": "Gets the number of named items in the collection.", + "syntax": "namedItemCollectionObject.getCount();", + "signature": "getCount()", + "restfulName": "Count", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.4" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/pivottable.json b/scripts/jsonFiles/source/pivottable.json index 6cc5710..47ff9d5 100644 --- a/scripts/jsonFiles/source/pivottable.json +++ b/scripts/jsonFiles/source/pivottable.json @@ -1,72 +1,72 @@ -{ - "name": "PivotTable", - "description": "Represents an Excel PivotTable.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.3", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "id", - "dataType": "string", - "description": "Id of the PivotTable.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.5", - "isKey": null, - "notes": null - }, - { - "name": "name", - "dataType": "string", - "description": "Name of the PivotTable.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.3", - "isKey": null, - "notes": null - }, - { - "name": "worksheet", - "dataType": "Worksheet", - "description": "The worksheet containing the current PivotTable.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.3", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "refresh", - "returnType": "void", - "description": "Refreshes the PivotTable.", - "syntax": "pivotTableObject.refresh();", - "signature": "refresh()", - "restfulName": "refresh", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.3" - } - ] +{ + "name": "PivotTable", + "description": "Represents an Excel PivotTable.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.3", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "id", + "dataType": "string", + "description": "Id of the PivotTable.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.5", + "isKey": null, + "notes": null + }, + { + "name": "name", + "dataType": "string", + "description": "Name of the PivotTable.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.3", + "isKey": null, + "notes": null + }, + { + "name": "worksheet", + "dataType": "Worksheet", + "description": "The worksheet containing the current PivotTable.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.3", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "refresh", + "returnType": "void", + "description": "Refreshes the PivotTable.", + "syntax": "pivotTableObject.refresh();", + "signature": "refresh()", + "restfulName": "refresh", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.3" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/pivottablecollection.json b/scripts/jsonFiles/source/pivottablecollection.json index 91c4cf3..227d6b0 100644 --- a/scripts/jsonFiles/source/pivottablecollection.json +++ b/scripts/jsonFiles/source/pivottablecollection.json @@ -1,104 +1,104 @@ -{ - "name": "PivotTableCollection", - "description": "Represents a collection of all the PivotTables that are part of the workbook or worksheet.", - "isCollection": true, - "collectionOf": "PivotTable", - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.3", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "items", - "dataType": "PivotTable[]", - "description": "A collection of pivotTable objects.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": false, - "reqSet": "1.3", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getItem", - "returnType": "PivotTable", - "description": "Gets a PivotTable by name.", - "syntax": "pivotTableCollectionObject.getItem(name);", - "signature": "getItem(name: string)", - "restfulName": "Item", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "name", - "dataType": "string", - "isCollection": false, - "description": "Name of the PivotTable to be retrieved.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.3" - }, - { - "name": "getItemOrNullObject", - "returnType": "PivotTable", - "description": "Gets a PivotTable by name. If the PivotTable does not exist, will return a null object.", - "syntax": "pivotTableCollectionObject.getItemOrNullObject(name);", - "signature": "getItemOrNullObject(name: string)", - "restfulName": "ItemOrNullObject", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "name", - "dataType": "string", - "isCollection": false, - "description": "Name of the PivotTable to be retrieved.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.4" - }, - { - "name": "refreshAll", - "returnType": "void", - "description": "Refreshes all the pivot tables in the collection.", - "syntax": "pivotTableCollectionObject.refreshAll();", - "signature": "refreshAll()", - "restfulName": "refreshAll", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.3" - }, - { - "name": "getCount", - "returnType": "int", - "description": "Gets the number of pivot tables in the collection.", - "syntax": "pivotTableCollectionObject.getCount();", - "signature": "getCount()", - "restfulName": "Count", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.4" - } - ] +{ + "name": "PivotTableCollection", + "description": "Represents a collection of all the PivotTables that are part of the workbook or worksheet.", + "isCollection": true, + "collectionOf": "PivotTable", + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.3", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "items", + "dataType": "PivotTable[]", + "description": "A collection of pivotTable objects.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": false, + "reqSet": "1.3", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getItem", + "returnType": "PivotTable", + "description": "Gets a PivotTable by name.", + "syntax": "pivotTableCollectionObject.getItem(name);", + "signature": "getItem(name: string)", + "restfulName": "Item", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "name", + "dataType": "string", + "isCollection": false, + "description": "Name of the PivotTable to be retrieved.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.3" + }, + { + "name": "getItemOrNullObject", + "returnType": "PivotTable", + "description": "Gets a PivotTable by name. If the PivotTable does not exist, will return a null object.", + "syntax": "pivotTableCollectionObject.getItemOrNullObject(name);", + "signature": "getItemOrNullObject(name: string)", + "restfulName": "ItemOrNullObject", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "name", + "dataType": "string", + "isCollection": false, + "description": "Name of the PivotTable to be retrieved.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.4" + }, + { + "name": "refreshAll", + "returnType": "void", + "description": "Refreshes all the pivot tables in the collection.", + "syntax": "pivotTableCollectionObject.refreshAll();", + "signature": "refreshAll()", + "restfulName": "refreshAll", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.3" + }, + { + "name": "getCount", + "returnType": "int", + "description": "Gets the number of pivot tables in the collection.", + "syntax": "pivotTableCollectionObject.getCount();", + "signature": "getCount()", + "restfulName": "Count", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.4" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/presetcriteriaconditionalformat.json b/scripts/jsonFiles/source/presetcriteriaconditionalformat.json index 2182348..cca684f 100644 --- a/scripts/jsonFiles/source/presetcriteriaconditionalformat.json +++ b/scripts/jsonFiles/source/presetcriteriaconditionalformat.json @@ -1,47 +1,47 @@ -{ - "name": "PresetCriteriaConditionalFormat", - "description": "Represents the the preset criteria conditional format such as above averagebelow averageunique valuescontains blanknonblankerrornoerror.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "rule", - "dataType": "ConditionalPresetCriteriaRule", - "description": "The rule of the conditional format.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "format", - "dataType": "ConditionalRangeFormat", - "description": "Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "PresetCriteriaConditionalFormat", + "description": "Represents the the preset criteria conditional format such as above averagebelow averageunique valuescontains blanknonblankerrornoerror.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "rule", + "dataType": "ConditionalPresetCriteriaRule", + "description": "The rule of the conditional format.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "format", + "dataType": "ConditionalRangeFormat", + "description": "Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/range.json b/scripts/jsonFiles/source/range.json index 1f3d399..0bd6938 100644 --- a/scripts/jsonFiles/source/range.json +++ b/scripts/jsonFiles/source/range.json @@ -1,807 +1,807 @@ -{ - "name": "Range", - "description": "Range represents a set of one or more contiguous cells such as a cell, a row, a column, block of cells, etc.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "address", - "dataType": "string", - "description": "Represents the range reference in A1-style. Address value will contain the Sheet reference (e.g. Sheet1!A1:B4).", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "addressLocal", - "dataType": "string", - "description": "Represents range reference for the specified range in the language of the user.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "cellCount", - "dataType": "int", - "description": "Number of cells in the range. This API will return -1 if the cell count exceeds 2^31-1 (2,147,483,647).", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "columnCount", - "dataType": "int", - "description": "Represents the total number of columns in the range.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "columnIndex", - "dataType": "int", - "description": "Represents the column number of the first cell in the range. Zero-indexed.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "conditionalFormats", - "dataType": "ConditionalFormatCollection", - "description": "Collection of ConditionalFormats that intersect the range.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "valueTypes", - "dataType": "string", - "description": "Represents the type of data of each cell.", - "isReadOnly": true, - "enumNameJs": "Excel.RangeValueType", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "format", - "dataType": "RangeFormat", - "description": "Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "formulas", - "dataType": "object[][]", - "description": "Represents the formula in A1-style notation.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "formulasLocal", - "dataType": "object[][]", - "description": "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.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "formulasR1C1", - "dataType": "object[][]", - "description": "Represents the formula in R1C1-style notation.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "hidden", - "dataType": "bool", - "description": "Represents if all cells of the current range are hidden.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "rowHidden", - "dataType": "bool", - "description": "Represents if all rows of the current range are hidden.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "columnHidden", - "dataType": "bool", - "description": "Represents if all columns of the current range are hidden.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "numberFormat", - "dataType": "object[][]", - "description": "Represents Excel's number format code for the given cell.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "rowCount", - "dataType": "int", - "description": "Returns the total number of rows in the range.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "rowIndex", - "dataType": "int", - "description": "Returns the row number of the first cell in the range. Zero-indexed.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "text", - "dataType": "object[][]", - "description": "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.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "values", - "dataType": "object[][]", - "description": "Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "worksheet", - "dataType": "Worksheet", - "description": "The worksheet containing the current range.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "sort", - "dataType": "RangeSort", - "description": "Represents the range sort of the current range.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.2", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "calculate", - "returnType": "void", - "description": "Calculates a range of cells on a worksheet.", - "syntax": "rangeObject.calculate();", - "signature": "calculate()", - "restfulName": "calculate", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.6" - }, - { - "name": "clear", - "returnType": "void", - "description": "Clear range values, format, fill, border, etc.", - "syntax": "rangeObject.clear(applyTo);", - "signature": "clear(applyTo: string)", - "restfulName": "clear", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "applyTo", - "dataType": "string", - "isCollection": false, - "description": "Determines the type of clear action.", - "isRequired": false, - "enumNameJs": "Excel.ClearApplyTo", - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "delete", - "returnType": "void", - "description": "Deletes the cells associated with the range.", - "syntax": "rangeObject.delete(shift);", - "signature": "delete(shift: string)", - "restfulName": "delete", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "shift", - "dataType": "string", - "isCollection": false, - "description": "Specifies which way to shift the cells.", - "isRequired": true, - "enumNameJs": "Excel.DeleteShiftDirection", - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getEntireColumn", - "returnType": "Range", - "description": "Gets an object that represents the entire column of the range (for example, if the current range represents cells \"B4:E11\", it's `getEntireColumn` is a range that represents columns \"B:E\").", - "syntax": "rangeObject.getEntireColumn();", - "signature": "getEntireColumn()", - "restfulName": "EntireColumn", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "getEntireRow", - "returnType": "Range", - "description": "Gets an object that represents the entire row of the range (for example, if the current range represents cells \"B4:E11\", it's `GetEntireRow` is a range that represents rows \"4:11\").", - "syntax": "rangeObject.getEntireRow();", - "signature": "getEntireRow()", - "restfulName": "EntireRow", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "getBoundingRect", - "returnType": "Range", - "description": "Gets the smallest range object that encompasses the given ranges. For example, the GetBoundingRect of \"B2:C5\" and \"D10:E15\" is \"B2:E16\".", - "syntax": "rangeObject.getBoundingRect(anotherRange);", - "signature": "getBoundingRect(anotherRange: Range or string)", - "restfulName": "BoundingRect", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "anotherRange", - "dataType": "Range or string", - "isCollection": false, - "description": "The range object or address or range name.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getCell", - "returnType": "Range", - "description": "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's stays within the worksheet grid. The returned cell is located relative to the top left cell of the range.", - "syntax": "rangeObject.getCell(row, column);", - "signature": "getCell(row: number, column: number)", - "restfulName": "Cell", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "row", - "dataType": "number", - "isCollection": false, - "description": "Row number of the cell to be retrieved. Zero-indexed.", - "isRequired": true, - "enumNameJs": null, - "notes": null - }, - { - "name": "column", - "dataType": "number", - "isCollection": false, - "description": "Column number of the cell to be retrieved. Zero-indexed.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getColumn", - "returnType": "Range", - "description": "Gets a column contained in the range.", - "syntax": "rangeObject.getColumn(column);", - "signature": "getColumn(column: number)", - "restfulName": "Column", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "column", - "dataType": "number", - "isCollection": false, - "description": "Column number of the range to be retrieved. Zero-indexed.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getColumnsAfter", - "returnType": "Range", - "description": "Gets a certain number of columns to the right of the current Range object.", - "syntax": "rangeObject.getColumnsAfter(count);", - "signature": "getColumnsAfter(count: number)", - "restfulName": "ColumnsAfter", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "count", - "dataType": "number", - "isCollection": false, - "description": "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.", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getColumnsBefore", - "returnType": "Range", - "description": "Gets a certain number of columns to the left of the current Range object.", - "syntax": "rangeObject.getColumnsBefore(count);", - "signature": "getColumnsBefore(count: number)", - "restfulName": "ColumnsBefore", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "count", - "dataType": "number", - "isCollection": false, - "description": "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.", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getResizedRange", - "returnType": "Range", - "description": "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.", - "syntax": "rangeObject.getResizedRange(deltaRows, deltaColumns);", - "signature": "getResizedRange(deltaRows: number, deltaColumns: number)", - "restfulName": "ResizedRange", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "deltaRows", - "dataType": "number", - "isCollection": false, - "description": "The number of rows by which to expand the bottom-right corner, relative to the current range. Use a positive number to expand the range, or a negative number to decrease it.", - "isRequired": true, - "enumNameJs": null, - "notes": null - }, - { - "name": "deltaColumns", - "dataType": "number", - "isCollection": false, - "description": "The number of columnsby 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.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getIntersection", - "returnType": "Range", - "description": "Gets the range object that represents the rectangular intersection of the given ranges.", - "syntax": "rangeObject.getIntersection(anotherRange);", - "signature": "getIntersection(anotherRange: Range or string)", - "restfulName": "Intersection", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "anotherRange", - "dataType": "Range or string", - "isCollection": false, - "description": "The range object or range address that will be used to determine the intersection of ranges.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getIntersectionOrNullObject", - "returnType": "Range", - "description": "Gets the range object that represents the rectangular intersection of the given ranges. If no intersection is found, will return a null object.", - "syntax": "rangeObject.getIntersectionOrNullObject(anotherRange);", - "signature": "getIntersectionOrNullObject(anotherRange: Range or string)", - "restfulName": "IntersectionOrNullObject", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "anotherRange", - "dataType": "Range or string", - "isCollection": false, - "description": "The range object or range address that will be used to determine the intersection of ranges.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.4" - }, - { - "name": "getLastCell", - "returnType": "Range", - "description": "Gets the last cell within the range. For example, the last cell of \"B2:D5\" is \"D5\".", - "syntax": "rangeObject.getLastCell();", - "signature": "getLastCell()", - "restfulName": "LastCell", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "getLastColumn", - "returnType": "Range", - "description": "Gets the last column within the range. For example, the last column of \"B2:D5\" is \"D2:D5\".", - "syntax": "rangeObject.getLastColumn();", - "signature": "getLastColumn()", - "restfulName": "LastColumn", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "getLastRow", - "returnType": "Range", - "description": "Gets the last row within the range. For example, the last row of \"B2:D5\" is \"B5:D5\".", - "syntax": "rangeObject.getLastRow();", - "signature": "getLastRow()", - "restfulName": "LastRow", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "getOffsetRange", - "returnType": "Range", - "description": "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.", - "syntax": "rangeObject.getOffsetRange(rowOffset, columnOffset);", - "signature": "getOffsetRange(rowOffset: number, columnOffset: number)", - "restfulName": "OffsetRange", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "rowOffset", - "dataType": "number", - "isCollection": false, - "description": "The number of rows (positive, negative, or 0) by which the range is to be offset. Positive values are offset downward, and negative values are offset upward.", - "isRequired": true, - "enumNameJs": null, - "notes": null - }, - { - "name": "columnOffset", - "dataType": "number", - "isCollection": false, - "description": "The number of columns (positive, negative, or 0) by which the range is to be offset. Positive values are offset to the right, and negative values are offset to the left.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getRow", - "returnType": "Range", - "description": "Gets a row contained in the range.", - "syntax": "rangeObject.getRow(row);", - "signature": "getRow(row: number)", - "restfulName": "Row", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "row", - "dataType": "number", - "isCollection": false, - "description": "Row number of the range to be retrieved. Zero-indexed.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getRowsAbove", - "returnType": "Range", - "description": "Gets a certain number of rows above the current Range object.", - "syntax": "rangeObject.getRowsAbove(count);", - "signature": "getRowsAbove(count: number)", - "restfulName": "RowsAbove", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "count", - "dataType": "number", - "isCollection": false, - "description": "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.", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getRowsBelow", - "returnType": "Range", - "description": "Gets a certain number of rows below the current Range object.", - "syntax": "rangeObject.getRowsBelow(count);", - "signature": "getRowsBelow(count: number)", - "restfulName": "RowsBelow", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "count", - "dataType": "number", - "isCollection": false, - "description": "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.", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "insert", - "returnType": "Range", - "description": "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.", - "syntax": "rangeObject.insert(shift);", - "signature": "insert(shift: string)", - "restfulName": "insert", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "shift", - "dataType": "string", - "isCollection": false, - "description": "Specifies which way to shift the cells.", - "isRequired": true, - "enumNameJs": "Excel.InsertShiftDirection", - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "merge", - "returnType": "void", - "description": "Merge the range cells into one region in the worksheet.", - "syntax": "rangeObject.merge(across);", - "signature": "merge(across: bool)", - "restfulName": "merge", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "across", - "dataType": "bool", - "isCollection": false, - "description": "Set true to merge cells in each row of the specified range as separate merged cells. The default value is false.", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.2" - }, - { - "name": "unmerge", - "returnType": "void", - "description": "Unmerge the range cells into separate cells.", - "syntax": "rangeObject.unmerge();", - "signature": "unmerge()", - "restfulName": "unmerge", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.2" - }, - { - "name": "select", - "returnType": "void", - "description": "Selects the specified range in the Excel UI.", - "syntax": "rangeObject.select();", - "signature": "select()", - "restfulName": "select", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "getUsedRange", - "returnType": "Range", - "description": "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.", - "syntax": "rangeObject.getUsedRange(valuesOnly);", - "signature": "getUsedRange(valuesOnly: bool)", - "restfulName": "UsedRange", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "valuesOnly", - "dataType": "bool", - "isCollection": false, - "description": "Considers only cells with values as used cells.", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getUsedRangeOrNullObject", - "returnType": "Range", - "description": "Returns the used range of the given range object. If there are no used cells within the range, this function will return a null object.", - "syntax": "rangeObject.getUsedRangeOrNullObject(valuesOnly);", - "signature": "getUsedRangeOrNullObject(valuesOnly: bool)", - "restfulName": "UsedRangeOrNullObject", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "valuesOnly", - "dataType": "bool", - "isCollection": false, - "description": "Considers only cells with values as used cells.", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.4" - }, - { - "name": "getVisibleView", - "returnType": "RangeView", - "description": "Represents the visible rows of the current range.", - "syntax": "rangeObject.getVisibleView();", - "signature": "getVisibleView()", - "restfulName": "VisibleView", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.3" - } - ] +{ + "name": "Range", + "description": "Range represents a set of one or more contiguous cells such as a cell, a row, a column, block of cells, etc.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "address", + "dataType": "string", + "description": "Represents the range reference in A1-style. Address value will contain the Sheet reference (e.g. Sheet1!A1:B4).", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "addressLocal", + "dataType": "string", + "description": "Represents range reference for the specified range in the language of the user.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "cellCount", + "dataType": "int", + "description": "Number of cells in the range. This API will return -1 if the cell count exceeds 2^31-1 (2,147,483,647).", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "columnCount", + "dataType": "int", + "description": "Represents the total number of columns in the range.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "columnIndex", + "dataType": "int", + "description": "Represents the column number of the first cell in the range. Zero-indexed.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "conditionalFormats", + "dataType": "ConditionalFormatCollection", + "description": "Collection of ConditionalFormats that intersect the range.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "valueTypes", + "dataType": "string", + "description": "Represents the type of data of each cell.", + "isReadOnly": true, + "enumNameJs": "Excel.RangeValueType", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "format", + "dataType": "RangeFormat", + "description": "Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "formulas", + "dataType": "object[][]", + "description": "Represents the formula in A1-style notation.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "formulasLocal", + "dataType": "object[][]", + "description": "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.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "formulasR1C1", + "dataType": "object[][]", + "description": "Represents the formula in R1C1-style notation.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "hidden", + "dataType": "bool", + "description": "Represents if all cells of the current range are hidden.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "rowHidden", + "dataType": "bool", + "description": "Represents if all rows of the current range are hidden.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "columnHidden", + "dataType": "bool", + "description": "Represents if all columns of the current range are hidden.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "numberFormat", + "dataType": "object[][]", + "description": "Represents Excel's number format code for the given cell.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "rowCount", + "dataType": "int", + "description": "Returns the total number of rows in the range.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "rowIndex", + "dataType": "int", + "description": "Returns the row number of the first cell in the range. Zero-indexed.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "text", + "dataType": "object[][]", + "description": "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.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "values", + "dataType": "object[][]", + "description": "Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "worksheet", + "dataType": "Worksheet", + "description": "The worksheet containing the current range.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "sort", + "dataType": "RangeSort", + "description": "Represents the range sort of the current range.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.2", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "calculate", + "returnType": "void", + "description": "Calculates a range of cells on a worksheet.", + "syntax": "rangeObject.calculate();", + "signature": "calculate()", + "restfulName": "calculate", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.6" + }, + { + "name": "clear", + "returnType": "void", + "description": "Clear range values, format, fill, border, etc.", + "syntax": "rangeObject.clear(applyTo);", + "signature": "clear(applyTo: string)", + "restfulName": "clear", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "applyTo", + "dataType": "string", + "isCollection": false, + "description": "Determines the type of clear action.", + "isRequired": false, + "enumNameJs": "Excel.ClearApplyTo", + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "delete", + "returnType": "void", + "description": "Deletes the cells associated with the range.", + "syntax": "rangeObject.delete(shift);", + "signature": "delete(shift: string)", + "restfulName": "delete", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "shift", + "dataType": "string", + "isCollection": false, + "description": "Specifies which way to shift the cells.", + "isRequired": true, + "enumNameJs": "Excel.DeleteShiftDirection", + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getEntireColumn", + "returnType": "Range", + "description": "Gets an object that represents the entire column of the range (for example, if the current range represents cells \"B4:E11\", it's `getEntireColumn` is a range that represents columns \"B:E\").", + "syntax": "rangeObject.getEntireColumn();", + "signature": "getEntireColumn()", + "restfulName": "EntireColumn", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "getEntireRow", + "returnType": "Range", + "description": "Gets an object that represents the entire row of the range (for example, if the current range represents cells \"B4:E11\", it's `GetEntireRow` is a range that represents rows \"4:11\").", + "syntax": "rangeObject.getEntireRow();", + "signature": "getEntireRow()", + "restfulName": "EntireRow", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "getBoundingRect", + "returnType": "Range", + "description": "Gets the smallest range object that encompasses the given ranges. For example, the GetBoundingRect of \"B2:C5\" and \"D10:E15\" is \"B2:E16\".", + "syntax": "rangeObject.getBoundingRect(anotherRange);", + "signature": "getBoundingRect(anotherRange: Range or string)", + "restfulName": "BoundingRect", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "anotherRange", + "dataType": "Range or string", + "isCollection": false, + "description": "The range object or address or range name.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getCell", + "returnType": "Range", + "description": "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's stays within the worksheet grid. The returned cell is located relative to the top left cell of the range.", + "syntax": "rangeObject.getCell(row, column);", + "signature": "getCell(row: number, column: number)", + "restfulName": "Cell", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "row", + "dataType": "number", + "isCollection": false, + "description": "Row number of the cell to be retrieved. Zero-indexed.", + "isRequired": true, + "enumNameJs": null, + "notes": null + }, + { + "name": "column", + "dataType": "number", + "isCollection": false, + "description": "Column number of the cell to be retrieved. Zero-indexed.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getColumn", + "returnType": "Range", + "description": "Gets a column contained in the range.", + "syntax": "rangeObject.getColumn(column);", + "signature": "getColumn(column: number)", + "restfulName": "Column", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "column", + "dataType": "number", + "isCollection": false, + "description": "Column number of the range to be retrieved. Zero-indexed.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getColumnsAfter", + "returnType": "Range", + "description": "Gets a certain number of columns to the right of the current Range object.", + "syntax": "rangeObject.getColumnsAfter(count);", + "signature": "getColumnsAfter(count: number)", + "restfulName": "ColumnsAfter", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "count", + "dataType": "number", + "isCollection": false, + "description": "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.", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getColumnsBefore", + "returnType": "Range", + "description": "Gets a certain number of columns to the left of the current Range object.", + "syntax": "rangeObject.getColumnsBefore(count);", + "signature": "getColumnsBefore(count: number)", + "restfulName": "ColumnsBefore", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "count", + "dataType": "number", + "isCollection": false, + "description": "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.", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getResizedRange", + "returnType": "Range", + "description": "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.", + "syntax": "rangeObject.getResizedRange(deltaRows, deltaColumns);", + "signature": "getResizedRange(deltaRows: number, deltaColumns: number)", + "restfulName": "ResizedRange", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "deltaRows", + "dataType": "number", + "isCollection": false, + "description": "The number of rows by which to expand the bottom-right corner, relative to the current range. Use a positive number to expand the range, or a negative number to decrease it.", + "isRequired": true, + "enumNameJs": null, + "notes": null + }, + { + "name": "deltaColumns", + "dataType": "number", + "isCollection": false, + "description": "The number of columnsby 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.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getIntersection", + "returnType": "Range", + "description": "Gets the range object that represents the rectangular intersection of the given ranges.", + "syntax": "rangeObject.getIntersection(anotherRange);", + "signature": "getIntersection(anotherRange: Range or string)", + "restfulName": "Intersection", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "anotherRange", + "dataType": "Range or string", + "isCollection": false, + "description": "The range object or range address that will be used to determine the intersection of ranges.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getIntersectionOrNullObject", + "returnType": "Range", + "description": "Gets the range object that represents the rectangular intersection of the given ranges. If no intersection is found, will return a null object.", + "syntax": "rangeObject.getIntersectionOrNullObject(anotherRange);", + "signature": "getIntersectionOrNullObject(anotherRange: Range or string)", + "restfulName": "IntersectionOrNullObject", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "anotherRange", + "dataType": "Range or string", + "isCollection": false, + "description": "The range object or range address that will be used to determine the intersection of ranges.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.4" + }, + { + "name": "getLastCell", + "returnType": "Range", + "description": "Gets the last cell within the range. For example, the last cell of \"B2:D5\" is \"D5\".", + "syntax": "rangeObject.getLastCell();", + "signature": "getLastCell()", + "restfulName": "LastCell", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "getLastColumn", + "returnType": "Range", + "description": "Gets the last column within the range. For example, the last column of \"B2:D5\" is \"D2:D5\".", + "syntax": "rangeObject.getLastColumn();", + "signature": "getLastColumn()", + "restfulName": "LastColumn", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "getLastRow", + "returnType": "Range", + "description": "Gets the last row within the range. For example, the last row of \"B2:D5\" is \"B5:D5\".", + "syntax": "rangeObject.getLastRow();", + "signature": "getLastRow()", + "restfulName": "LastRow", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "getOffsetRange", + "returnType": "Range", + "description": "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.", + "syntax": "rangeObject.getOffsetRange(rowOffset, columnOffset);", + "signature": "getOffsetRange(rowOffset: number, columnOffset: number)", + "restfulName": "OffsetRange", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "rowOffset", + "dataType": "number", + "isCollection": false, + "description": "The number of rows (positive, negative, or 0) by which the range is to be offset. Positive values are offset downward, and negative values are offset upward.", + "isRequired": true, + "enumNameJs": null, + "notes": null + }, + { + "name": "columnOffset", + "dataType": "number", + "isCollection": false, + "description": "The number of columns (positive, negative, or 0) by which the range is to be offset. Positive values are offset to the right, and negative values are offset to the left.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getRow", + "returnType": "Range", + "description": "Gets a row contained in the range.", + "syntax": "rangeObject.getRow(row);", + "signature": "getRow(row: number)", + "restfulName": "Row", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "row", + "dataType": "number", + "isCollection": false, + "description": "Row number of the range to be retrieved. Zero-indexed.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getRowsAbove", + "returnType": "Range", + "description": "Gets a certain number of rows above the current Range object.", + "syntax": "rangeObject.getRowsAbove(count);", + "signature": "getRowsAbove(count: number)", + "restfulName": "RowsAbove", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "count", + "dataType": "number", + "isCollection": false, + "description": "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.", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getRowsBelow", + "returnType": "Range", + "description": "Gets a certain number of rows below the current Range object.", + "syntax": "rangeObject.getRowsBelow(count);", + "signature": "getRowsBelow(count: number)", + "restfulName": "RowsBelow", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "count", + "dataType": "number", + "isCollection": false, + "description": "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.", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "insert", + "returnType": "Range", + "description": "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.", + "syntax": "rangeObject.insert(shift);", + "signature": "insert(shift: string)", + "restfulName": "insert", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "shift", + "dataType": "string", + "isCollection": false, + "description": "Specifies which way to shift the cells.", + "isRequired": true, + "enumNameJs": "Excel.InsertShiftDirection", + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "merge", + "returnType": "void", + "description": "Merge the range cells into one region in the worksheet.", + "syntax": "rangeObject.merge(across);", + "signature": "merge(across: bool)", + "restfulName": "merge", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "across", + "dataType": "bool", + "isCollection": false, + "description": "Set true to merge cells in each row of the specified range as separate merged cells. The default value is false.", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.2" + }, + { + "name": "unmerge", + "returnType": "void", + "description": "Unmerge the range cells into separate cells.", + "syntax": "rangeObject.unmerge();", + "signature": "unmerge()", + "restfulName": "unmerge", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.2" + }, + { + "name": "select", + "returnType": "void", + "description": "Selects the specified range in the Excel UI.", + "syntax": "rangeObject.select();", + "signature": "select()", + "restfulName": "select", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "getUsedRange", + "returnType": "Range", + "description": "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.", + "syntax": "rangeObject.getUsedRange(valuesOnly);", + "signature": "getUsedRange(valuesOnly: bool)", + "restfulName": "UsedRange", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "valuesOnly", + "dataType": "bool", + "isCollection": false, + "description": "Considers only cells with values as used cells.", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getUsedRangeOrNullObject", + "returnType": "Range", + "description": "Returns the used range of the given range object. If there are no used cells within the range, this function will return a null object.", + "syntax": "rangeObject.getUsedRangeOrNullObject(valuesOnly);", + "signature": "getUsedRangeOrNullObject(valuesOnly: bool)", + "restfulName": "UsedRangeOrNullObject", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "valuesOnly", + "dataType": "bool", + "isCollection": false, + "description": "Considers only cells with values as used cells.", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.4" + }, + { + "name": "getVisibleView", + "returnType": "RangeView", + "description": "Represents the visible rows of the current range.", + "syntax": "rangeObject.getVisibleView();", + "signature": "getVisibleView()", + "restfulName": "VisibleView", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.3" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/rangeborder.json b/scripts/jsonFiles/source/rangeborder.json index 218736d..bdfae76 100644 --- a/scripts/jsonFiles/source/rangeborder.json +++ b/scripts/jsonFiles/source/rangeborder.json @@ -1,83 +1,83 @@ -{ - "name": "RangeBorder", - "description": "Represents the border of an object.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "id", - "dataType": "string", - "description": "Represents border identifier.", - "isReadOnly": true, - "enumNameJs": "Excel.BorderIndex", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "color", - "dataType": "string", - "description": "HTML color code representing the color of the border line, of the form #RRGGBB (e.g. \"FFA500\") or as a named HTML color (e.g. \"orange\").", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "style", - "dataType": "string", - "description": "One of the constants of line style specifying the line style for the border.", - "isReadOnly": false, - "enumNameJs": "Excel.BorderLineStyle", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "sideIndex", - "dataType": "string", - "description": "Constant value that indicates the specific side of the border.", - "isReadOnly": true, - "enumNameJs": "Excel.BorderIndex", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "weight", - "dataType": "string", - "description": "Specifies the weight of the border around a range.", - "isReadOnly": false, - "enumNameJs": "Excel.BorderWeight", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "RangeBorder", + "description": "Represents the border of an object.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "id", + "dataType": "string", + "description": "Represents border identifier.", + "isReadOnly": true, + "enumNameJs": "Excel.BorderIndex", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "color", + "dataType": "string", + "description": "HTML color code representing the color of the border line, of the form #RRGGBB (e.g. \"FFA500\") or as a named HTML color (e.g. \"orange\").", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "style", + "dataType": "string", + "description": "One of the constants of line style specifying the line style for the border.", + "isReadOnly": false, + "enumNameJs": "Excel.BorderLineStyle", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "sideIndex", + "dataType": "string", + "description": "Constant value that indicates the specific side of the border.", + "isReadOnly": true, + "enumNameJs": "Excel.BorderIndex", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "weight", + "dataType": "string", + "description": "Specifies the weight of the border around a range.", + "isReadOnly": false, + "enumNameJs": "Excel.BorderWeight", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/rangebordercollection.json b/scripts/jsonFiles/source/rangebordercollection.json index 8834b5a..f52d91d 100644 --- a/scripts/jsonFiles/source/rangebordercollection.json +++ b/scripts/jsonFiles/source/rangebordercollection.json @@ -1,92 +1,92 @@ -{ - "name": "RangeBorderCollection", - "description": "Represents the border objects that make up the range border.", - "isCollection": true, - "collectionOf": "RangeBorder", - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "count", - "dataType": "int", - "description": "Number of border objects in the collection.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "items", - "dataType": "RangeBorder[]", - "description": "A collection of rangeBorder objects.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getItem", - "returnType": "RangeBorder", - "description": "Gets a border object using its name", - "syntax": "rangeBorderCollectionObject.getItem(index);", - "signature": "getItem(index: string)", - "restfulName": "Item", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "index", - "dataType": "string", - "isCollection": false, - "description": "Index value of the border object to be retrieved.", - "isRequired": true, - "enumNameJs": "Excel.BorderIndex", - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getItemAt", - "returnType": "RangeBorder", - "description": "Gets a border object using its index", - "syntax": "rangeBorderCollectionObject.getItemAt(index);", - "signature": "getItemAt(index: number)", - "restfulName": "ItemAt", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "index", - "dataType": "number", - "isCollection": false, - "description": "Index value of the object to be retrieved. Zero-indexed.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - } - ] +{ + "name": "RangeBorderCollection", + "description": "Represents the border objects that make up the range border.", + "isCollection": true, + "collectionOf": "RangeBorder", + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "count", + "dataType": "int", + "description": "Number of border objects in the collection.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "items", + "dataType": "RangeBorder[]", + "description": "A collection of rangeBorder objects.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getItem", + "returnType": "RangeBorder", + "description": "Gets a border object using its name", + "syntax": "rangeBorderCollectionObject.getItem(index);", + "signature": "getItem(index: string)", + "restfulName": "Item", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "index", + "dataType": "string", + "isCollection": false, + "description": "Index value of the border object to be retrieved.", + "isRequired": true, + "enumNameJs": "Excel.BorderIndex", + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getItemAt", + "returnType": "RangeBorder", + "description": "Gets a border object using its index", + "syntax": "rangeBorderCollectionObject.getItemAt(index);", + "signature": "getItemAt(index: number)", + "restfulName": "ItemAt", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "index", + "dataType": "number", + "isCollection": false, + "description": "Index value of the object to be retrieved. Zero-indexed.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/rangefill.json b/scripts/jsonFiles/source/rangefill.json index 1cc074e..9a17356 100644 --- a/scripts/jsonFiles/source/rangefill.json +++ b/scripts/jsonFiles/source/rangefill.json @@ -1,48 +1,48 @@ -{ - "name": "RangeFill", - "description": "Represents the background of a range object.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "color", - "dataType": "string", - "description": "HTML color code representing the color of the border line, of the form #RRGGBB (e.g. \"FFA500\") or as a named HTML color (e.g. \"orange\")", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "clear", - "returnType": "void", - "description": "Resets the range background.", - "syntax": "rangeFillObject.clear();", - "signature": "clear()", - "restfulName": "clear", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - } - ] +{ + "name": "RangeFill", + "description": "Represents the background of a range object.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "color", + "dataType": "string", + "description": "HTML color code representing the color of the border line, of the form #RRGGBB (e.g. \"FFA500\") or as a named HTML color (e.g. \"orange\")", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "clear", + "returnType": "void", + "description": "Resets the range background.", + "syntax": "rangeFillObject.clear();", + "signature": "clear()", + "restfulName": "clear", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/rangefont.json b/scripts/jsonFiles/source/rangefont.json index 1577101..71989e9 100644 --- a/scripts/jsonFiles/source/rangefont.json +++ b/scripts/jsonFiles/source/rangefont.json @@ -1,95 +1,95 @@ -{ - "name": "RangeFont", - "description": "This object represents the font attributes (font name, font size, color, etc.) for an object.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "bold", - "dataType": "bool", - "description": "Represents the bold status of font.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "color", - "dataType": "string", - "description": "HTML color code representation of the text color. E.g. #FF0000 represents Red.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "italic", - "dataType": "bool", - "description": "Represents the italic status of the font.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "name", - "dataType": "string", - "description": "Font name (e.g. \"Calibri\")", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "size", - "dataType": "double", - "description": "Font size.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "underline", - "dataType": "string", - "description": "Type of underline applied to the font.", - "isReadOnly": false, - "enumNameJs": "Excel.RangeUnderlineStyle", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "RangeFont", + "description": "This object represents the font attributes (font name, font size, color, etc.) for an object.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "bold", + "dataType": "bool", + "description": "Represents the bold status of font.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "color", + "dataType": "string", + "description": "HTML color code representation of the text color. E.g. #FF0000 represents Red.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "italic", + "dataType": "bool", + "description": "Represents the italic status of the font.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "name", + "dataType": "string", + "description": "Font name (e.g. \"Calibri\")", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "size", + "dataType": "double", + "description": "Font size.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "underline", + "dataType": "string", + "description": "Type of underline applied to the font.", + "isReadOnly": false, + "enumNameJs": "Excel.RangeUnderlineStyle", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/rangeformat.json b/scripts/jsonFiles/source/rangeformat.json index cbb4fc9..9b4ff0d 100644 --- a/scripts/jsonFiles/source/rangeformat.json +++ b/scripts/jsonFiles/source/rangeformat.json @@ -1,156 +1,156 @@ -{ - "name": "RangeFormat", - "description": "A format object encapsulating the range's font, fill, borders, alignment, and other properties.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "columnWidth", - "dataType": "double", - "description": "Gets or sets the width of all colums within the range. If the column widths are not uniform, null will be returned.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "fill", - "dataType": "RangeFill", - "description": "Returns the fill object defined on the overall range.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "borders", - "dataType": "RangeBorderCollection", - "description": "Collection of border objects that apply to the overall range.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "font", - "dataType": "RangeFont", - "description": "Returns the font object defined on the overall range.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "horizontalAlignment", - "dataType": "string", - "description": "Represents the horizontal alignment for the specified object.", - "isReadOnly": false, - "enumNameJs": "Excel.HorizontalAlignment", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "rowHeight", - "dataType": "double", - "description": "Gets or sets the height of all rows in the range. If the row heights are not uniform null will be returned.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "verticalAlignment", - "dataType": "string", - "description": "Represents the vertical alignment for the specified object.", - "isReadOnly": false, - "enumNameJs": "Excel.VerticalAlignment", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "wrapText", - "dataType": "bool", - "description": "Indicates if Excel wraps the text in the object. A null value indicates that the entire range doesn't have uniform wrap setting", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "protection", - "dataType": "FormatProtection", - "description": "Returns the format protection object for a range.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.2", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "autofitColumns", - "returnType": "void", - "description": "Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns.", - "syntax": "rangeFormatObject.autofitColumns();", - "signature": "autofitColumns()", - "restfulName": "autofitColumns", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.2" - }, - { - "name": "autofitRows", - "returnType": "void", - "description": "Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns.", - "syntax": "rangeFormatObject.autofitRows();", - "signature": "autofitRows()", - "restfulName": "autofitRows", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.2" - } - ] +{ + "name": "RangeFormat", + "description": "A format object encapsulating the range's font, fill, borders, alignment, and other properties.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "columnWidth", + "dataType": "double", + "description": "Gets or sets the width of all colums within the range. If the column widths are not uniform, null will be returned.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "fill", + "dataType": "RangeFill", + "description": "Returns the fill object defined on the overall range.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "borders", + "dataType": "RangeBorderCollection", + "description": "Collection of border objects that apply to the overall range.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "font", + "dataType": "RangeFont", + "description": "Returns the font object defined on the overall range.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "horizontalAlignment", + "dataType": "string", + "description": "Represents the horizontal alignment for the specified object.", + "isReadOnly": false, + "enumNameJs": "Excel.HorizontalAlignment", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "rowHeight", + "dataType": "double", + "description": "Gets or sets the height of all rows in the range. If the row heights are not uniform null will be returned.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "verticalAlignment", + "dataType": "string", + "description": "Represents the vertical alignment for the specified object.", + "isReadOnly": false, + "enumNameJs": "Excel.VerticalAlignment", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "wrapText", + "dataType": "bool", + "description": "Indicates if Excel wraps the text in the object. A null value indicates that the entire range doesn't have uniform wrap setting", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "protection", + "dataType": "FormatProtection", + "description": "Returns the format protection object for a range.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.2", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "autofitColumns", + "returnType": "void", + "description": "Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns.", + "syntax": "rangeFormatObject.autofitColumns();", + "signature": "autofitColumns()", + "restfulName": "autofitColumns", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.2" + }, + { + "name": "autofitRows", + "returnType": "void", + "description": "Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns.", + "syntax": "rangeFormatObject.autofitRows();", + "signature": "autofitRows()", + "restfulName": "autofitRows", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.2" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/rangereference.json b/scripts/jsonFiles/source/rangereference.json index 9da0540..54017c3 100644 --- a/scripts/jsonFiles/source/rangereference.json +++ b/scripts/jsonFiles/source/rangereference.json @@ -1,35 +1,35 @@ -{ - "name": "RangeReference", - "description": "Represents a string reference of the form SheetName!A1:B5, or a global or local named range.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.2", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "address", - "dataType": "string", - "description": "Represents the visible rows of the current range.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "RangeReference", + "description": "Represents a string reference of the form SheetName!A1:B5, or a global or local named range.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.2", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "address", + "dataType": "string", + "description": "Represents the visible rows of the current range.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/rangesort.json b/scripts/jsonFiles/source/rangesort.json index 29cc23f..e9201c4 100644 --- a/scripts/jsonFiles/source/rangesort.json +++ b/scripts/jsonFiles/source/rangesort.json @@ -1,81 +1,81 @@ -{ - "name": "RangeSort", - "description": "Manages sorting operations on Range objects.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.2", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": null, - "methods": [ - { - "name": "apply", - "returnType": "void", - "description": "Perform a sort operation.", - "syntax": "rangeSortObject.apply(fields, matchCase, hasHeaders, orientation, method);", - "signature": "apply(fields: SortField[], matchCase: bool, hasHeaders: bool, orientation: string, method: string)", - "restfulName": "apply", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "fields", - "dataType": "SortField[]", - "isCollection": true, - "description": "The list of conditions to sort on.", - "isRequired": true, - "enumNameJs": null, - "notes": null - }, - { - "name": "matchCase", - "dataType": "bool", - "isCollection": false, - "description": "Whether to have the casing impact string ordering.", - "isRequired": false, - "enumNameJs": null, - "notes": null - }, - { - "name": "hasHeaders", - "dataType": "bool", - "isCollection": false, - "description": "Whether the range has a header.", - "isRequired": false, - "enumNameJs": null, - "notes": null - }, - { - "name": "orientation", - "dataType": "string", - "isCollection": false, - "description": "Whether the operation is sorting rows or columns.", - "isRequired": false, - "enumNameJs": "Excel.SortOrientation", - "notes": null - }, - { - "name": "method", - "dataType": "string", - "isCollection": false, - "description": "The ordering method used for Chinese characters.", - "isRequired": false, - "enumNameJs": "Excel.SortMethod", - "notes": null - } - ], - "reqSet": "1.2" - } - ] +{ + "name": "RangeSort", + "description": "Manages sorting operations on Range objects.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.2", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": null, + "methods": [ + { + "name": "apply", + "returnType": "void", + "description": "Perform a sort operation.", + "syntax": "rangeSortObject.apply(fields, matchCase, hasHeaders, orientation, method);", + "signature": "apply(fields: SortField[], matchCase: bool, hasHeaders: bool, orientation: string, method: string)", + "restfulName": "apply", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "fields", + "dataType": "SortField[]", + "isCollection": true, + "description": "The list of conditions to sort on.", + "isRequired": true, + "enumNameJs": null, + "notes": null + }, + { + "name": "matchCase", + "dataType": "bool", + "isCollection": false, + "description": "Whether to have the casing impact string ordering.", + "isRequired": false, + "enumNameJs": null, + "notes": null + }, + { + "name": "hasHeaders", + "dataType": "bool", + "isCollection": false, + "description": "Whether the range has a header.", + "isRequired": false, + "enumNameJs": null, + "notes": null + }, + { + "name": "orientation", + "dataType": "string", + "isCollection": false, + "description": "Whether the operation is sorting rows or columns.", + "isRequired": false, + "enumNameJs": "Excel.SortOrientation", + "notes": null + }, + { + "name": "method", + "dataType": "string", + "isCollection": false, + "description": "The ordering method used for Chinese characters.", + "isRequired": false, + "enumNameJs": "Excel.SortMethod", + "notes": null + } + ], + "reqSet": "1.2" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/rangeview.json b/scripts/jsonFiles/source/rangeview.json index 064f7b1..967eccd 100644 --- a/scripts/jsonFiles/source/rangeview.json +++ b/scripts/jsonFiles/source/rangeview.json @@ -1,180 +1,180 @@ -{ - "name": "RangeView", - "description": "RangeView represents a set of visible cells of the parent range.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.3", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "index", - "dataType": "int", - "description": "Returns a value that represents the index of the RangeView.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.3", - "isKey": null, - "notes": null - }, - { - "name": "cellAddresses", - "dataType": "object[][]", - "description": "Represents the cell addresses of the RangeView.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.3", - "isKey": null, - "notes": null - }, - { - "name": "formulas", - "dataType": "object[][]", - "description": "Represents the formula in A1-style notation.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.3", - "isKey": null, - "notes": null - }, - { - "name": "formulasLocal", - "dataType": "object[][]", - "description": "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.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.3", - "isKey": null, - "notes": null - }, - { - "name": "formulasR1C1", - "dataType": "object[][]", - "description": "Represents the formula in R1C1-style notation.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.3", - "isKey": null, - "notes": null - }, - { - "name": "numberFormat", - "dataType": "object[][]", - "description": "Represents Excel's number format code for the given cell.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.3", - "isKey": null, - "notes": null - }, - { - "name": "values", - "dataType": "object[][]", - "description": "Represents the raw values of the specified range view. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.3", - "isKey": null, - "notes": null - }, - { - "name": "valueTypes", - "dataType": "string", - "description": "Represents the type of data of each cell.", - "isReadOnly": true, - "enumNameJs": "Excel.RangeValueType", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.3", - "isKey": null, - "notes": null - }, - { - "name": "text", - "dataType": "object[][]", - "description": "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.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.3", - "isKey": null, - "notes": null - }, - { - "name": "rows", - "dataType": "RangeViewCollection", - "description": "Represents a collection of range views associated with the range.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": true, - "reqSet": "1.3", - "isKey": null, - "notes": null - }, - { - "name": "rowCount", - "dataType": "int", - "description": "Returns the number of visible rows.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.3", - "isKey": null, - "notes": null - }, - { - "name": "columnCount", - "dataType": "int", - "description": "Returns the number of visible columns.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.3", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getRange", - "returnType": "Range", - "description": "Gets the parent range associated with the current RangeView.", - "syntax": "rangeViewObject.getRange();", - "signature": "getRange()", - "restfulName": "Range", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.3" - } - ] +{ + "name": "RangeView", + "description": "RangeView represents a set of visible cells of the parent range.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.3", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "index", + "dataType": "int", + "description": "Returns a value that represents the index of the RangeView.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.3", + "isKey": null, + "notes": null + }, + { + "name": "cellAddresses", + "dataType": "object[][]", + "description": "Represents the cell addresses of the RangeView.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.3", + "isKey": null, + "notes": null + }, + { + "name": "formulas", + "dataType": "object[][]", + "description": "Represents the formula in A1-style notation.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.3", + "isKey": null, + "notes": null + }, + { + "name": "formulasLocal", + "dataType": "object[][]", + "description": "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.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.3", + "isKey": null, + "notes": null + }, + { + "name": "formulasR1C1", + "dataType": "object[][]", + "description": "Represents the formula in R1C1-style notation.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.3", + "isKey": null, + "notes": null + }, + { + "name": "numberFormat", + "dataType": "object[][]", + "description": "Represents Excel's number format code for the given cell.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.3", + "isKey": null, + "notes": null + }, + { + "name": "values", + "dataType": "object[][]", + "description": "Represents the raw values of the specified range view. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.3", + "isKey": null, + "notes": null + }, + { + "name": "valueTypes", + "dataType": "string", + "description": "Represents the type of data of each cell.", + "isReadOnly": true, + "enumNameJs": "Excel.RangeValueType", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.3", + "isKey": null, + "notes": null + }, + { + "name": "text", + "dataType": "object[][]", + "description": "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.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.3", + "isKey": null, + "notes": null + }, + { + "name": "rows", + "dataType": "RangeViewCollection", + "description": "Represents a collection of range views associated with the range.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": true, + "reqSet": "1.3", + "isKey": null, + "notes": null + }, + { + "name": "rowCount", + "dataType": "int", + "description": "Returns the number of visible rows.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.3", + "isKey": null, + "notes": null + }, + { + "name": "columnCount", + "dataType": "int", + "description": "Returns the number of visible columns.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.3", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getRange", + "returnType": "Range", + "description": "Gets the parent range associated with the current RangeView.", + "syntax": "rangeViewObject.getRange();", + "signature": "getRange()", + "restfulName": "Range", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.3" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/rangeviewcollection.json b/scripts/jsonFiles/source/rangeviewcollection.json index 3d293a7..386d73f 100644 --- a/scripts/jsonFiles/source/rangeviewcollection.json +++ b/scripts/jsonFiles/source/rangeviewcollection.json @@ -1,70 +1,70 @@ -{ - "name": "RangeViewCollection", - "description": "Represents a collection of RangeView objects.", - "isCollection": true, - "collectionOf": "RangeView", - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.3", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "items", - "dataType": "RangeView[]", - "description": "A collection of rangeView objects.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": false, - "reqSet": "1.3", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getItemAt", - "returnType": "RangeView", - "description": "Gets a RangeView Row via it's index. Zero-Indexed.", - "syntax": "rangeViewCollectionObject.getItemAt(index);", - "signature": "getItemAt(index: number)", - "restfulName": "ItemAt", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "index", - "dataType": "number", - "isCollection": false, - "description": "Index of the visible row.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.3" - }, - { - "name": "getCount", - "returnType": "int", - "description": "Gets the number of RangeView objects in the collection.", - "syntax": "rangeViewCollectionObject.getCount();", - "signature": "getCount()", - "restfulName": "Count", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.4" - } - ] +{ + "name": "RangeViewCollection", + "description": "Represents a collection of RangeView objects.", + "isCollection": true, + "collectionOf": "RangeView", + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.3", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "items", + "dataType": "RangeView[]", + "description": "A collection of rangeView objects.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": false, + "reqSet": "1.3", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getItemAt", + "returnType": "RangeView", + "description": "Gets a RangeView Row via it's index. Zero-Indexed.", + "syntax": "rangeViewCollectionObject.getItemAt(index);", + "signature": "getItemAt(index: number)", + "restfulName": "ItemAt", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "index", + "dataType": "number", + "isCollection": false, + "description": "Index of the visible row.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.3" + }, + { + "name": "getCount", + "returnType": "int", + "description": "Gets the number of RangeView objects in the collection.", + "syntax": "rangeViewCollectionObject.getCount();", + "signature": "getCount()", + "restfulName": "Count", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.4" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/selectionchangedeventargs.json b/scripts/jsonFiles/source/selectionchangedeventargs.json index 8537e37..b5480b2 100644 --- a/scripts/jsonFiles/source/selectionchangedeventargs.json +++ b/scripts/jsonFiles/source/selectionchangedeventargs.json @@ -1,35 +1,35 @@ -{ - "name": "SelectionChangedEventArgs", - "description": "Provides information about the document that raised the SelectionChanged event.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "workbook", - "dataType": "Workbook", - "description": "Gets the workbook object that raised the SelectionChanged event.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "SelectionChangedEventArgs", + "description": "Provides information about the document that raised the SelectionChanged event.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "workbook", + "dataType": "Workbook", + "description": "Gets the workbook object that raised the SelectionChanged event.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/setting.json b/scripts/jsonFiles/source/setting.json index 985f07d..e1cc263 100644 --- a/scripts/jsonFiles/source/setting.json +++ b/scripts/jsonFiles/source/setting.json @@ -1,60 +1,60 @@ -{ - "name": "Setting", - "description": "Setting represents a key-value pair of a setting persisted to the document.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.4", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "key", - "dataType": "string", - "description": "Returns the key that represents the id of the Setting.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.4", - "isKey": null, - "notes": null - }, - { - "name": "value", - "dataType": "object", - "description": "Represents the value stored for this setting.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.4", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "delete", - "returnType": "void", - "description": "Deletes the setting.", - "syntax": "settingObject.delete();", - "signature": "delete()", - "restfulName": "delete", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.4" - } - ] +{ + "name": "Setting", + "description": "Setting represents a key-value pair of a setting persisted to the document.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.4", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "key", + "dataType": "string", + "description": "Returns the key that represents the id of the Setting.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.4", + "isKey": null, + "notes": null + }, + { + "name": "value", + "dataType": "object", + "description": "Represents the value stored for this setting.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.4", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "delete", + "returnType": "void", + "description": "Deletes the setting.", + "syntax": "settingObject.delete();", + "signature": "delete()", + "restfulName": "delete", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.4" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/settingcollection.json b/scripts/jsonFiles/source/settingcollection.json index 6a42e2d..829deac 100644 --- a/scripts/jsonFiles/source/settingcollection.json +++ b/scripts/jsonFiles/source/settingcollection.json @@ -1,123 +1,123 @@ -{ - "name": "SettingCollection", - "description": "Represents a collection of worksheet objects that are part of the workbook.", - "isCollection": true, - "collectionOf": "Setting", - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.4", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "items", - "dataType": "Setting[]", - "description": "A collection of setting objects.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": false, - "reqSet": "1.4", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getItem", - "returnType": "Setting", - "description": "Gets a Setting entry via the key.", - "syntax": "settingCollectionObject.getItem(key);", - "signature": "getItem(key: string)", - "restfulName": "Item", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "key", - "dataType": "string", - "isCollection": false, - "description": "Key of the setting.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.4" - }, - { - "name": "add", - "returnType": "Setting", - "description": "Sets or adds the specified setting to the workbook.", - "syntax": "settingCollectionObject.add(key, value);", - "signature": "add(key: string, value: (any)[])", - "restfulName": "add", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "key", - "dataType": "string", - "isCollection": false, - "description": "The Key of the new setting.", - "isRequired": true, - "enumNameJs": null, - "notes": null - }, - { - "name": "value", - "dataType": "(any)[]", - "isCollection": true, - "description": "The Value for the new setting.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.4" - }, - { - "name": "getItemOrNullObject", - "returnType": "Setting", - "description": "Gets a Setting entry via the key. If the Setting does not exist, will return a null object.", - "syntax": "settingCollectionObject.getItemOrNullObject(key);", - "signature": "getItemOrNullObject(key: string)", - "restfulName": "ItemOrNullObject", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "key", - "dataType": "string", - "isCollection": false, - "description": "The key of the setting.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.4" - }, - { - "name": "getCount", - "returnType": "int", - "description": "Gets the number of Settings in the collection.", - "syntax": "settingCollectionObject.getCount();", - "signature": "getCount()", - "restfulName": "Count", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.4" - } - ] +{ + "name": "SettingCollection", + "description": "Represents a collection of worksheet objects that are part of the workbook.", + "isCollection": true, + "collectionOf": "Setting", + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.4", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "items", + "dataType": "Setting[]", + "description": "A collection of setting objects.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": false, + "reqSet": "1.4", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getItem", + "returnType": "Setting", + "description": "Gets a Setting entry via the key.", + "syntax": "settingCollectionObject.getItem(key);", + "signature": "getItem(key: string)", + "restfulName": "Item", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "key", + "dataType": "string", + "isCollection": false, + "description": "Key of the setting.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.4" + }, + { + "name": "add", + "returnType": "Setting", + "description": "Sets or adds the specified setting to the workbook.", + "syntax": "settingCollectionObject.add(key, value);", + "signature": "add(key: string, value: (any)[])", + "restfulName": "add", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "key", + "dataType": "string", + "isCollection": false, + "description": "The Key of the new setting.", + "isRequired": true, + "enumNameJs": null, + "notes": null + }, + { + "name": "value", + "dataType": "(any)[]", + "isCollection": true, + "description": "The Value for the new setting.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.4" + }, + { + "name": "getItemOrNullObject", + "returnType": "Setting", + "description": "Gets a Setting entry via the key. If the Setting does not exist, will return a null object.", + "syntax": "settingCollectionObject.getItemOrNullObject(key);", + "signature": "getItemOrNullObject(key: string)", + "restfulName": "ItemOrNullObject", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "key", + "dataType": "string", + "isCollection": false, + "description": "The key of the setting.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.4" + }, + { + "name": "getCount", + "returnType": "int", + "description": "Gets the number of Settings in the collection.", + "syntax": "settingCollectionObject.getCount();", + "signature": "getCount()", + "restfulName": "Count", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.4" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/settingschangedeventargs.json b/scripts/jsonFiles/source/settingschangedeventargs.json index df99a9c..ec1d3c0 100644 --- a/scripts/jsonFiles/source/settingschangedeventargs.json +++ b/scripts/jsonFiles/source/settingschangedeventargs.json @@ -1,35 +1,35 @@ -{ - "name": "SettingsChangedEventArgs", - "description": "Provides information about the setting that raised the SettingsChanged event", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.4", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "settings", - "dataType": "SettingCollection", - "description": "Gets the Setting object that represents the binding that raised the SettingsChanged event", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": true, - "isRelationship": true, - "reqSet": "1.4", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "SettingsChangedEventArgs", + "description": "Provides information about the setting that raised the SettingsChanged event", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.4", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "settings", + "dataType": "SettingCollection", + "description": "Gets the Setting object that represents the binding that raised the SettingsChanged event", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": true, + "isRelationship": true, + "reqSet": "1.4", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/sortfield.json b/scripts/jsonFiles/source/sortfield.json index 554c7c1..4124491 100644 --- a/scripts/jsonFiles/source/sortfield.json +++ b/scripts/jsonFiles/source/sortfield.json @@ -1,95 +1,95 @@ -{ - "name": "SortField", - "description": "Represents a condition in a sorting operation.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.2", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "key", - "dataType": "int", - "description": "Represents the column (or row, depending on the sort orientation) that the condition is on. Represented as an offset from the first column (or row).", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "sortOn", - "dataType": "string", - "description": "Represents the type of sorting of this condition.", - "isReadOnly": false, - "enumNameJs": "Excel.SortOn", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "ascending", - "dataType": "bool", - "description": "Represents whether the sorting is done in an ascending fashion.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "color", - "dataType": "string", - "description": "Represents the color that is the target of the condition if the sorting is on font or cell color.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "dataOption", - "dataType": "string", - "description": "Represents additional sorting options for this field.", - "isReadOnly": false, - "enumNameJs": "Excel.SortDataOption", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "icon", - "dataType": "Icon", - "description": "Represents the icon that is the target of the condition if the sorting is on the cell's icon.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.2", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "SortField", + "description": "Represents a condition in a sorting operation.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.2", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "key", + "dataType": "int", + "description": "Represents the column (or row, depending on the sort orientation) that the condition is on. Represented as an offset from the first column (or row).", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "sortOn", + "dataType": "string", + "description": "Represents the type of sorting of this condition.", + "isReadOnly": false, + "enumNameJs": "Excel.SortOn", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "ascending", + "dataType": "bool", + "description": "Represents whether the sorting is done in an ascending fashion.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "color", + "dataType": "string", + "description": "Represents the color that is the target of the condition if the sorting is on font or cell color.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "dataOption", + "dataType": "string", + "description": "Represents additional sorting options for this field.", + "isReadOnly": false, + "enumNameJs": "Excel.SortDataOption", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "icon", + "dataType": "Icon", + "description": "Represents the icon that is the target of the condition if the sorting is on the cell's icon.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.2", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/table.json b/scripts/jsonFiles/source/table.json index 26035c9..0ea1e0c 100644 --- a/scripts/jsonFiles/source/table.json +++ b/scripts/jsonFiles/source/table.json @@ -1,288 +1,288 @@ -{ - "name": "Table", - "description": "Represents an Excel table.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "id", - "dataType": "int", - "description": "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.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "name", - "dataType": "string", - "description": "Name of the table.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "showHeaders", - "dataType": "bool", - "description": "Indicates whether the header row is visible or not. This value can be set to show or remove the header row.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "showTotals", - "dataType": "bool", - "description": "Indicates whether the total row is visible or not. This value can be set to show or remove the total row.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "highlightFirstColumn", - "dataType": "bool", - "description": "Indicates whether the first column contains special formatting.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.3", - "isKey": null, - "notes": null - }, - { - "name": "highlightLastColumn", - "dataType": "bool", - "description": "Indicates whether the last column contains special formatting.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.3", - "isKey": null, - "notes": null - }, - { - "name": "showBandedRows", - "dataType": "bool", - "description": "Indicates whether the rows show banded formatting in which odd rows are highlighted differently from even ones to make reading the table easier.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.3", - "isKey": null, - "notes": null - }, - { - "name": "showBandedColumns", - "dataType": "bool", - "description": "Indicates whether the columns show banded formatting in which odd columns are highlighted differently from even ones to make reading the table easier.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.3", - "isKey": null, - "notes": null - }, - { - "name": "showFilterButton", - "dataType": "bool", - "description": "Indicates whether the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.3", - "isKey": null, - "notes": null - }, - { - "name": "style", - "dataType": "string", - "description": "Constant value that represents the Table style. Possible values are: TableStyleLight1 thru TableStyleLight21, TableStyleMedium1 thru TableStyleMedium28, TableStyleStyleDark1 thru TableStyleStyleDark11. A custom user-defined style present in the workbook can also be specified.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "columns", - "dataType": "TableColumnCollection", - "description": "Represents a collection of all the columns in the table.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "rows", - "dataType": "TableRowCollection", - "description": "Represents a collection of all the rows in the table.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "worksheet", - "dataType": "Worksheet", - "description": "The worksheet containing the current table.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "sort", - "dataType": "TableSort", - "description": "Represents the sorting for the table.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.2", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getRange", - "returnType": "Range", - "description": "Gets the range object associated with the entire table.", - "syntax": "tableObject.getRange();", - "signature": "getRange()", - "restfulName": "Range", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "getHeaderRowRange", - "returnType": "Range", - "description": "Gets the range object associated with header row of the table.", - "syntax": "tableObject.getHeaderRowRange();", - "signature": "getHeaderRowRange()", - "restfulName": "HeaderRowRange", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "getDataBodyRange", - "returnType": "Range", - "description": "Gets the range object associated with the data body of the table.", - "syntax": "tableObject.getDataBodyRange();", - "signature": "getDataBodyRange()", - "restfulName": "DataBodyRange", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "getTotalRowRange", - "returnType": "Range", - "description": "Gets the range object associated with totals row of the table.", - "syntax": "tableObject.getTotalRowRange();", - "signature": "getTotalRowRange()", - "restfulName": "TotalRowRange", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "delete", - "returnType": "void", - "description": "Deletes the table.", - "syntax": "tableObject.delete();", - "signature": "delete()", - "restfulName": "delete", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "convertToRange", - "returnType": "Range", - "description": "Converts the table into a normal range of cells. All data is preserved.", - "syntax": "tableObject.convertToRange();", - "signature": "convertToRange()", - "restfulName": "convertToRange", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.2" - }, - { - "name": "clearFilters", - "returnType": "void", - "description": "Clears all the filters currently applied on the table.", - "syntax": "tableObject.clearFilters();", - "signature": "clearFilters()", - "restfulName": "clearFilters", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.2" - }, - { - "name": "reapplyFilters", - "returnType": "void", - "description": "Reapplies all the filters currently on the table.", - "syntax": "tableObject.reapplyFilters();", - "signature": "reapplyFilters()", - "restfulName": "reapplyFilters", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.2" - } - ] +{ + "name": "Table", + "description": "Represents an Excel table.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "id", + "dataType": "int", + "description": "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.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "name", + "dataType": "string", + "description": "Name of the table.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "showHeaders", + "dataType": "bool", + "description": "Indicates whether the header row is visible or not. This value can be set to show or remove the header row.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "showTotals", + "dataType": "bool", + "description": "Indicates whether the total row is visible or not. This value can be set to show or remove the total row.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "highlightFirstColumn", + "dataType": "bool", + "description": "Indicates whether the first column contains special formatting.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.3", + "isKey": null, + "notes": null + }, + { + "name": "highlightLastColumn", + "dataType": "bool", + "description": "Indicates whether the last column contains special formatting.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.3", + "isKey": null, + "notes": null + }, + { + "name": "showBandedRows", + "dataType": "bool", + "description": "Indicates whether the rows show banded formatting in which odd rows are highlighted differently from even ones to make reading the table easier.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.3", + "isKey": null, + "notes": null + }, + { + "name": "showBandedColumns", + "dataType": "bool", + "description": "Indicates whether the columns show banded formatting in which odd columns are highlighted differently from even ones to make reading the table easier.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.3", + "isKey": null, + "notes": null + }, + { + "name": "showFilterButton", + "dataType": "bool", + "description": "Indicates whether the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.3", + "isKey": null, + "notes": null + }, + { + "name": "style", + "dataType": "string", + "description": "Constant value that represents the Table style. Possible values are: TableStyleLight1 thru TableStyleLight21, TableStyleMedium1 thru TableStyleMedium28, TableStyleStyleDark1 thru TableStyleStyleDark11. A custom user-defined style present in the workbook can also be specified.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "columns", + "dataType": "TableColumnCollection", + "description": "Represents a collection of all the columns in the table.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "rows", + "dataType": "TableRowCollection", + "description": "Represents a collection of all the rows in the table.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "worksheet", + "dataType": "Worksheet", + "description": "The worksheet containing the current table.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "sort", + "dataType": "TableSort", + "description": "Represents the sorting for the table.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.2", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getRange", + "returnType": "Range", + "description": "Gets the range object associated with the entire table.", + "syntax": "tableObject.getRange();", + "signature": "getRange()", + "restfulName": "Range", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "getHeaderRowRange", + "returnType": "Range", + "description": "Gets the range object associated with header row of the table.", + "syntax": "tableObject.getHeaderRowRange();", + "signature": "getHeaderRowRange()", + "restfulName": "HeaderRowRange", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "getDataBodyRange", + "returnType": "Range", + "description": "Gets the range object associated with the data body of the table.", + "syntax": "tableObject.getDataBodyRange();", + "signature": "getDataBodyRange()", + "restfulName": "DataBodyRange", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "getTotalRowRange", + "returnType": "Range", + "description": "Gets the range object associated with totals row of the table.", + "syntax": "tableObject.getTotalRowRange();", + "signature": "getTotalRowRange()", + "restfulName": "TotalRowRange", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "delete", + "returnType": "void", + "description": "Deletes the table.", + "syntax": "tableObject.delete();", + "signature": "delete()", + "restfulName": "delete", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "convertToRange", + "returnType": "Range", + "description": "Converts the table into a normal range of cells. All data is preserved.", + "syntax": "tableObject.convertToRange();", + "signature": "convertToRange()", + "restfulName": "convertToRange", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.2" + }, + { + "name": "clearFilters", + "returnType": "void", + "description": "Clears all the filters currently applied on the table.", + "syntax": "tableObject.clearFilters();", + "signature": "clearFilters()", + "restfulName": "clearFilters", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.2" + }, + { + "name": "reapplyFilters", + "returnType": "void", + "description": "Reapplies all the filters currently on the table.", + "syntax": "tableObject.reapplyFilters();", + "signature": "reapplyFilters()", + "restfulName": "reapplyFilters", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.2" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/tablecollection.json b/scripts/jsonFiles/source/tablecollection.json index 9970261..c24322c 100644 --- a/scripts/jsonFiles/source/tablecollection.json +++ b/scripts/jsonFiles/source/tablecollection.json @@ -1,157 +1,157 @@ -{ - "name": "TableCollection", - "description": "Represents a collection of all the tables that are part of the workbook or worksheet, depending on how it was reached.", - "isCollection": true, - "collectionOf": "Table", - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "count", - "dataType": "int", - "description": "Returns the number of tables in the workbook.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "items", - "dataType": "Table[]", - "description": "A collection of table objects.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getItem", - "returnType": "Table", - "description": "Gets a table by Name or ID.", - "syntax": "tableCollectionObject.getItem(key);", - "signature": "getItem(key: number or string)", - "restfulName": "Item", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "key", - "dataType": "number or string", - "isCollection": false, - "description": "Name or ID of the table to be retrieved.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getItemOrNullObject", - "returnType": "Table", - "description": "Gets a table by Name or ID. If the table does not exist, will return a null object.", - "syntax": "tableCollectionObject.getItemOrNullObject(key);", - "signature": "getItemOrNullObject(key: number or string)", - "restfulName": "ItemOrNullObject", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "key", - "dataType": "number or string", - "isCollection": false, - "description": "Name or ID of the table to be retrieved.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.4" - }, - { - "name": "getCount", - "returnType": "int", - "description": "Gets the number of tables in the collection.", - "syntax": "tableCollectionObject.getCount();", - "signature": "getCount()", - "restfulName": "Count", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.4" - }, - { - "name": "getItemAt", - "returnType": "Table", - "description": "Gets a table based on its position in the collection.", - "syntax": "tableCollectionObject.getItemAt(index);", - "signature": "getItemAt(index: number)", - "restfulName": "ItemAt", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "index", - "dataType": "number", - "isCollection": false, - "description": "Index value of the object to be retrieved. Zero-indexed.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "add", - "returnType": "Table", - "description": "Create 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.", - "syntax": "tableCollectionObject.add(address, hasHeaders);", - "signature": "add(address: object, hasHeaders: bool)", - "restfulName": "add", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "address", - "dataType": "object", - "isCollection": false, - "description": "A Range object, or a string address or name of the range representing the data source. If the address does not contain a sheet name, the currently-active sheet is used.", - "isRequired": true, - "enumNameJs": null, - "notes": null - }, - { - "name": "hasHeaders", - "dataType": "bool", - "isCollection": false, - "description": "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 header shifting the data down by one row.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - } - ] +{ + "name": "TableCollection", + "description": "Represents a collection of all the tables that are part of the workbook or worksheet, depending on how it was reached.", + "isCollection": true, + "collectionOf": "Table", + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "count", + "dataType": "int", + "description": "Returns the number of tables in the workbook.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "items", + "dataType": "Table[]", + "description": "A collection of table objects.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getItem", + "returnType": "Table", + "description": "Gets a table by Name or ID.", + "syntax": "tableCollectionObject.getItem(key);", + "signature": "getItem(key: number or string)", + "restfulName": "Item", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "key", + "dataType": "number or string", + "isCollection": false, + "description": "Name or ID of the table to be retrieved.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getItemOrNullObject", + "returnType": "Table", + "description": "Gets a table by Name or ID. If the table does not exist, will return a null object.", + "syntax": "tableCollectionObject.getItemOrNullObject(key);", + "signature": "getItemOrNullObject(key: number or string)", + "restfulName": "ItemOrNullObject", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "key", + "dataType": "number or string", + "isCollection": false, + "description": "Name or ID of the table to be retrieved.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.4" + }, + { + "name": "getCount", + "returnType": "int", + "description": "Gets the number of tables in the collection.", + "syntax": "tableCollectionObject.getCount();", + "signature": "getCount()", + "restfulName": "Count", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.4" + }, + { + "name": "getItemAt", + "returnType": "Table", + "description": "Gets a table based on its position in the collection.", + "syntax": "tableCollectionObject.getItemAt(index);", + "signature": "getItemAt(index: number)", + "restfulName": "ItemAt", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "index", + "dataType": "number", + "isCollection": false, + "description": "Index value of the object to be retrieved. Zero-indexed.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "add", + "returnType": "Table", + "description": "Create 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.", + "syntax": "tableCollectionObject.add(address, hasHeaders);", + "signature": "add(address: object, hasHeaders: bool)", + "restfulName": "add", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "address", + "dataType": "object", + "isCollection": false, + "description": "A Range object, or a string address or name of the range representing the data source. If the address does not contain a sheet name, the currently-active sheet is used.", + "isRequired": true, + "enumNameJs": null, + "notes": null + }, + { + "name": "hasHeaders", + "dataType": "bool", + "isCollection": false, + "description": "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 header shifting the data down by one row.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/tablecolumn.json b/scripts/jsonFiles/source/tablecolumn.json index 6918139..9ca2b4a 100644 --- a/scripts/jsonFiles/source/tablecolumn.json +++ b/scripts/jsonFiles/source/tablecolumn.json @@ -1,144 +1,144 @@ -{ - "name": "TableColumn", - "description": "Represents a column in a table.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "id", - "dataType": "int", - "description": "Returns a unique key that identifies the column within the table.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "name", - "dataType": "string", - "description": "Represents the name of the table column.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "index", - "dataType": "int", - "description": "Returns the index number of the column within the columns collection of the table. Zero-indexed.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "values", - "dataType": "object[][]", - "description": "Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "filter", - "dataType": "Filter", - "description": "Retrieve the filter applied to the column.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.2", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getRange", - "returnType": "Range", - "description": "Gets the range object associated with the entire column.", - "syntax": "tableColumnObject.getRange();", - "signature": "getRange()", - "restfulName": "Range", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "getHeaderRowRange", - "returnType": "Range", - "description": "Gets the range object associated with the header row of the column.", - "syntax": "tableColumnObject.getHeaderRowRange();", - "signature": "getHeaderRowRange()", - "restfulName": "HeaderRowRange", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "getDataBodyRange", - "returnType": "Range", - "description": "Gets the range object associated with the data body of the column.", - "syntax": "tableColumnObject.getDataBodyRange();", - "signature": "getDataBodyRange()", - "restfulName": "DataBodyRange", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "getTotalRowRange", - "returnType": "Range", - "description": "Gets the range object associated with the totals row of the column.", - "syntax": "tableColumnObject.getTotalRowRange();", - "signature": "getTotalRowRange()", - "restfulName": "TotalRowRange", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "delete", - "returnType": "void", - "description": "Deletes the column from the table.", - "syntax": "tableColumnObject.delete();", - "signature": "delete()", - "restfulName": "delete", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - } - ] +{ + "name": "TableColumn", + "description": "Represents a column in a table.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "id", + "dataType": "int", + "description": "Returns a unique key that identifies the column within the table.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "name", + "dataType": "string", + "description": "Represents the name of the table column.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "index", + "dataType": "int", + "description": "Returns the index number of the column within the columns collection of the table. Zero-indexed.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "values", + "dataType": "object[][]", + "description": "Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "filter", + "dataType": "Filter", + "description": "Retrieve the filter applied to the column.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.2", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getRange", + "returnType": "Range", + "description": "Gets the range object associated with the entire column.", + "syntax": "tableColumnObject.getRange();", + "signature": "getRange()", + "restfulName": "Range", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "getHeaderRowRange", + "returnType": "Range", + "description": "Gets the range object associated with the header row of the column.", + "syntax": "tableColumnObject.getHeaderRowRange();", + "signature": "getHeaderRowRange()", + "restfulName": "HeaderRowRange", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "getDataBodyRange", + "returnType": "Range", + "description": "Gets the range object associated with the data body of the column.", + "syntax": "tableColumnObject.getDataBodyRange();", + "signature": "getDataBodyRange()", + "restfulName": "DataBodyRange", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "getTotalRowRange", + "returnType": "Range", + "description": "Gets the range object associated with the totals row of the column.", + "syntax": "tableColumnObject.getTotalRowRange();", + "signature": "getTotalRowRange()", + "restfulName": "TotalRowRange", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "delete", + "returnType": "void", + "description": "Deletes the column from the table.", + "syntax": "tableColumnObject.delete();", + "signature": "delete()", + "restfulName": "delete", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/tablecolumncollection.json b/scripts/jsonFiles/source/tablecolumncollection.json index ffd569f..018cb29 100644 --- a/scripts/jsonFiles/source/tablecolumncollection.json +++ b/scripts/jsonFiles/source/tablecolumncollection.json @@ -1,166 +1,166 @@ -{ - "name": "TableColumnCollection", - "description": "Represents a collection of all the columns that are part of the table.", - "isCollection": true, - "collectionOf": "TableColumn", - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "count", - "dataType": "int", - "description": "Returns the number of columns in the table.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "items", - "dataType": "TableColumn[]", - "description": "A collection of tableColumn objects.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getItem", - "returnType": "TableColumn", - "description": "Gets a column object by Name or ID.", - "syntax": "tableColumnCollectionObject.getItem(key);", - "signature": "getItem(key: object)", - "restfulName": "Item", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "key", - "dataType": "object", - "isCollection": false, - "description": " Column Name or ID.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getItemOrNullObject", - "returnType": "TableColumn", - "description": "Gets a column object by Name or ID. If the column does not exist, will return a null object.", - "syntax": "tableColumnCollectionObject.getItemOrNullObject(key);", - "signature": "getItemOrNullObject(key: object)", - "restfulName": "ItemOrNullObject", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "key", - "dataType": "object", - "isCollection": false, - "description": " Column Name or ID.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.4" - }, - { - "name": "getCount", - "returnType": "int", - "description": "Gets the number of columns in the table.", - "syntax": "tableColumnCollectionObject.getCount();", - "signature": "getCount()", - "restfulName": "Count", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.4" - }, - { - "name": "getItemAt", - "returnType": "TableColumn", - "description": "Gets a column based on its position in the collection.", - "syntax": "tableColumnCollectionObject.getItemAt(index);", - "signature": "getItemAt(index: number)", - "restfulName": "ItemAt", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "index", - "dataType": "number", - "isCollection": false, - "description": "Index value of the object to be retrieved. Zero-indexed.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "add", - "returnType": "TableColumn", - "description": "Adds a new column to the table.", - "syntax": "tableColumnCollectionObject.add(index, values, name);", - "signature": "add(index: number, values: object, name: string)", - "restfulName": "add", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "index", - "dataType": "number", - "isCollection": false, - "description": "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.", - "isRequired": false, - "enumNameJs": null, - "notes": null - }, - { - "name": "values", - "dataType": "object", - "isCollection": false, - "description": "A 2-dimensional array of unformatted values of the table column.", - "isRequired": false, - "enumNameJs": null, - "notes": null - }, - { - "name": "name", - "dataType": "string", - "isCollection": false, - "description": "Specifies the name of the new column. If null, the default name will be used.", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - } - ] +{ + "name": "TableColumnCollection", + "description": "Represents a collection of all the columns that are part of the table.", + "isCollection": true, + "collectionOf": "TableColumn", + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "count", + "dataType": "int", + "description": "Returns the number of columns in the table.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "items", + "dataType": "TableColumn[]", + "description": "A collection of tableColumn objects.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getItem", + "returnType": "TableColumn", + "description": "Gets a column object by Name or ID.", + "syntax": "tableColumnCollectionObject.getItem(key);", + "signature": "getItem(key: object)", + "restfulName": "Item", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "key", + "dataType": "object", + "isCollection": false, + "description": " Column Name or ID.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getItemOrNullObject", + "returnType": "TableColumn", + "description": "Gets a column object by Name or ID. If the column does not exist, will return a null object.", + "syntax": "tableColumnCollectionObject.getItemOrNullObject(key);", + "signature": "getItemOrNullObject(key: object)", + "restfulName": "ItemOrNullObject", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "key", + "dataType": "object", + "isCollection": false, + "description": " Column Name or ID.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.4" + }, + { + "name": "getCount", + "returnType": "int", + "description": "Gets the number of columns in the table.", + "syntax": "tableColumnCollectionObject.getCount();", + "signature": "getCount()", + "restfulName": "Count", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.4" + }, + { + "name": "getItemAt", + "returnType": "TableColumn", + "description": "Gets a column based on its position in the collection.", + "syntax": "tableColumnCollectionObject.getItemAt(index);", + "signature": "getItemAt(index: number)", + "restfulName": "ItemAt", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "index", + "dataType": "number", + "isCollection": false, + "description": "Index value of the object to be retrieved. Zero-indexed.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "add", + "returnType": "TableColumn", + "description": "Adds a new column to the table.", + "syntax": "tableColumnCollectionObject.add(index, values, name);", + "signature": "add(index: number, values: object, name: string)", + "restfulName": "add", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "index", + "dataType": "number", + "isCollection": false, + "description": "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.", + "isRequired": false, + "enumNameJs": null, + "notes": null + }, + { + "name": "values", + "dataType": "object", + "isCollection": false, + "description": "A 2-dimensional array of unformatted values of the table column.", + "isRequired": false, + "enumNameJs": null, + "notes": null + }, + { + "name": "name", + "dataType": "string", + "isCollection": false, + "description": "Specifies the name of the new column. If null, the default name will be used.", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/tablerow.json b/scripts/jsonFiles/source/tablerow.json index 4037aa6..16bcc18 100644 --- a/scripts/jsonFiles/source/tablerow.json +++ b/scripts/jsonFiles/source/tablerow.json @@ -1,72 +1,72 @@ -{ - "name": "TableRow", - "description": "Represents a row in a table.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "index", - "dataType": "int", - "description": "Returns the index number of the row within the rows collection of the table. Zero-indexed.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "values", - "dataType": "object[][]", - "description": "Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getRange", - "returnType": "Range", - "description": "Returns the range object associated with the entire row.", - "syntax": "tableRowObject.getRange();", - "signature": "getRange()", - "restfulName": "Range", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "delete", - "returnType": "void", - "description": "Deletes the row from the table.", - "syntax": "tableRowObject.delete();", - "signature": "delete()", - "restfulName": "delete", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - } - ] +{ + "name": "TableRow", + "description": "Represents a row in a table.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "index", + "dataType": "int", + "description": "Returns the index number of the row within the rows collection of the table. Zero-indexed.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "values", + "dataType": "object[][]", + "description": "Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getRange", + "returnType": "Range", + "description": "Returns the range object associated with the entire row.", + "syntax": "tableRowObject.getRange();", + "signature": "getRange()", + "restfulName": "Range", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "delete", + "returnType": "void", + "description": "Deletes the row from the table.", + "syntax": "tableRowObject.delete();", + "signature": "delete()", + "restfulName": "delete", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/tablerowcollection.json b/scripts/jsonFiles/source/tablerowcollection.json index f190bca..00bb394 100644 --- a/scripts/jsonFiles/source/tablerowcollection.json +++ b/scripts/jsonFiles/source/tablerowcollection.json @@ -1,113 +1,113 @@ -{ - "name": "TableRowCollection", - "description": "Represents a collection of all the rows that are part of the table.", - "isCollection": true, - "collectionOf": "TableRow", - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "count", - "dataType": "int", - "description": "Returns the number of rows in the table.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "items", - "dataType": "TableRow[]", - "description": "A collection of tableRow objects.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getCount", - "returnType": "int", - "description": "Gets the number of rows in the table.", - "syntax": "tableRowCollectionObject.getCount();", - "signature": "getCount()", - "restfulName": "Count", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.4" - }, - { - "name": "getItemAt", - "returnType": "TableRow", - "description": "Gets a row based on its position in the collection.", - "syntax": "tableRowCollectionObject.getItemAt(index);", - "signature": "getItemAt(index: number)", - "restfulName": "ItemAt", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "index", - "dataType": "number", - "isCollection": false, - "description": "Index value of the object to be retrieved. Zero-indexed.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "add", - "returnType": "TableRow", - "description": "Adds one or more rows to the table. The return object will be the top of the newly added row(s).", - "syntax": "tableRowCollectionObject.add(index, values);", - "signature": "add(index: number, values: object)", - "restfulName": "add", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "index", - "dataType": "number", - "isCollection": false, - "description": "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.", - "isRequired": false, - "enumNameJs": null, - "notes": null - }, - { - "name": "values", - "dataType": "object", - "isCollection": false, - "description": "A 2-dimensional array of unformatted values of the table row.", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - } - ] +{ + "name": "TableRowCollection", + "description": "Represents a collection of all the rows that are part of the table.", + "isCollection": true, + "collectionOf": "TableRow", + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "count", + "dataType": "int", + "description": "Returns the number of rows in the table.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "items", + "dataType": "TableRow[]", + "description": "A collection of tableRow objects.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getCount", + "returnType": "int", + "description": "Gets the number of rows in the table.", + "syntax": "tableRowCollectionObject.getCount();", + "signature": "getCount()", + "restfulName": "Count", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.4" + }, + { + "name": "getItemAt", + "returnType": "TableRow", + "description": "Gets a row based on its position in the collection.", + "syntax": "tableRowCollectionObject.getItemAt(index);", + "signature": "getItemAt(index: number)", + "restfulName": "ItemAt", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "index", + "dataType": "number", + "isCollection": false, + "description": "Index value of the object to be retrieved. Zero-indexed.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "add", + "returnType": "TableRow", + "description": "Adds one or more rows to the table. The return object will be the top of the newly added row(s).", + "syntax": "tableRowCollectionObject.add(index, values);", + "signature": "add(index: number, values: object)", + "restfulName": "add", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "index", + "dataType": "number", + "isCollection": false, + "description": "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.", + "isRequired": false, + "enumNameJs": null, + "notes": null + }, + { + "name": "values", + "dataType": "object", + "isCollection": false, + "description": "A 2-dimensional array of unformatted values of the table row.", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/tablesort.json b/scripts/jsonFiles/source/tablesort.json index f0816ed..ba994a2 100644 --- a/scripts/jsonFiles/source/tablesort.json +++ b/scripts/jsonFiles/source/tablesort.json @@ -1,124 +1,124 @@ -{ - "name": "TableSort", - "description": "Manages sorting operations on Table objects.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.2", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "matchCase", - "dataType": "bool", - "description": "Represents whether the casing impacted the last sort of the table.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "method", - "dataType": "string", - "description": "Represents Chinese character ordering method last used to sort the table.", - "isReadOnly": true, - "enumNameJs": "Excel.SortMethod", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "fields", - "dataType": "SortField", - "description": "Represents the current conditions used to last sort the table.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.2", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "apply", - "returnType": "void", - "description": "Perform a sort operation.", - "syntax": "tableSortObject.apply(fields, matchCase, method);", - "signature": "apply(fields: SortField[], matchCase: bool, method: string)", - "restfulName": "apply", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "fields", - "dataType": "SortField[]", - "isCollection": true, - "description": "The list of conditions to sort on.", - "isRequired": true, - "enumNameJs": null, - "notes": null - }, - { - "name": "matchCase", - "dataType": "bool", - "isCollection": false, - "description": "Whether to have the casing impact string ordering.", - "isRequired": false, - "enumNameJs": null, - "notes": null - }, - { - "name": "method", - "dataType": "string", - "isCollection": false, - "description": "The ordering method used for Chinese characters.", - "isRequired": false, - "enumNameJs": "Excel.SortMethod", - "notes": null - } - ], - "reqSet": "1.2" - }, - { - "name": "clear", - "returnType": "void", - "description": "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.", - "syntax": "tableSortObject.clear();", - "signature": "clear()", - "restfulName": "clear", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.2" - }, - { - "name": "reapply", - "returnType": "void", - "description": "Reapplies the current sorting parameters to the table.", - "syntax": "tableSortObject.reapply();", - "signature": "reapply()", - "restfulName": "reapply", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.2" - } - ] +{ + "name": "TableSort", + "description": "Manages sorting operations on Table objects.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.2", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "matchCase", + "dataType": "bool", + "description": "Represents whether the casing impacted the last sort of the table.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "method", + "dataType": "string", + "description": "Represents Chinese character ordering method last used to sort the table.", + "isReadOnly": true, + "enumNameJs": "Excel.SortMethod", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "fields", + "dataType": "SortField", + "description": "Represents the current conditions used to last sort the table.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.2", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "apply", + "returnType": "void", + "description": "Perform a sort operation.", + "syntax": "tableSortObject.apply(fields, matchCase, method);", + "signature": "apply(fields: SortField[], matchCase: bool, method: string)", + "restfulName": "apply", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "fields", + "dataType": "SortField[]", + "isCollection": true, + "description": "The list of conditions to sort on.", + "isRequired": true, + "enumNameJs": null, + "notes": null + }, + { + "name": "matchCase", + "dataType": "bool", + "isCollection": false, + "description": "Whether to have the casing impact string ordering.", + "isRequired": false, + "enumNameJs": null, + "notes": null + }, + { + "name": "method", + "dataType": "string", + "isCollection": false, + "description": "The ordering method used for Chinese characters.", + "isRequired": false, + "enumNameJs": "Excel.SortMethod", + "notes": null + } + ], + "reqSet": "1.2" + }, + { + "name": "clear", + "returnType": "void", + "description": "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.", + "syntax": "tableSortObject.clear();", + "signature": "clear()", + "restfulName": "clear", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.2" + }, + { + "name": "reapply", + "returnType": "void", + "description": "Reapplies the current sorting parameters to the table.", + "syntax": "tableSortObject.reapply();", + "signature": "reapply()", + "restfulName": "reapply", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.2" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/textconditionalformat.json b/scripts/jsonFiles/source/textconditionalformat.json index 361b40a..be9efeb 100644 --- a/scripts/jsonFiles/source/textconditionalformat.json +++ b/scripts/jsonFiles/source/textconditionalformat.json @@ -1,47 +1,47 @@ -{ - "name": "TextConditionalFormat", - "description": "Represents a specific text conditional format.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "rule", - "dataType": "ConditionalTextComparisonRule", - "description": "The rule of the conditional format.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "format", - "dataType": "ConditionalRangeFormat", - "description": "Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "TextConditionalFormat", + "description": "Represents a specific text conditional format.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "rule", + "dataType": "ConditionalTextComparisonRule", + "description": "The rule of the conditional format.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "format", + "dataType": "ConditionalRangeFormat", + "description": "Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/topbottomconditionalformat.json b/scripts/jsonFiles/source/topbottomconditionalformat.json index c637bdd..2fdfb1c 100644 --- a/scripts/jsonFiles/source/topbottomconditionalformat.json +++ b/scripts/jsonFiles/source/topbottomconditionalformat.json @@ -1,47 +1,47 @@ -{ - "name": "TopBottomConditionalFormat", - "description": "Represents a TopBottom conditional format.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.6", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "rule", - "dataType": "ConditionalTopBottomRule", - "description": "The criteria of the TopBottom conditional format.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - }, - { - "name": "format", - "dataType": "ConditionalRangeFormat", - "description": "Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "TopBottomConditionalFormat", + "description": "Represents a TopBottom conditional format.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.6", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "rule", + "dataType": "ConditionalTopBottomRule", + "description": "The criteria of the TopBottom conditional format.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + }, + { + "name": "format", + "dataType": "ConditionalRangeFormat", + "description": "Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file diff --git a/scripts/jsonFiles/source/workbook.json b/scripts/jsonFiles/source/workbook.json index beb4548..a053333 100644 --- a/scripts/jsonFiles/source/workbook.json +++ b/scripts/jsonFiles/source/workbook.json @@ -1,158 +1,158 @@ -{ - "name": "Workbook", - "description": "Workbook is the top level object which contains related workbook objects such as worksheets, tables, ranges, etc.", - "isCollection": false, - "collectionOf": null, - "restPath": [ - "/workbook" - ], - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "application", - "dataType": "Application", - "description": "Represents Excel application instance that contains this workbook.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "customXmlParts", - "dataType": "CustomXmlPartCollection", - "description": "Represents the collection of custom XML parts contained by this workbook.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": true, - "reqSet": "1.5", - "isKey": null, - "notes": null - }, - { - "name": "functions", - "dataType": "Functions", - "description": "Represents Excel application instance that contains this workbook.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "names", - "dataType": "NamedItemCollection", - "description": "Represents a collection of workbook scoped named items (named ranges and constants).", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "worksheets", - "dataType": "WorksheetCollection", - "description": "Represents a collection of worksheets associated with the workbook.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "tables", - "dataType": "TableCollection", - "description": "Represents a collection of tables associated with the workbook.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "bindings", - "dataType": "BindingCollection", - "description": "Represents a collection of bindings that are part of the workbook.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "pivotTables", - "dataType": "PivotTableCollection", - "description": "Represents a collection of PivotTables associated with the workbook.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": true, - "reqSet": "1.3", - "isKey": null, - "notes": null - }, - { - "name": "settings", - "dataType": "SettingCollection", - "description": "Represents a collection of Settings associated with the workbook.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": true, - "reqSet": "1.4", - "isKey": null, - "notes": null - }, - { - "name": "test", - "dataType": "Test", - "description": "For internal use only.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.6", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getSelectedRange", - "returnType": "Range", - "description": "Gets the currently selected range from the workbook.", - "syntax": "workbookObject.getSelectedRange();", - "signature": "getSelectedRange()", - "restfulName": "SelectedRange", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - } - ] +{ + "name": "Workbook", + "description": "Workbook is the top level object which contains related workbook objects such as worksheets, tables, ranges, etc.", + "isCollection": false, + "collectionOf": null, + "restPath": [ + "/workbook" + ], + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "application", + "dataType": "Application", + "description": "Represents Excel application instance that contains this workbook.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "customXmlParts", + "dataType": "CustomXmlPartCollection", + "description": "Represents the collection of custom XML parts contained by this workbook.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": true, + "reqSet": "1.5", + "isKey": null, + "notes": null + }, + { + "name": "functions", + "dataType": "Functions", + "description": "Represents Excel application instance that contains this workbook.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "names", + "dataType": "NamedItemCollection", + "description": "Represents a collection of workbook scoped named items (named ranges and constants).", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "worksheets", + "dataType": "WorksheetCollection", + "description": "Represents a collection of worksheets associated with the workbook.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "tables", + "dataType": "TableCollection", + "description": "Represents a collection of tables associated with the workbook.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "bindings", + "dataType": "BindingCollection", + "description": "Represents a collection of bindings that are part of the workbook.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "pivotTables", + "dataType": "PivotTableCollection", + "description": "Represents a collection of PivotTables associated with the workbook.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": true, + "reqSet": "1.3", + "isKey": null, + "notes": null + }, + { + "name": "settings", + "dataType": "SettingCollection", + "description": "Represents a collection of Settings associated with the workbook.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": true, + "reqSet": "1.4", + "isKey": null, + "notes": null + }, + { + "name": "test", + "dataType": "Test", + "description": "For internal use only.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.6", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getSelectedRange", + "returnType": "Range", + "description": "Gets the currently selected range from the workbook.", + "syntax": "workbookObject.getSelectedRange();", + "signature": "getSelectedRange()", + "restfulName": "SelectedRange", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/worksheet.json b/scripts/jsonFiles/source/worksheet.json index 7f14594..e48703f 100644 --- a/scripts/jsonFiles/source/worksheet.json +++ b/scripts/jsonFiles/source/worksheet.json @@ -1,363 +1,363 @@ -{ - "name": "Worksheet", - "description": "An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "charts", - "dataType": "ChartCollection", - "description": "Returns collection of charts that are part of the worksheet.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "id", - "dataType": "string", - "description": "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.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "position", - "dataType": "int", - "description": "The zero-based position of the worksheet within the workbook.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "name", - "dataType": "string", - "description": "The display name of the worksheet.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "tables", - "dataType": "TableCollection", - "description": "Collection of tables that are part of the worksheet.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": true, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "visibility", - "dataType": "string", - "description": "The Visibility of the worksheet.", - "isReadOnly": false, - "enumNameJs": "Excel.SheetVisibility", - "isCollection": false, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - }, - { - "name": "protection", - "dataType": "WorksheetProtection", - "description": "Returns sheet protection object for a worksheet.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "pivotTables", - "dataType": "PivotTableCollection", - "description": "Collection of PivotTables that are part of the worksheet.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": true, - "reqSet": "1.3", - "isKey": null, - "notes": null - }, - { - "name": "names", - "dataType": "NamedItemCollection", - "description": "Collection of names scoped to the current worksheet.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": true, - "reqSet": "1.4", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "activate", - "returnType": "void", - "description": "Activate the worksheet in the Excel UI.", - "syntax": "worksheetObject.activate();", - "signature": "activate()", - "restfulName": "activate", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "calculate", - "returnType": "void", - "description": "Calculates all cells on a worksheet.", - "syntax": "worksheetObject.calculate(markAllDirty);", - "signature": "calculate(markAllDirty: bool)", - "restfulName": "calculate", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "markAllDirty", - "dataType": "bool", - "isCollection": false, - "description": "Boolean to mark as dirty.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.6" - }, - { - "name": "delete", - "returnType": "void", - "description": "Deletes the worksheet from the workbook.", - "syntax": "worksheetObject.delete();", - "signature": "delete()", - "restfulName": "delete", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "getCell", - "returnType": "Range", - "description": "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's stays within the worksheet grid.", - "syntax": "worksheetObject.getCell(row, column);", - "signature": "getCell(row: number, column: number)", - "restfulName": "Cell", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "row", - "dataType": "number", - "isCollection": false, - "description": "The row number of the cell to be retrieved. Zero-indexed.", - "isRequired": true, - "enumNameJs": null, - "notes": null - }, - { - "name": "column", - "dataType": "number", - "isCollection": false, - "description": "the column number of the cell to be retrieved. Zero-indexed.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getRange", - "returnType": "Range", - "description": "Gets the range object specified by the address or name.", - "syntax": "worksheetObject.getRange(address);", - "signature": "getRange(address: string)", - "restfulName": "Range", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "address", - "dataType": "string", - "isCollection": false, - "description": "The address or the name of the range. If not specified, the entire worksheet range is returned.", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getPrevious", - "returnType": "Worksheet", - "description": "Gets the worksheet that precedes this one. If there are no previous worksheets, this method will throw an error.", - "syntax": "worksheetObject.getPrevious(visibleOnly);", - "signature": "getPrevious(visibleOnly: bool)", - "restfulName": "Previous", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "visibleOnly", - "dataType": "bool", - "isCollection": false, - "description": "If true, considers only visible worksheets, skipping over any hidden ones.", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.5" - }, - { - "name": "getPreviousOrNullObject", - "returnType": "Worksheet", - "description": "Gets the worksheet that precedes this one. If there are no previous worksheets, this method will return a null objet.", - "syntax": "worksheetObject.getPreviousOrNullObject(visibleOnly);", - "signature": "getPreviousOrNullObject(visibleOnly: bool)", - "restfulName": "PreviousOrNullObject", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "visibleOnly", - "dataType": "bool", - "isCollection": false, - "description": "If true, considers only visible worksheets, skipping over any hidden ones.", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.5" - }, - { - "name": "getNext", - "returnType": "Worksheet", - "description": "Gets the worksheet that follows this one. If there are no worksheets following this one, this method will throw an error.", - "syntax": "worksheetObject.getNext(visibleOnly);", - "signature": "getNext(visibleOnly: bool)", - "restfulName": "Next", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "visibleOnly", - "dataType": "bool", - "isCollection": false, - "description": "If true, considers only visible worksheets, skipping over any hidden ones.", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.5" - }, - { - "name": "getNextOrNullObject", - "returnType": "Worksheet", - "description": "Gets the worksheet that follows this one. If there are no worksheets following this one, this method will return a null object.", - "syntax": "worksheetObject.getNextOrNullObject(visibleOnly);", - "signature": "getNextOrNullObject(visibleOnly: bool)", - "restfulName": "NextOrNullObject", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "visibleOnly", - "dataType": "bool", - "isCollection": false, - "description": "If true, considers only visible worksheets, skipping over any hidden ones.", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.5" - }, - { - "name": "getUsedRange", - "returnType": "Range", - "description": "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).", - "syntax": "worksheetObject.getUsedRange(valuesOnly);", - "signature": "getUsedRange(valuesOnly: bool)", - "restfulName": "UsedRange", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "valuesOnly", - "dataType": "bool", - "isCollection": false, - "description": "Considers only cells with values as used cells (ignoring formatting).", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getUsedRangeOrNullObject", - "returnType": "Range", - "description": "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 a null object.", - "syntax": "worksheetObject.getUsedRangeOrNullObject(valuesOnly);", - "signature": "getUsedRangeOrNullObject(valuesOnly: bool)", - "restfulName": "UsedRangeOrNullObject", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "valuesOnly", - "dataType": "bool", - "isCollection": false, - "description": "Considers only cells with values as used cells.", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.4" - } - ] +{ + "name": "Worksheet", + "description": "An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "charts", + "dataType": "ChartCollection", + "description": "Returns collection of charts that are part of the worksheet.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "id", + "dataType": "string", + "description": "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.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "position", + "dataType": "int", + "description": "The zero-based position of the worksheet within the workbook.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "name", + "dataType": "string", + "description": "The display name of the worksheet.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "tables", + "dataType": "TableCollection", + "description": "Collection of tables that are part of the worksheet.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": true, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "visibility", + "dataType": "string", + "description": "The Visibility of the worksheet.", + "isReadOnly": false, + "enumNameJs": "Excel.SheetVisibility", + "isCollection": false, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + }, + { + "name": "protection", + "dataType": "WorksheetProtection", + "description": "Returns sheet protection object for a worksheet.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "pivotTables", + "dataType": "PivotTableCollection", + "description": "Collection of PivotTables that are part of the worksheet.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": true, + "reqSet": "1.3", + "isKey": null, + "notes": null + }, + { + "name": "names", + "dataType": "NamedItemCollection", + "description": "Collection of names scoped to the current worksheet.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": true, + "reqSet": "1.4", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "activate", + "returnType": "void", + "description": "Activate the worksheet in the Excel UI.", + "syntax": "worksheetObject.activate();", + "signature": "activate()", + "restfulName": "activate", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "calculate", + "returnType": "void", + "description": "Calculates all cells on a worksheet.", + "syntax": "worksheetObject.calculate(markAllDirty);", + "signature": "calculate(markAllDirty: bool)", + "restfulName": "calculate", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "markAllDirty", + "dataType": "bool", + "isCollection": false, + "description": "Boolean to mark as dirty.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.6" + }, + { + "name": "delete", + "returnType": "void", + "description": "Deletes the worksheet from the workbook.", + "syntax": "worksheetObject.delete();", + "signature": "delete()", + "restfulName": "delete", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "getCell", + "returnType": "Range", + "description": "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's stays within the worksheet grid.", + "syntax": "worksheetObject.getCell(row, column);", + "signature": "getCell(row: number, column: number)", + "restfulName": "Cell", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "row", + "dataType": "number", + "isCollection": false, + "description": "The row number of the cell to be retrieved. Zero-indexed.", + "isRequired": true, + "enumNameJs": null, + "notes": null + }, + { + "name": "column", + "dataType": "number", + "isCollection": false, + "description": "the column number of the cell to be retrieved. Zero-indexed.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getRange", + "returnType": "Range", + "description": "Gets the range object specified by the address or name.", + "syntax": "worksheetObject.getRange(address);", + "signature": "getRange(address: string)", + "restfulName": "Range", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "address", + "dataType": "string", + "isCollection": false, + "description": "The address or the name of the range. If not specified, the entire worksheet range is returned.", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getPrevious", + "returnType": "Worksheet", + "description": "Gets the worksheet that precedes this one. If there are no previous worksheets, this method will throw an error.", + "syntax": "worksheetObject.getPrevious(visibleOnly);", + "signature": "getPrevious(visibleOnly: bool)", + "restfulName": "Previous", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "visibleOnly", + "dataType": "bool", + "isCollection": false, + "description": "If true, considers only visible worksheets, skipping over any hidden ones.", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.5" + }, + { + "name": "getPreviousOrNullObject", + "returnType": "Worksheet", + "description": "Gets the worksheet that precedes this one. If there are no previous worksheets, this method will return a null objet.", + "syntax": "worksheetObject.getPreviousOrNullObject(visibleOnly);", + "signature": "getPreviousOrNullObject(visibleOnly: bool)", + "restfulName": "PreviousOrNullObject", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "visibleOnly", + "dataType": "bool", + "isCollection": false, + "description": "If true, considers only visible worksheets, skipping over any hidden ones.", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.5" + }, + { + "name": "getNext", + "returnType": "Worksheet", + "description": "Gets the worksheet that follows this one. If there are no worksheets following this one, this method will throw an error.", + "syntax": "worksheetObject.getNext(visibleOnly);", + "signature": "getNext(visibleOnly: bool)", + "restfulName": "Next", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "visibleOnly", + "dataType": "bool", + "isCollection": false, + "description": "If true, considers only visible worksheets, skipping over any hidden ones.", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.5" + }, + { + "name": "getNextOrNullObject", + "returnType": "Worksheet", + "description": "Gets the worksheet that follows this one. If there are no worksheets following this one, this method will return a null object.", + "syntax": "worksheetObject.getNextOrNullObject(visibleOnly);", + "signature": "getNextOrNullObject(visibleOnly: bool)", + "restfulName": "NextOrNullObject", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "visibleOnly", + "dataType": "bool", + "isCollection": false, + "description": "If true, considers only visible worksheets, skipping over any hidden ones.", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.5" + }, + { + "name": "getUsedRange", + "returnType": "Range", + "description": "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).", + "syntax": "worksheetObject.getUsedRange(valuesOnly);", + "signature": "getUsedRange(valuesOnly: bool)", + "restfulName": "UsedRange", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "valuesOnly", + "dataType": "bool", + "isCollection": false, + "description": "Considers only cells with values as used cells (ignoring formatting).", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getUsedRangeOrNullObject", + "returnType": "Range", + "description": "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 a null object.", + "syntax": "worksheetObject.getUsedRangeOrNullObject(valuesOnly);", + "signature": "getUsedRangeOrNullObject(valuesOnly: bool)", + "restfulName": "UsedRangeOrNullObject", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "valuesOnly", + "dataType": "bool", + "isCollection": false, + "description": "Considers only cells with values as used cells.", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.4" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/worksheetcollection.json b/scripts/jsonFiles/source/worksheetcollection.json index 6753ab1..c4d1b7e 100644 --- a/scripts/jsonFiles/source/worksheetcollection.json +++ b/scripts/jsonFiles/source/worksheetcollection.json @@ -1,180 +1,180 @@ -{ - "name": "WorksheetCollection", - "description": "Represents a collection of worksheet objects that are part of the workbook.", - "isCollection": true, - "collectionOf": "Worksheet", - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.1", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "items", - "dataType": "Worksheet[]", - "description": "A collection of worksheet objects.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": true, - "isRelationship": false, - "reqSet": "1.1", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "getActiveWorksheet", - "returnType": "Worksheet", - "description": "Gets the currently active worksheet in the workbook.", - "syntax": "worksheetCollectionObject.getActiveWorksheet();", - "signature": "getActiveWorksheet()", - "restfulName": "ActiveWorksheet", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.1" - }, - { - "name": "getItem", - "returnType": "Worksheet", - "description": "Gets a worksheet object using its Name or ID.", - "syntax": "worksheetCollectionObject.getItem(key);", - "signature": "getItem(key: string)", - "restfulName": "Item", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "key", - "dataType": "string", - "isCollection": false, - "description": "The Name or ID of the worksheet.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getItemOrNullObject", - "returnType": "Worksheet", - "description": "Gets a worksheet object using its Name or ID. If the worksheet does not exist, will return a null object.", - "syntax": "worksheetCollectionObject.getItemOrNullObject(key);", - "signature": "getItemOrNullObject(key: string)", - "restfulName": "ItemOrNullObject", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "key", - "dataType": "string", - "isCollection": false, - "description": "The Name or ID of the worksheet.", - "isRequired": true, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.4" - }, - { - "name": "add", - "returnType": "Worksheet", - "description": "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.", - "syntax": "worksheetCollectionObject.add(name);", - "signature": "add(name: string)", - "restfulName": "add", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "name", - "dataType": "string", - "isCollection": false, - "description": "The name of the worksheet to be added. If specified, name should be unqiue. If not specified, Excel determines the name of the new worksheet.", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.1" - }, - { - "name": "getCount", - "returnType": "int", - "description": "Gets the number of worksheets in the collection.", - "syntax": "worksheetCollectionObject.getCount(visibleOnly);", - "signature": "getCount(visibleOnly: bool)", - "restfulName": "Count", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "visibleOnly", - "dataType": "bool", - "isCollection": false, - "description": "Considers only the visible cells.", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.4" - }, - { - "name": "getFirst", - "returnType": "Worksheet", - "description": "Gets the first worksheet in the collection.", - "syntax": "worksheetCollectionObject.getFirst(visibleOnly);", - "signature": "getFirst(visibleOnly: bool)", - "restfulName": "First", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "visibleOnly", - "dataType": "bool", - "isCollection": false, - "description": "If true, considers only visible worksheets, skipping over any hidden ones.", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.5" - }, - { - "name": "getLast", - "returnType": "Worksheet", - "description": "Gets the last worksheet in the collection.", - "syntax": "worksheetCollectionObject.getLast(visibleOnly);", - "signature": "getLast(visibleOnly: bool)", - "restfulName": "Last", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "visibleOnly", - "dataType": "bool", - "isCollection": false, - "description": "If true, considers only visible worksheets, skipping over any hidden ones.", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.5" - } - ] +{ + "name": "WorksheetCollection", + "description": "Represents a collection of worksheet objects that are part of the workbook.", + "isCollection": true, + "collectionOf": "Worksheet", + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.1", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "items", + "dataType": "Worksheet[]", + "description": "A collection of worksheet objects.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": true, + "isRelationship": false, + "reqSet": "1.1", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "getActiveWorksheet", + "returnType": "Worksheet", + "description": "Gets the currently active worksheet in the workbook.", + "syntax": "worksheetCollectionObject.getActiveWorksheet();", + "signature": "getActiveWorksheet()", + "restfulName": "ActiveWorksheet", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.1" + }, + { + "name": "getItem", + "returnType": "Worksheet", + "description": "Gets a worksheet object using its Name or ID.", + "syntax": "worksheetCollectionObject.getItem(key);", + "signature": "getItem(key: string)", + "restfulName": "Item", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "key", + "dataType": "string", + "isCollection": false, + "description": "The Name or ID of the worksheet.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getItemOrNullObject", + "returnType": "Worksheet", + "description": "Gets a worksheet object using its Name or ID. If the worksheet does not exist, will return a null object.", + "syntax": "worksheetCollectionObject.getItemOrNullObject(key);", + "signature": "getItemOrNullObject(key: string)", + "restfulName": "ItemOrNullObject", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "key", + "dataType": "string", + "isCollection": false, + "description": "The Name or ID of the worksheet.", + "isRequired": true, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.4" + }, + { + "name": "add", + "returnType": "Worksheet", + "description": "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.", + "syntax": "worksheetCollectionObject.add(name);", + "signature": "add(name: string)", + "restfulName": "add", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "name", + "dataType": "string", + "isCollection": false, + "description": "The name of the worksheet to be added. If specified, name should be unqiue. If not specified, Excel determines the name of the new worksheet.", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.1" + }, + { + "name": "getCount", + "returnType": "int", + "description": "Gets the number of worksheets in the collection.", + "syntax": "worksheetCollectionObject.getCount(visibleOnly);", + "signature": "getCount(visibleOnly: bool)", + "restfulName": "Count", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "visibleOnly", + "dataType": "bool", + "isCollection": false, + "description": "Considers only the visible cells.", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.4" + }, + { + "name": "getFirst", + "returnType": "Worksheet", + "description": "Gets the first worksheet in the collection.", + "syntax": "worksheetCollectionObject.getFirst(visibleOnly);", + "signature": "getFirst(visibleOnly: bool)", + "restfulName": "First", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "visibleOnly", + "dataType": "bool", + "isCollection": false, + "description": "If true, considers only visible worksheets, skipping over any hidden ones.", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.5" + }, + { + "name": "getLast", + "returnType": "Worksheet", + "description": "Gets the last worksheet in the collection.", + "syntax": "worksheetCollectionObject.getLast(visibleOnly);", + "signature": "getLast(visibleOnly: bool)", + "restfulName": "Last", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "visibleOnly", + "dataType": "bool", + "isCollection": false, + "description": "If true, considers only visible worksheets, skipping over any hidden ones.", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.5" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/worksheetprotection.json b/scripts/jsonFiles/source/worksheetprotection.json index af965c5..a012347 100644 --- a/scripts/jsonFiles/source/worksheetprotection.json +++ b/scripts/jsonFiles/source/worksheetprotection.json @@ -1,82 +1,82 @@ -{ - "name": "WorksheetProtection", - "description": "Represents the protection of a sheet object.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.2", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "protected", - "dataType": "bool", - "description": "Indicates if the worksheet is protected. Read-Only.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "options", - "dataType": "WorksheetProtectionOptions", - "description": "Sheet protection options. Read-Only.", - "isReadOnly": true, - "enumNameJs": null, - "isCollection": false, - "isRelationship": true, - "reqSet": "1.2", - "isKey": null, - "notes": null - } - ], - "methods": [ - { - "name": "protect", - "returnType": "void", - "description": "Protects a worksheet. Fails if the worksheet has been protected.", - "syntax": "worksheetProtectionObject.protect(options);", - "signature": "protect(options: WorksheetProtectionOptions)", - "restfulName": "protect", - "notes": null, - "httpSuccessResponse": null, - "parameters": [ - { - "name": "options", - "dataType": "WorksheetProtectionOptions", - "isCollection": false, - "description": "sheet protection options.", - "isRequired": false, - "enumNameJs": null, - "notes": null - } - ], - "reqSet": "1.2" - }, - { - "name": "unprotect", - "returnType": "void", - "description": "Unprotects a worksheet.", - "syntax": "worksheetProtectionObject.unprotect();", - "signature": "unprotect()", - "restfulName": "unprotect", - "notes": null, - "httpSuccessResponse": null, - "parameters": null, - "reqSet": "1.2" - } - ] +{ + "name": "WorksheetProtection", + "description": "Represents the protection of a sheet object.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.2", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "protected", + "dataType": "bool", + "description": "Indicates if the worksheet is protected. Read-Only.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "options", + "dataType": "WorksheetProtectionOptions", + "description": "Sheet protection options. Read-Only.", + "isReadOnly": true, + "enumNameJs": null, + "isCollection": false, + "isRelationship": true, + "reqSet": "1.2", + "isKey": null, + "notes": null + } + ], + "methods": [ + { + "name": "protect", + "returnType": "void", + "description": "Protects a worksheet. Fails if the worksheet has been protected.", + "syntax": "worksheetProtectionObject.protect(options);", + "signature": "protect(options: WorksheetProtectionOptions)", + "restfulName": "protect", + "notes": null, + "httpSuccessResponse": null, + "parameters": [ + { + "name": "options", + "dataType": "WorksheetProtectionOptions", + "isCollection": false, + "description": "sheet protection options.", + "isRequired": false, + "enumNameJs": null, + "notes": null + } + ], + "reqSet": "1.2" + }, + { + "name": "unprotect", + "returnType": "void", + "description": "Unprotects a worksheet.", + "syntax": "worksheetProtectionObject.unprotect();", + "signature": "unprotect()", + "restfulName": "unprotect", + "notes": null, + "httpSuccessResponse": null, + "parameters": null, + "reqSet": "1.2" + } + ] } \ No newline at end of file diff --git a/scripts/jsonFiles/source/worksheetprotectionoptions.json b/scripts/jsonFiles/source/worksheetprotectionoptions.json index e33ff6c..100ea04 100644 --- a/scripts/jsonFiles/source/worksheetprotectionoptions.json +++ b/scripts/jsonFiles/source/worksheetprotectionoptions.json @@ -1,155 +1,155 @@ -{ - "name": "WorksheetProtectionOptions", - "description": "Represents the options in sheet protection.", - "isCollection": false, - "collectionOf": null, - "restPath": null, - "info": { - "version": "1.1", - "reqSet": "1.2", - "addinTypes": [ - "Excel" - ], - "nameSpace": "Excel", - "addinHosts": [ - "Task pane" - ], - "title": "Office JavaScript Add-in API", - "description": "Office JavaScript Add-in API" - }, - "properties": [ - { - "name": "allowFormatCells", - "dataType": "bool", - "description": "Represents the worksheet protection option of allowing formatting cells.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "allowFormatColumns", - "dataType": "bool", - "description": "Represents the worksheet protection option of allowing formatting columns.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "allowFormatRows", - "dataType": "bool", - "description": "Represents the worksheet protection option of allowing formatting rows.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "allowInsertColumns", - "dataType": "bool", - "description": "Represents the worksheet protection option of allowing inserting columns.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "allowInsertRows", - "dataType": "bool", - "description": "Represents the worksheet protection option of allowing inserting rows.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "allowInsertHyperlinks", - "dataType": "bool", - "description": "Represents the worksheet protection option of allowing inserting hyperlinks.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "allowDeleteColumns", - "dataType": "bool", - "description": "Represents the worksheet protection option of allowing deleting columns.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "allowDeleteRows", - "dataType": "bool", - "description": "Represents the worksheet protection option of allowing deleting rows.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "allowSort", - "dataType": "bool", - "description": "Represents the worksheet protection option of allowing using sort feature.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "allowAutoFilter", - "dataType": "bool", - "description": "Represents the worksheet protection option of allowing using auto filter feature.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - }, - { - "name": "allowPivotTables", - "dataType": "bool", - "description": "Represents the worksheet protection option of allowing using PivotTable feature.", - "isReadOnly": false, - "enumNameJs": null, - "isCollection": false, - "isRelationship": false, - "reqSet": "1.2", - "isKey": null, - "notes": null - } - ], - "methods": null +{ + "name": "WorksheetProtectionOptions", + "description": "Represents the options in sheet protection.", + "isCollection": false, + "collectionOf": null, + "restPath": null, + "info": { + "version": "1.1", + "reqSet": "1.2", + "addinTypes": [ + "Excel" + ], + "nameSpace": "Excel", + "addinHosts": [ + "Task pane" + ], + "title": "Office JavaScript Add-in API", + "description": "Office JavaScript Add-in API" + }, + "properties": [ + { + "name": "allowFormatCells", + "dataType": "bool", + "description": "Represents the worksheet protection option of allowing formatting cells.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "allowFormatColumns", + "dataType": "bool", + "description": "Represents the worksheet protection option of allowing formatting columns.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "allowFormatRows", + "dataType": "bool", + "description": "Represents the worksheet protection option of allowing formatting rows.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "allowInsertColumns", + "dataType": "bool", + "description": "Represents the worksheet protection option of allowing inserting columns.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "allowInsertRows", + "dataType": "bool", + "description": "Represents the worksheet protection option of allowing inserting rows.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "allowInsertHyperlinks", + "dataType": "bool", + "description": "Represents the worksheet protection option of allowing inserting hyperlinks.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "allowDeleteColumns", + "dataType": "bool", + "description": "Represents the worksheet protection option of allowing deleting columns.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "allowDeleteRows", + "dataType": "bool", + "description": "Represents the worksheet protection option of allowing deleting rows.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "allowSort", + "dataType": "bool", + "description": "Represents the worksheet protection option of allowing using sort feature.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "allowAutoFilter", + "dataType": "bool", + "description": "Represents the worksheet protection option of allowing using auto filter feature.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + }, + { + "name": "allowPivotTables", + "dataType": "bool", + "description": "Represents the worksheet protection option of allowing using PivotTable feature.", + "isReadOnly": false, + "enumNameJs": null, + "isCollection": false, + "isRelationship": false, + "reqSet": "1.2", + "isKey": null, + "notes": null + } + ], + "methods": null } \ No newline at end of file