sheetxl/assets/BewrYCTrWJXGtgw1.js

SheetXL - Command line tool

/**
 * @license sheetxl - SheetXL - Command line tool - v0.6.0
 *
 * (C) 2025-present SheetXL Inc. & Michael T. Ford
 * License: The license can be found at https://www.sheetxl.com/license.
 */
const e = { ADDRESS: { s: "Creates a cell reference as text, given specified row and column numbers", p: { rowNum: { d: "is the row number to use in the cell reference: Row_number = 1 for row 1" }, columnNum: { d: "is the column number to use in the cell reference. For example, Column_number = 4 for column D" }, absNum: { d: "specifies the reference type: absolute = 1; absolute row/relative column = 2; relative row/absolute column = 3; relative = 4", v: 1 }, a1: { d: "is a logical value that specifies the reference style: A1 style = 1 or TRUE; R1C1 style = 0 or FALSE", v: true }, sheetText: { d: "is text specifying the name of the worksheet to be used as the external reference", v: "" } } }, AREAS: { s: "Returns the number of areas in a reference. An area is a range of contiguous cells or a single cell", p: { references: { d: "is a reference to a cell or range of cells and can refer to multiple areas" } } }, CHOOSE: { s: "Chooses a value or action to perform from a list of values, based on an index number", p: { indexNum: { d: "specifies which value argument is selected. Index_num must be between 1 and 254, or a formula or a reference to a number between 1 and 254" }, value1: { d: "value1,value2,... are 1 to 254 numbers, cell references, defined names, formulas, functions, or text arguments from which CHOOSE selects" }, value: {} } }, CHOOSECOLS: { s: "Returns columns from an array or reference.", p: { array: { d: "The array or reference from which to choose columns." }, colNum1: { d: "col_num1,col_num2,... The number of the column to be returned." }, colNum: {} } }, CHOOSEROWS: { s: "Returns rows from an array or reference.", p: { array: { d: "The array or reference from which to choose rows." }, rowNum1: { d: "row_num1,row_num2,... The number of the row to be returned." }, rowNum: {} } }, COLUMN: { s: "Returns the column number of a reference", p: { reference: { d: "is the cell or range of contiguous cells for which you want the column number. If omitted, the cell containing the COLUMN function is used" } } }, COLUMNS: { s: "Returns the number of columns in an array or reference", p: { array: { d: "is an array or array formula, or a reference to a range of cells for which you want the number of columns" } } }, DROP: { s: "Drops rows or columns from array start or end.", p: { array: { d: "The array from which to drop rows or columns." }, row: { d: "The number of rows to drop. A negative value drops from the end of the array." }, columns: { d: "The number of columns to drop. A negative value drops from the end of the array.", v: 0 } }, h: "Unimplemented" }, EXPAND: { s: "Expands an array to the specified dimensions.", p: { array: { d: "The array to expand." }, row: { d: "The number of rows in the expanded array. If missing, rows will not be expanded." }, columns: { d: "The number of columns in the expanded array. If missing, columns will not be expanded.", v: 0 }, padWidth: { d: "The value with which to pad. The default is #N/A.", v: "FormulaError.BuiltIn.NA" } }, h: "Unimplemented" }, FIELDVALUE: { s: "Extracts a value from a field of a given record", p: { value: { d: "The record from which you want to extract the field" }, fieldName: { d: "The names of the field or fields that you want to extract" } }, h: "Unimplemented" }, FILTER: { s: "Filter a range or array", p: { array: { d: "the range or array to filter" }, include: { d: "an array of booleans where TRUE represents a row or column to retain" }, ifEmpty: { d: "return if no items are retained" } }, h: "Unimplemented" }, FORMULATEXT: { s: "Returns a formula as a string", p: { reference: { d: "is a reference to a formula" } } }, GETPIVOTDATA: { s: "Extracts data stored in a PivotTable.", p: { dataField: { d: "is the name of the data field to extract data from" }, pivotTable: { d: "is a reference to a cell or range of cells in the PivotTable that contains the data you want to retrieve" }, field1: { d: "field1,field2,... field to refer to" }, item1: { d: "item1,item2,... field item to refer to" } }, h: "Unimplemented" }, GROUPBY: { s: "Aggregate values by row fields", p: { rowFields: { d: "The range or array containing the row fields" }, values: { d: "The range or array containing the values to aggregate" }, fn: { d: "The function used to do the aggregations" }, fieldHeaders: { d: "A number between 0 and 3 that specifies whether the field data has headers and whether field headers should be returned in the results", v: null }, totalDepth: { d: "Show totals for the row fields. 0 for none, 1 for grand totals, 2 for grand total and first level subtotals, etc", v: 2 }, sortOrder: { d: "The column index to sort the row fields on. A negative index will sort in reverse order", v: null }, filterArray: { d: "param-534 paramName-535", v: null }, fieldRelationship: { d: "The relationship of fields when multiple columns are supplied to the row_fields argument", v: 0 } }, h: "Unimplemented" }, HLOOKUP: { p: { lookupValue: { d: "is the value to be found in the first row of the table and can be a value, a reference, or a text string" }, tableArray: { d: "is a table of text, numbers, or logical values in which data is looked up. Table_array can be a reference to a range or a range name" }, rowIndexNum: { d: "is the row number in table_array from which the matching value should be returned. The first row of values in the table is row 1" }, rangeLookup: { d: "is a logical value: to find the closest match in the top row (sorted in ascending order) = TRUE; find an exact match = FALSE", v: true } } }, HSTACK: { s: "Horizontally stacks arrays into one array.", p: { array1: {}, array: { d: "array1,array2,... An array or reference to be stacked." } }, h: "Unimplemented" }, HYPERLINK: { s: "Creates a shortcut or jump that opens a document stored on your hard drive, a network server, or on the Internet", p: { linkLocation: { d: "is the text giving the path and file name to the document to be opened, a hard drive location, UNC address, or URL path" }, friendlyName: { d: "is text or a number that is displayed in the cell. If omitted, the cell displays the Link_location text" } }, h: "Unimplemented" }, IMAGE: { s: "Returns an image from a given source", p: { source: { d: "The path of the source that points to the image" }, alternateText: { d: "The alternative text that describes the image for accessibility" }, sizing: { d: "The setting that determines the dimensions in which the image will be rendered in the cell" }, height: { d: "The custom height of the image in pixels" }, width: { d: "The custom width of the image in pixels" } }, h: "Unimplemented" }, INDEX: { s: "Returns a value or reference of the cell at the intersection of a particular row and column, in a given range", p: { array: { d: "is a range of cells or an array constant." }, rowNum: { d: "selects the row in Array or Reference from which to return a value. If omitted, Column_num is required", v: 0 }, colNum: { d: "selects the column in Array or Reference from which to return a value. If omitted, Row_num is required", v: 0 }, areaNum: { d: "selects the area in Array or Reference from which to return a value. If omitted, the first area is used", v: 1 } } }, INDIRECT: { s: "Returns the reference specified by a text string", p: { refText: { d: "is a reference to a cell that contains an A1- or R1C1-style reference, a name defined as a reference, or a reference to a cell as a text string" }, a1: { d: "is a logical value that specifies the type of reference in Ref_text: R1C1-style = FALSE; A1-style = TRUE.", v: true } } }, LOOKUP: { s: "Looks up a value either from a one-row or one-column range or from an array. Provided for backward compatibility", p: { lookupValue: { d: "is a value that LOOKUP searches for in Lookup_vector and can be a number, text, a logical value, or a name or reference to a value" }, lookupVector: { d: "is a range that contains only one row or one column of text, numbers, or logical values, placed in ascending order" }, resultVector: { d: "is a range that contains only one row or column, the same size as Lookup_vector" } }, h: "Unimplemented" }, MATCH: { s: "Returns the relative position of an item in an array that matches a specified value in a specified order", p: { lookupValue: { d: "is the value you use to find the value you want in the array, a number, text, or logical value, or a reference to one of these" }, lookupArray: { d: "is a contiguous range of cells containing possible lookup values, an array of values, or a reference to an array" }, matchType: { d: "is a number 1, 0, or -1 indicating which value to return." } }, h: "Unimplemented" }, OFFSET: { s: "Returns a reference to a range that is a given number of rows and columns from a given reference", p: { reference: { d: "is the reference from which you want to base the offset, a reference to a cell or range of adjacent cells" }, rows: { d: "is the number of rows, up or down, that you want the upper-left cell of the result to refer to" }, cols: { d: "is the number of columns, to the left or right, that you want the upper-left cell of the result to refer to" }, height: { d: "is the height, in number of rows, that you want the result to be, the same height as Reference if omitted" }, width: { d: "is the width, in number of columns, that you want the result to be, the same width as Reference if omitted" } } }, PIVOTBY: { p: { rowFields: {}, colFields: {}, values: {}, fn: {}, fieldHeaders: { v: null }, rowTotalDepth: { v: 2 }, rowSortOrder: { v: null }, colTotalDepth: { v: 2 }, colSortOrder: { v: null }, filterArray: { v: null }, relativeTo: { v: 0 } }, h: "Unimplemented" }, ROW: { s: "Returns the row number of a reference", p: { reference: { d: "is the cell or a single range of cells for which you want the row number; if omitted, returns the cell containing the ROW function" } } }, ROWS: { s: "Returns the number of rows in a reference or array", p: { array: { d: "is an array, an array formula, or a reference to a range of cells for which you want the number of rows" } } }, RTD: { s: "Retrieves the real-time data (RTD) from a program that supports COM automation", p: { progId: { d: "is the programmatic identifier (ProgID) of a registered COM automation add-in. Enclose the id in quotation marks" }, server: { d: "is the name of the server that provides the real-time data. If running locally us an empty string" }, topic: { d: "topic1,topic2,... are 1 to 38 parameters that specify a piece of data" } }, h: "Unimplemented" }, SORT: { s: "Sorts a range or array", p: { array: { d: "the range or array to sort" }, sortIndex: { d: "a number indicating the row or column to sort by" }, sortOrder: { d: "a number indicating the desired sort order; 1 for ascending order (default), -1 for descending order" }, byCol: { d: "a logical value indicating the desired sort direction: FALSE to sort by row (default), TRUE to sort by column", v: false } }, h: "Unimplemented" }, SORTBY: { s: "Sorts a range or array based on the values in a corresponding range or array", p: { array: { d: "the range or array to sort" }, byArray1: { d: "by_array1,by_array2,... the range or array to sort on" }, sortOrder: { d: "sort_order1,sort_order2,... a number indicating the desired sort order; 1 for ascending order (default), -1 for descending order" } }, h: "Unimplemented" }, TAKE: { s: "Returns rows or columns from array start or end.", p: { array: { d: "The array from which to take rows or columns." }, rows: { d: "The number of rows to take. A negative value takes from the end of the array." }, columns: { d: "The number of columns to take. A negative value takes from the end of the array.", v: 0 } }, h: "Unimplemented" }, TOCOL: { s: "Returns the array as one column.", p: { array: { d: "The array or reference to return as a column." }, ignore: { d: "Whether to ignore certain types of values. By default, no values are ignored.", v: 0 }, scanByColumn: { d: "Scan the array by column. By default, the array is scanned by row.", v: false } }, h: "Unimplemented" }, TOROW: { s: "Returns the array as one row.", p: { array: { d: "The array or reference to return as a column." }, ignore: { d: "Whether to ignore certain types of values. By default, no values are ignored.", v: 0 }, scanByColumn: { d: "Scan the array by column. By default, the array is scanned by row.", v: false } }, h: "Unimplemented" }, TRANSPOSE: { s: "Converts a vertical range of cells to a horizontal range, or vice versa", p: { array: { d: "is a range of cells on a worksheet or an array of values that you want to transpose" } } }, TRIMRANGE: { s: "Trims a range to the last used cell in any direction.", p: { range: { d: "The range to be trimmed" }, rowTrimMode: { d: "Row trim direction. 0 - none, 1 - leading, 2 - trailing, 3 - both.", v: 3 }, colTrimMode: { d: "Column trim direction. 0 - none. 1 - leading, 2 - trailing, 3 - both.", v: 3 } } }, UNIQUE: { s: "Returns the unique values from a range or array.", p: { array: { d: "the range or array from which to return unique rows or columns" }, byCol: { d: "is a logical value: compare rows against each other and return the unique rows = FALSE; compare columns against each other and return the unique columns = TRUE", v: false }, exactlyOnce: { d: "is a logical value: return rows or columns that occur exactly once from the array = TRUE; return all distinct rows or columns from the array = FALSE", v: false } }, h: "Unimplemented" }, VLOOKUP: { s: "Looks for a value in the leftmost column of a table, and then returns a value in the same row from a column you specify. By default, the table must be sorted in an ascending order", p: { lookupValue: { d: "is the value to be found in the first column of the table, and can be a value, a reference, or a text string" }, tableArray: { d: "is a table of text, numbers, or logical values, in which data is retrieved. Table_array can be a reference to a range or a range name" }, colIndexNum: { d: "is the column number in table_array from which the matching value should be returned. The first column of values in the table is column 1" }, rangeLookup: { d: "is a logical value: to find the closest match in the first column (sorted in ascending order) = TRUE; find an exact match = FALSE", v: true } } }, VSTACK: { s: "Vertically stacks arrays into one array.", p: { array1: { d: "array1,array2,... An array or reference to be stacked." }, array: { d: "array1,array2,... An array or reference to be stacked." } }, h: "Unimplemented" }, WRAPCOLS: { s: "Wraps a row or column vector after a specified number of values.", p: { vector: { d: "The vector or reference to wrap." }, wrapCount: { d: "The maximum number of values per column." }, padWith: { d: "The value with which to pad. The default is #N/A.", v: "FormulaError.BuiltIn.NA" } }, h: "Unimplemented" }, WRAPROWS: { s: "Wraps a row or column vector after a specified number of values.", p: { vector: { d: "The vector or reference to wrap." }, wrapCount: { d: "The maximum number of values per column." }, padWith: { d: "The value with which to pad. The default is #N/A.", v: "FormulaError.BuiltIn.NA" } }, h: "Unimplemented" }, XLOOKUP: { s: "Searches a range or an array for a match and returns the corresponding item from a second range or array. By default, an exact match is used", p: { lookupValue: { d: "is the value to search for" }, lookupArray: { d: "is the array or range to search" }, returnArray: { d: "is the array or range to return" }, ifNotFound: { d: "returned if no match is found" }, rangeLookup: { v: true }, matchMode: { d: "specify how to match lookup_value against the values in lookup_array" }, searchMode: { d: "specify the search mode to use. By default, a first to last search will be used", v: true } }, h: "Unimplemented" }, XMATCH: { s: "Returns the relative position of an item in an array. By default, an exact match is required", p: { lookupValue: { d: "is the value to search for" }, lookupArray: { d: "is the array or range to search" }, matchMode: { d: "specify how to match the lookup_value against the values in lookup_array" }, searchMode: { d: "specify the search mode to use. By default, a first to last search will be used", v: true } }, h: "Unimplemented" } };
export {
  e as default
};