Excel. Range class

Usada por

Excel.AutoFilter: apply, getRange, getRangeOrNullObject
Excel.BasicDataValidation: formula1, formula2
Excel.Binding: getRange
Excel.BindingCollection: add
Excel.Chart: setData, setPosition
Excel.ChartAxis: setCategoryNames
Excel.ChartCollection: agregar
Excel.ChartSeries: setBubbleSizes, setValues, setXAxisValues
Excel.Comment: getLocation
Excel.CommentCollection: add, getItemByCell
Excel.CommentReply: getLocation
Excel.ConditionalFormat: getRange, getRangeOrNullObject
Excel.DateTimeDataValidation: formula1, formula2
Excel.Functions: abs, accrInt, accrIntM, acos, acosh, acot, acoth, amorDegrc, amorLinc, and, arabic, areas, asc, asin, asinh, atan, atan2, atanh, aveDev, average, averageA, averageIf, averageIfs, bahtText,base, besselI, besselJ, besselK, besselY, beta_Dist, beta_Inv, bin2Dec, bin2Hex, bin2Oct, binom_Dist, binom_Dist_Range, binom_Inv, bitand, bitlshift, bitor, bitrshift, bitxor, ceiling_Math, ceiling_Precise, char, chiSq_Dist, chiSq_ Dist_RT, chiSq_Inv, chiSq_Inv_RT, elegir, limpiar, codificar, columnas, combinar, combinar, complejo, concatenar, confidence_Norm, confidence_T, convertir, cos, cosh, cot, coth, contar, countA, countBlank, countIf, countIfs, coupDayBs, coupDays, coupDaysNc, coupNcd, coupNum, coupPcd, csc, csch, cumIPmt, cumPrinc, date, datevalue, daverage, day, days, days360, db, dbcs, dcount, dcountA, ddb, dec2Bin, dec2Hex, dec2Oct, decimal, grados, delta, devSq, dget, disc, dmax, dmin, dólar, dólarDe, dólarFr, dproduct, dstDev , dstDevP, dsum, duración, dvar, dvarP, ecma_Ceiling, edate, effect, eoMonth, erf, erf_Precise, erfC, erfC_Precise, error_Type, even, exact,exp, expon_Dist, f_Dist, f_Dist_RT, f_Inv, f_Inv_RT, fact, factDouble, find, findB, fisher, fisherInv, fixed, floor_Math, floor_Precise, fv, fvschedule, gamma, gamma_Dist, gamma_Inv, gammaLn, gammaLn_Precise, gauss, gcd, geoMean, geStep, harMean, hex2Bin, hex2Dec, hex2Oct, hlookup, hour, hyperlink, hypGeom_Dist, if, imAbs, imaginary, imArgument, imConjugate, imCos, imCosh, imCot, imCsc, imCsch, imDiv, imExp, imLn, imLog10, imLog2, imPower, imProduct, imReal, imSec, imSech, imSin, imSinh, imSqrt, imSub, imSum, imTan, int, intRate, ipmt, irr, isErr, isError, isEven, isFormula, isLogical, isNA,isNonText, isNumber, iso_Ceiling, isOdd, isoWeekNum, ispmt, isref, isText, kurt, large, lcm, left, leftb, len , lenb, ln, log, log10, logNorm_Dist, logNorm_Inv, lookup, lower, match, max, maxA, mduration, median, mid, midb, min, minA, minute, mirr, mod, month, mround, multiNomial, n, negBinom_Dist, networkDays, networkDays_Intl, nominal, norm_Dist, norm_Inv, norm_S_Dist, norm_S_Inv, not, nper, npv, numberValue, oct2Bin, oct2Dec, oct2Hex, odd , oddFPrice, oddFYield, oddLPrice, oddLYield, or, pduration, percentile_Exc, percentile_Inc, percentRank_Exc, percentRank_Inc, permut, permutationa, phi, pmt, poisson_Dist, power, ppmt, price, priceDisc, priceMat, product, prop,pv, quartile_Exc, quartile_Inc, cociente, radianes, randBetween, rank_Avg, rank_Eq, rate, received, replace, replaceB, rept, right , rightb, roman, round, roundDown, roundUp, rows, rri, sec, sech, second, seriesSum, sheet, sheets, sign, sin , sinh, skew, skew_p, sln, small, sqrt, sqrtPi, standardize, stDev_P, stDev_S, stDevA, stDevPA,substitute, subtotal, sum, sumIf, sumIfs, sumSq, syd, t, t_Dist, t_Dist_2T, t_Dist_RT, t_Inv, t_Inv_2T, tan, tanh, tbillEq, tbillPrice, tbillYield, text, time, timevalue, trim, trimMean, trunc, type, unichar, unicode, upper, usdollar, value, var_P, var_S, varA, varPA,vdb, vlookup, weekday, weekNum, weibull_Dist, workDay, workDay_Intl, xirr, xnpv, xor, year, yearFrac, yield , yieldDisc, yieldMat, z_Test
Excel.ListDataValidation: source
Excel.NamedItem: getRange, getRangeOrNullObject
Excel.NamedItemCollection: add
Excel.PageBreak: getCellAfterBreak
Excel.PageBreakCollection: add
Excel.PageLayout: getPrintTitleColumns, getPrintTitleColumnsOrNullObject, getPrintTitleRows, getPrintTitleRowsOrNullObject, setPrintArea, setPrintTitleColumns, setPrintTitleRows
Excel.PivotLayout: getColumnLabelRange, getDataBodyRange, getDataHierarchy, getFilterAxisRange, getPivotItems, getRange, getRowLabelRange, setAutoSortOnCell
Excel.PivotTableCollection: agregar
Excel.RangeAreas: copyFrom, getIntersection, getIntersectionOrNullObject
Excel.RangeCollection: getItemAt, items
Excel.RangeView: getRange
Excel.Table: convertToRange, getDataBodyRange, getHeaderRowRange, getRange, getTotalRowRange
Excel.TableChangedEventArgs: getRange, getRangeOrNullObject
Excel.TableCollection: agregar
Excel.TableColumn: getDataBodyRange, getHeaderRowRange, getRange, getTotalRowRange
Excel.TableRow: getRange
Excel.Workbook: getActiveCell, getSelectedRange
Excel.Worksheet: getCell, getRange, getRangeByIndexes, getUsedRange, getUsedRangeOrNullObject
Excel.WorksheetChangedEventArgs: getRange, getRangeOrNullObject
Excel.WorksheetFormatChangedEventArgs: getRange, getRangeOrNullObject
Excel.WorksheetFreezePanes: freezeAt, getLocation, getLocationOrNullObject

Ejemplos

// Get a Range object by its address.
await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const cell = range.getCell(0,0);
    cell.load('address');
    await context.sync();
    
    console.log(cell.address);
});

Propiedades

address	Especifica el rango de referencia en estilo A1. El valor de dirección contiene la referencia de hoja (por ejemplo, "Hoja1! A1:B4").
addressLocal	Representa la referencia de rango para el rango especificado en el idioma del usuario.
cellCount	Especifica el número de celdas del rango. Esta API devolverá -1 si el recuento de celdas supera 2^31-1 (2 147 483 647).
columnCount	Especifica el número total de columnas del rango.
columnHidden	Representa si todas las columnas del rango actual están ocultas. El valor es `true` cuando todas las columnas de un rango están ocultas. El valor es `false` cuando no hay columnas ocultas en el intervalo. El valor es `null` cuando algunas columnas de un rango están ocultas y otras columnas del mismo rango no están ocultas.
columnIndex	Especifica el número de columna de la primera celda del rango. Indizado con cero.
conditionalFormats	La colección de `ConditionalFormats` eso cruza la cordillera.
context	El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.
dataValidation	Devuelve un objeto de validación de datos.
format	Devuelve un objeto de formato que encapsula la fuente, el relleno, los bordes, la alineación y otras propiedades del rango.
formulas	Representa la fórmula en notación de estilo A1. Si una celda no tiene fórmula, se devuelve su valor en su lugar.
formulasLocal	Representa la fórmula en notación de estilo A1, en el idioma del usuario y en la configuración regional del formato numérico. Por ejemplo, la fórmula "=SUM(A1, 1.5)" en inglés se convertiría en "=SUMME(A1; 1,5)" en alemán. Si una celda no tiene fórmula, se devuelve su valor en su lugar.
formulasR1C1	Representa la fórmula en notación de estilo R1C1. Si una celda no tiene fórmula, se devuelve su valor en su lugar.
height	Devuelve la distancia en puntos, para un zoom del 100 %, desde el borde superior del rango hasta el borde inferior del rango.
hidden	Representa si todas las celdas del rango actual están ocultas. El valor se produce `true` cuando todas las celdas de un rango están ocultas. El valor es `false` cuando no hay celdas ocultas en el rango. El valor se produce `null` cuando algunas celdas de un rango están ocultas y otras del mismo rango no están ocultas.
hyperlink	Representa el hipervínculo del rango actual.
isEntireColumn	Representa si el intervalo actual es una columna completa.
isEntireRow	Representa si el intervalo actual es una fila completa.
left	Devuelve la distancia en puntos, para un zoom del 100%, desde el borde izquierdo de la hoja de cálculo hasta el borde izquierdo del rango.
linkedDataTypeState	Indica el estado del tipo de datos de cada celda.
numberFormat	Representa el código de formato de número de Excel para un rango determinado. Para obtener más información sobre el formato de número de Excel, vea códigos de formato de número.
numberFormatLocal	Representa el código de formato de número de Excel para el rango especificado, en función de la configuración de idioma del usuario. Excel no ejerce ninguna coerción de idioma o formato al obtener o establecer la `numberFormatLocal` propiedad. Cualquier texto devuelto usa cadenas con formato local basadas en el idioma especificado en la configuración del sistema.
rowCount	Devuelve el número total de filas del intervalo.
rowHidden	Representa si todas las filas del rango actual están ocultas. El valor es `true` cuando todas las filas de un rango están ocultas. El valor es `false` cuando no hay filas ocultas en el rango. El valor se produce `null` cuando algunas filas de un rango están ocultas y otras filas del mismo rango no están ocultas.
rowIndex	Devuelve el número de fila de la primera celda del intervalo. Indizado con cero.
sort	Representa la ordenación del intervalo del intervalo actual.
style	Representa el estilo del rango actual. Si los estilos de las celdas son incoherentes, `null` se devolverá. Para los estilos personalizados, se devolverá el nombre del estilo. Para los estilos integrados, se devolverá una cadena que representa un valor de la `BuiltInStyle` enumeración.
text	Valores de texto del intervalo especificado. El valor Text no dependerá del ancho de la celda. La sustitución de signos de número (#) que se produce en la interfaz de usuario de Excel no afectará al valor de texto devuelto por la API.
top	Devuelve la distancia en puntos, para un zoom del 100%, desde el borde superior de la hoja de cálculo hasta el borde superior del rango.
values	Representa los valores sin formato del rango especificado. Los datos devueltos pueden ser una cadena, un número o un valor booleano. Las celdas que contienen un error devolverán la cadena de error. Si el valor devuelto comienza con un signo más ("+"), menos ("-") o igual ("="), Excel interpretará este valor como una fórmula. Las cadenas con forma de configuración regional (como la fecha "19-8-2025" en nl-NL o fr-FR, formato DD-MM-AAAA) se almacenan como texto en lugar de como fechas. Para asegurarse de que las fechas se almacenan como fechas, use una API compatible con la configuración regional, como `formulasLocal` o use un formato independiente de la configuración regional, como ISO (AAAAA-MM-DD) o una serie de fechas numéricas.
valueTypes	Especifica el tipo de datos de cada celda.
width	Devuelve la distancia en puntos, para un zoom del 100 %, desde el borde izquierdo del rango hasta el borde derecho del rango.
worksheet	Hoja de cálculo que contiene el rango actual.

Métodos

autoFill(destinationRange, autoFillType)	Rellena un rango desde el rango actual hasta el rango de destino utilizando la lógica de Autorrellenar especificada. El rango de destino puede ser `null` o puede extender el rango de origen horizontal o verticalmente. No se admiten intervalos discontinuos. Para obtener más información, consulte Uso de Autorrellenar y Relleno rápido.
autoFill(destinationRange, autoFillType)	Rellena un rango desde el rango actual hasta el rango de destino utilizando la lógica de Autorrellenar especificada. El rango de destino puede ser `null` o puede extender el rango de origen horizontal o verticalmente. No se admiten intervalos discontinuos. Para obtener más información, consulte Uso de Autorrellenar y Relleno rápido.
calculate()	Calcula un rango de celdas en una hoja de cálculo.
clear(applyTo)	Borrar valores de rango y formato, como relleno y borde.
clear(applyTo)	Borrar valores de rango y formato, como relleno y borde.
convertDataTypeToText()	Convierte las celdas de rango con tipos de datos en texto.
convertToLinkedDataType(serviceID, languageCulture)	Convierte las celdas de rango en tipos de datos vinculados en la hoja de cálculo.
copyFrom(sourceRange, copyType, skipBlanks, transpose)	Copia los datos o el formato de celda del rango de origen o `RangeAreas` al rango actual. El rango de destino puede tener un tamaño diferente del rango de origen o `RangeAreas`. El destino se expande automáticamente si es más pequeño que el origen. Nota: Al igual que la funcionalidad de copia en la interfaz de usuario de Excel, si el rango de destino es un múltiplo exacto mayor que el rango de origen en filas o columnas, el contenido de origen se replica varias veces. Por ejemplo, una copia de un rango 2x2 en un rango de 2x6 dará como resultado 3 copias del rango de 2x2 original.
copyFrom(sourceRange, copyType, skipBlanks, transpose)	Copia los datos o el formato de celda del rango de origen o `RangeAreas` al rango actual. El rango de destino puede tener un tamaño diferente del rango de origen o `RangeAreas`. El destino se expande automáticamente si es más pequeño que el origen. Nota: Al igual que la funcionalidad de copia en la interfaz de usuario de Excel, si el rango de destino es un múltiplo exacto mayor que el rango de origen en filas o columnas, el contenido de origen se replica varias veces. Por ejemplo, una copia de un rango 2x2 en un rango de 2x6 dará como resultado 3 copias del rango de 2x2 original.
delete(shift)	Elimina las celdas asociadas al rango.
delete(shift)	Elimina las celdas asociadas al rango.
find(text, criteria)	Busca la cadena especificada, según los criterios especificados. Si el rango actual es mayor que una celda, la búsqueda se limitará a ese rango; de lo contrario, la búsqueda cubrirá toda la hoja a partir de esa celda.
findOrNullObject(text, criteria)	Busca la cadena especificada, según los criterios especificados. Si el rango actual es mayor que una celda, la búsqueda se limitará a ese rango; de lo contrario, la búsqueda cubrirá toda la hoja a partir de esa celda. Si no hay coincidencias, este método devuelve un objeto con su `isNullObject` propiedad establecida en `true`. Para obtener más información, vea los métodos y propiedades *OrNullObject.
flashFill()	Rellena rápidamente el rango actual. Relleno rápido rellena automáticamente los datos cuando detecta un patrón, por lo que el rango debe ser un rango de una sola columna y tener datos a su alrededor para encontrar un patrón.
getAbsoluteResizedRange(numRows, numColumns)	Obtiene un `Range` objeto con la misma celda superior izquierda que el objeto actual `Range` , pero con el número especificado de filas y columnas.
getBoundingRect(anotherRange)	Obtiene el objeto de intervalo más pequeño que abarca los intervalos especificados. Por ejemplo, el `GetBoundingRect` valor de "B2:C5" y "D10:E15" es "B2:E15".
getCell(row, column)	Obtiene el objeto de intervalo que contiene la celda en función de los números de fila y columna. La celda puede estar fuera de los límites de su rango primario siempre que se mantenga dentro de la cuadrícula de la hoja de cálculo. La celda devuelta se ubica con respecto a la celda superior izquierda del intervalo.
getCellProperties(cellPropertiesLoadOptions)	Devuelve una matriz 2D que encapsula los datos para la fuente, el relleno, los bordes, la alineación y otras propiedades de la celda.
getColumn(column)	Obtiene una columna contenida en el intervalo.
getColumnProperties(columnPropertiesLoadOptions)	Devuelve una matriz de una sola dimensión que encapsula los datos para la fuente, el relleno, los bordes, la alineación y otras propiedades de la columna. Se devolverá null para las propiedades que no son coherentes en cada celda de una columna determinada.
getColumnsAfter(count)	Obtiene un cierto número de columnas a la derecha del objeto actual `Range` .
getColumnsBefore(count)	Obtiene un cierto número de columnas a la izquierda del objeto actual `Range` .
getEntireColumn()	Obtiene un objeto que representa toda la columna del rango (por ejemplo, si el rango actual representa las celdas "B4:E11", este `getEntireColumn` es un rango que representa las columnas "B:E").
getEntireRow()	Obtiene un objeto que representa toda la fila del rango (por ejemplo, si el rango actual representa las celdas "B4:E11", este `GetEntireRow` es un rango que representa las filas "4:11").
getImage()	Representa el rango como una imagen PNG codificada en Base64.
getIntersection(anotherRange)	Obtiene el objeto de rango que representa la intersección rectangular de los rangos especificados.
getIntersectionOrNullObject(anotherRange)	Obtiene el objeto de rango que representa la intersección rectangular de los rangos especificados. Si no se encuentra ninguna intersección, este método devuelve un objeto con su `isNullObject` propiedad establecida en `true`. Para obtener más información, vea los métodos y propiedades *OrNullObject.
getLastCell()	Obtiene la última celda del intervalo. Por ejemplo, la última celda de "B2:D5" es "D5".
getLastColumn()	Obtiene la última columna del intervalo. Por ejemplo, la última columna de "B2:D5" es "D2:D5".
getLastRow()	Obtiene la última fila del intervalo. Por ejemplo, la última fila de "B2:D5" es "B5:D5".
getOffsetRange(rowOffset, columnOffset)	Obtiene un objeto que representa un intervalo desplazado con respecto al intervalo especificado. La dimensión del rango devuelto coincidirá con este rango. Si el rango resultante se fuerza más allá de los límites de la cuadrícula de la hoja de cálculo, se producirá un error.
getResizedRange(deltaRows, deltaColumns)	Obtiene un `Range` objeto similar al objeto actual `Range` , pero con su esquina inferior derecha expandida (o contraída) por un cierto número de filas y columnas.
getRow(row)	Obtiene una fila contenida en el intervalo.
getRowProperties(rowPropertiesLoadOptions)	Devuelve una matriz de una sola dimensión que encapsula los datos para la fuente, el relleno, los bordes, la alineación y otras propiedades de la fila. Para las propiedades que no son coherentes en todas las celdas de una fila determinada, `null` se devolverá.
getRowsAbove(count)	Obtiene un número determinado de filas por encima del objeto actual `Range` .
getRowsBelow(count)	Obtiene un cierto número de filas debajo del objeto actual `Range` .
getSpecialCells(cellType, cellValueType)	Obtiene el `RangeAreas` objeto, que comprende uno o más rangos rectangulares, que representa todas las celdas que coinciden con el tipo y valor especificados. Si no se encuentra ninguna celda especial, se producirá un `ItemNotFound` error.
getSpecialCells(cellType, cellValueType)	Obtiene el `RangeAreas` objeto, que comprende uno o más rangos rectangulares, que representa todas las celdas que coinciden con el tipo y valor especificados. Si no se encuentra ninguna celda especial, se producirá un `ItemNotFound` error.
getSpecialCellsOrNullObject(cellType, cellValueType)	Obtiene el `RangeAreas` objeto, que comprende uno o más rangos, que representa todas las celdas que coinciden con el tipo y valor especificados. Si no se encuentran celdas especiales, este método devuelve un objeto con su `isNullObject` propiedad establecida en `true`. Para obtener más información, vea los métodos y propiedades *OrNullObject.
getSpecialCellsOrNullObject(cellType, cellValueType)	Obtiene el `RangeAreas` objeto, que comprende uno o más rangos, que representa todas las celdas que coinciden con el tipo y valor especificados. Si no se encuentran celdas especiales, este método devuelve un objeto con su `isNullObject` propiedad establecida en `true`. Para obtener más información, vea los métodos y propiedades *OrNullObject.
getSurroundingRegion()	Devuelve un `Range` objeto que representa la región circundante de la celda superior izquierda de este rango. Una región circundante es un intervalo limitado por cualquier combinación de filas y columnas en blanco en relación a este intervalo.
getTables(fullyContained)	Obtiene una colección con ámbito de tablas que se superpone con el intervalo.
getUsedRange(valuesOnly)	Devuelve el intervalo usado del objeto de rango especificado. Si no hay celdas usadas en el rango, esta función generará un `ItemNotFound` error.
getUsedRangeOrNullObject(valuesOnly)	Devuelve el intervalo usado del objeto de rango especificado. Si no hay celdas usadas en el rango, este método devuelve un objeto con su `isNullObject` propiedad establecida en `true`. Para obtener más información, vea los métodos y propiedades *OrNullObject.
getVisibleView()	Representa las filas visibles del intervalo actual.
group(groupOption)	Agrupa columnas y filas para obtener un esquema.
group(groupOption)	Agrupa columnas y filas para obtener un esquema.
hideGroupDetails(groupOption)	Oculta los detalles del grupo de filas o columnas.
hideGroupDetails(groupOption)	Oculta los detalles del grupo de filas o columnas.
insert(shift)	Inserta una celda o un intervalo de celdas en la hoja de cálculo en lugar de este intervalo y desplaza las demás celdas para crear espacio. Devuelve un nuevo `Range` objeto en el espacio en blanco.
insert(shift)	Inserta una celda o un intervalo de celdas en la hoja de cálculo en lugar de este intervalo y desplaza las demás celdas para crear espacio. Devuelve un nuevo `Range` objeto en el espacio en blanco.
load(options)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a `context.sync()` antes de leer las propiedades.
load(propertyNames)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a `context.sync()` antes de leer las propiedades.
load(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a `context.sync()` antes de leer las propiedades.
merge(across)	Combina las celdas del intervalo en una región de la hoja de cálculo.
removeDuplicates(columns, includesHeader)	Quita los valores duplicados del intervalo especificado por las columnas.
replaceAll(text, replacement, criteria)	Busca y reemplaza la cadena especificada, según los criterios especificados dentro del intervalo actual.
select()	Selecciona el intervalo especificado en la interfaz de usuario de Excel.
set(properties, options)	Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo.
set(properties)	Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente.
setCellProperties(cellPropertiesData)	Actualiza las novedades del rango en función de una matriz 2D de propiedades de celda, encapsulando elementos como fuente, relleno, bordes y alineación.
setColumnProperties(columnPropertiesData)	Novedades el rango en función de una matriz unidimensional de propiedades de columna, encapsulando elementos como la fuente, el relleno, los bordes y la alineación.
setDirty()	Establece un intervalo que se deberá actualizar cuando se realice la próxima actualización.
setRowProperties(rowPropertiesData)	Novedades el rango en función de una matriz unidimensional de propiedades de fila, encapsulando elementos como fuente, relleno, bordes y alineación.
showCard()	Muestra la tarjeta de una celda activa si tiene contenido de valor enriquecido.
showGroupDetails(groupOption)	Muestra los detalles del grupo de filas o columnas.
showGroupDetails(groupOption)	Muestra los detalles del grupo de filas o columnas.
toJSON()	Reemplaza el método JavaScript `toJSON()` para proporcionar una salida más útil cuando se pasa un objeto API a `JSON.stringify()`. (`JSON.stringify`, a su vez, llama al `toJSON` método del objeto que se le pasa). Mientras que el objeto original `Excel.Range` es un objeto API, el `toJSON` método devuelve un objeto JavaScript simple (escrito como `Excel.Interfaces.RangeData`) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.
track()	Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura de context.trackedObjects.add(thisObject). Si usa este objeto entre `.sync` llamadas y fuera de la ejecución secuencial de un lote ".run" y recibe un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos objeto de seguimiento cuando se creó el objeto por primera vez.
ungroup(groupOption)	Desagrupa las columnas y filas para obtener un esquema.
ungroup(groupOption)	Desagrupa las columnas y filas para obtener un esquema.
unmerge()	Separa las celdas del intervalo en celdas independientes.
untrack()	Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es la abreviatura de context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Deberá llamar `context.sync()` antes de que la liberación de memoria surta efecto.

address

Especifica el rango de referencia en estilo A1. El valor de dirección contiene la referencia de hoja (por ejemplo, "Hoja1! A1:B4").

readonly address: string;

Valor de propiedad

string

Comentarios

addressLocal

Representa la referencia de rango para el rango especificado en el idioma del usuario.

readonly addressLocal: string;

Valor de propiedad

string

Comentarios

cellCount

Especifica el número de celdas del rango. Esta API devolverá -1 si el recuento de celdas supera 2^31-1 (2 147 483 647).

readonly cellCount: number;

Valor de propiedad

number

Comentarios

columnCount

Especifica el número total de columnas del rango.

readonly columnCount: number;

Valor de propiedad

number

Comentarios

columnHidden

Representa si todas las columnas del rango actual están ocultas. El valor es true cuando todas las columnas de un rango están ocultas. El valor es false cuando no hay columnas ocultas en el intervalo. El valor es null cuando algunas columnas de un rango están ocultas y otras columnas del mismo rango no están ocultas.

columnHidden: boolean;

Valor de propiedad

boolean

Comentarios

columnIndex

Especifica el número de columna de la primera celda del rango. Indizado con cero.

readonly columnIndex: number;

Valor de propiedad

number

Comentarios

Conjunto de API: ExcelApi 1.6

conditionalFormats

La colección de ConditionalFormats eso cruza la cordillera.

readonly conditionalFormats: Excel.ConditionalFormatCollection;

Valor de propiedad

Excel.ConditionalFormatCollection

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-advanced.yaml

function queueCommandsToClearAllConditionalFormats(sheet: Excel.Worksheet) {
        const range = sheet.getRange();
        range.conditionalFormats.clearAll();
}

context

El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Excel.RequestContext

dataValidation

Devuelve un objeto de validación de datos.

readonly dataValidation: Excel.DataValidation;

Valor de propiedad

Excel.DataValidation

Comentarios

Conjunto de API: ExcelApi 1.8

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation-types.yaml

function applyCustom(sheet: Excel.Worksheet) {
    // Custom formula: Value in B8 must not duplicate any value already in B2:B7.
    const customRule: Excel.CustomDataValidation = {
        formula: "=COUNTIF($B$2:$B$7,B8)=0"
    };
    const rule: Excel.DataValidationRule = { custom: customRule };
    sheet.getRange("B8").dataValidation.rule = rule;
}

format

Devuelve un objeto de formato que encapsula la fuente, el relleno, los bordes, la alineación y otras propiedades del rango.

readonly format: Excel.RangeFormat;

Valor de propiedad

Excel.RangeFormat

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/46-table/formatting.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const expensesTable = sheet.tables.getItem("ExpensesTable");

    expensesTable.getHeaderRowRange().format.fill.color = "#C70039";
    expensesTable.getDataBodyRange().format.fill.color = "#DAF7A6";
    expensesTable.rows.getItemAt(1).getRange().format.fill.color = "#FFC300";
    expensesTable.columns.getItemAt(0).getDataBodyRange().format.fill.color = "#FFA07A";
    
  await context.sync();
});

formulas

Representa la fórmula en notación de estilo A1. Si una celda no tiene fórmula, se devuelve su valor en su lugar.

formulas: any[][];

Valor de propiedad

any[][]

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/set-get-values.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    const data = [
        ["Total Price"],
        ["=C3 * D3"],
        ["=C4 * D4"],
        ["=C5 * D5"],
        ["=SUM(E3:E5)"]
    ];
    
    const range = sheet.getRange("E2:E6");
    range.formulas = data;
    range.format.autofitColumns();

    await context.sync();
});

formulasLocal

Representa la fórmula en notación de estilo A1, en el idioma del usuario y en la configuración regional del formato numérico. Por ejemplo, la fórmula "=SUM(A1, 1.5)" en inglés se convertiría en "=SUMME(A1; 1,5)" en alemán. Si una celda no tiene fórmula, se devuelve su valor en su lugar.

formulasLocal: any[][];

Valor de propiedad

any[][]

Comentarios

formulasR1C1

Representa la fórmula en notación de estilo R1C1. Si una celda no tiene fórmula, se devuelve su valor en su lugar.

formulasR1C1: any[][];

Valor de propiedad

any[][]

Comentarios

height

Devuelve la distancia en puntos, para un zoom del 100 %, desde el borde superior del rango hasta el borde inferior del rango.

readonly height: number;

Valor de propiedad

number

Comentarios

hidden

Representa si todas las celdas del rango actual están ocultas. El valor se produce true cuando todas las celdas de un rango están ocultas. El valor es false cuando no hay celdas ocultas en el rango. El valor se produce null cuando algunas celdas de un rango están ocultas y otras del mismo rango no están ocultas.

readonly hidden: boolean;

Valor de propiedad

boolean

Comentarios

hyperlink

Representa el hipervínculo del rango actual.

hyperlink: Excel.RangeHyperlink;

Valor de propiedad

Excel.RangeHyperlink

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-hyperlink.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Orders");

    let productsRange = sheet.getRange("A3:A5");
    productsRange.load("values");

    await context.sync();

    // Create a hyperlink to a URL 
    // for each product name in the first table.
    for (let i = 0; i < productsRange.values.length; i++) {
        let cellRange = productsRange.getCell(i, 0);
        let cellText = productsRange.values[i][0];

        let hyperlink = {
            textToDisplay: cellText,
            screenTip: "Search Bing for '" + cellText + "'",
            address: "https://www.bing.com?q=" + cellText
        }
        cellRange.hyperlink = hyperlink;
    }

    await context.sync();
});

isEntireColumn

Representa si el intervalo actual es una columna completa.

readonly isEntireColumn: boolean;

Valor de propiedad

boolean

Comentarios

isEntireRow

Representa si el intervalo actual es una fila completa.

readonly isEntireRow: boolean;

Valor de propiedad

boolean

Comentarios

left

Devuelve la distancia en puntos, para un zoom del 100%, desde el borde izquierdo de la hoja de cálculo hasta el borde izquierdo del rango.

readonly left: number;

Valor de propiedad

number

Comentarios

linkedDataTypeState

Indica el estado del tipo de datos de cada celda.

readonly linkedDataTypeState: Excel.LinkedDataTypeState[][];

Valor de propiedad

Excel.LinkedDataTypeState[][]

Comentarios

numberFormat

Representa el código de formato de número de Excel para un rango determinado. Para obtener más información sobre el formato de número de Excel, vea códigos de formato de número.

numberFormat: any[][];

Valor de propiedad

any[][]

Comentarios

Ejemplos

// Set the text of the chart title to "My Chart" and display it as an overlay on the chart.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F5:G7";
    const numberFormat = [[null, "d-mmm"], [null, "d-mmm"], [null, null]]
    const values = [["Today", 42147], ["Tomorrow", "5/24"], ["Difference in days", null]];
    const formulas = [[null,null], [null,null], [null,"=G6-G5"]];
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.numberFormat = numberFormat;
    range.values = values;
    range.formulas= formulas;
    range.load('text');
    await context.sync();
    
    console.log(range.text);
});

numberFormatLocal

Representa el código de formato de número de Excel para el rango especificado, en función de la configuración de idioma del usuario. Excel no ejerce ninguna coerción de idioma o formato al obtener o establecer la numberFormatLocal propiedad. Cualquier texto devuelto usa cadenas con formato local basadas en el idioma especificado en la configuración del sistema.

numberFormatLocal: any[][];

Valor de propiedad

any[][]

Comentarios

rowCount

Devuelve el número total de filas del intervalo.

readonly rowCount: number;

Valor de propiedad

number

Comentarios

rowHidden

Representa si todas las filas del rango actual están ocultas. El valor es true cuando todas las filas de un rango están ocultas. El valor es false cuando no hay filas ocultas en el rango. El valor se produce null cuando algunas filas de un rango están ocultas y otras filas del mismo rango no están ocultas.

rowHidden: boolean;

Valor de propiedad

boolean

Comentarios

rowIndex

Devuelve el número de fila de la primera celda del intervalo. Indizado con cero.

readonly rowIndex: number;

Valor de propiedad

number

Comentarios

sort

Representa la ordenación del intervalo del intervalo actual.

readonly sort: Excel.RangeSort;

Valor de propiedad

Excel.RangeSort

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-column-and-row-sort.yaml

async function sortTopToBottom(criteria: string) {
    await Excel.run(async (context) => {
        const sheet = context.workbook.worksheets.getActiveWorksheet();
        const range = sheet.getRange("A1:E5");

        // Find the column header that provides the sort criteria.
        const header = range.find(criteria, {});
        header.load("columnIndex");
        await context.sync();

        range.sort.apply(
            [
                {
                    key: header.columnIndex,
                    sortOn: Excel.SortOn.value
                }
            ],
            false /*matchCase*/,
            true /*hasHeaders*/,
            Excel.SortOrientation.rows
        );
        await context.sync();
    });
}

style

Representa el estilo del rango actual. Si los estilos de las celdas son incoherentes, null se devolverá. Para los estilos personalizados, se devolverá el nombre del estilo. Para los estilos integrados, se devolverá una cadena que representa un valor de la BuiltInStyle enumeración.

style: string;

Valor de propiedad

string

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml

await Excel.run(async (context) => {
    let worksheet = context.workbook.worksheets.getItem("Sample");
    let range = worksheet.getRange("A1:E1");

    // Apply built-in style. 
    // Styles are in the Home tab ribbon.
    range.style = Excel.BuiltInStyle.neutral;
    range.format.horizontalAlignment = "Right";

    await context.sync();
});

text

Valores de texto del intervalo especificado. El valor Text no dependerá del ancho de la celda. La sustitución de signos de número (#) que se produce en la interfaz de usuario de Excel no afectará al valor de texto devuelto por la API.

readonly text: string[][];

Valor de propiedad

string[][]

Comentarios

top

Devuelve la distancia en puntos, para un zoom del 100%, desde el borde superior de la hoja de cálculo hasta el borde superior del rango.

readonly top: number;

Valor de propiedad

number

Comentarios

values

Representa los valores sin formato del rango especificado. Los datos devueltos pueden ser una cadena, un número o un valor booleano. Las celdas que contienen un error devolverán la cadena de error. Si el valor devuelto comienza con un signo más ("+"), menos ("-") o igual ("="), Excel interpretará este valor como una fórmula. Las cadenas con forma de configuración regional (como la fecha "19-8-2025" en nl-NL o fr-FR, formato DD-MM-AAAA) se almacenan como texto en lugar de como fechas. Para asegurarse de que las fechas se almacenan como fechas, use una API compatible con la configuración regional, como formulasLocal o use un formato independiente de la configuración regional, como ISO (AAAAA-MM-DD) o una serie de fechas numéricas.

values: any[][];

Valor de propiedad

any[][]

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml

// Change the value of the checkbox in B3.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getActiveWorksheet();
  const range = sheet.getRange("B3");

  range.values = [["TRUE"]];
  await context.sync();
});

valueTypes

Especifica el tipo de datos de cada celda.

readonly valueTypes: Excel.RangeValueType[][];

Valor de propiedad

Excel.RangeValueType[][]

Comentarios

width

Devuelve la distancia en puntos, para un zoom del 100 %, desde el borde izquierdo del rango hasta el borde derecho del rango.

readonly width: number;

Valor de propiedad

number

Comentarios

worksheet

Hoja de cálculo que contiene el rango actual.

readonly worksheet: Excel.Worksheet;

Valor de propiedad

Excel.Worksheet

Comentarios

Conjunto de API: ExcelApi 1.9, ExcelApi Preview for null destinationRange

autoFill(destinationRange, autoFillType)

Rellena un rango desde el rango actual hasta el rango de destino utilizando la lógica de Autorrellenar especificada. El rango de destino puede ser null o puede extender el rango de origen horizontal o verticalmente. No se admiten intervalos discontinuos.

Para obtener más información, consulte Uso de Autorrellenar y Relleno rápido.

autoFill(destinationRange?: Range | string, autoFillType?: Excel.AutoFillType): void;

Parámetros

destinationRange: Excel.Range | string

El rango de destino para autorrellenar. Si el rango de destino es null, los datos se rellenan en función de las celdas circundantes (que es el comportamiento al hacer doble clic en el controlador de relleno de rango de la interfaz de usuario).

autoFillType: Excel.AutoFillType

El tipo de Autorrellenar. Especifica cómo se debe rellenar el intervalo de destino, en función del contenido del intervalo actual. El valor predeterminado es "FillDefault".

Devoluciones

void

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-auto-fill.yaml

await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getActiveWorksheet();
  const sumCell = sheet.getRange("P4");
  
  // Copy everything. The formulas will be contextually updated based on their new locations.
  sumCell.autoFill("P4:P7", Excel.AutoFillType.fillCopy);
  sumCell.format.autofitColumns();
  await context.sync();
});

autoFill(destinationRange, autoFillType)

Rellena un rango desde el rango actual hasta el rango de destino utilizando la lógica de Autorrellenar especificada. El rango de destino puede ser null o puede extender el rango de origen horizontal o verticalmente. No se admiten intervalos discontinuos.

Para obtener más información, consulte Uso de Autorrellenar y Relleno rápido.

autoFill(destinationRange?: Range | string, autoFillType?: "FillDefault" | "FillCopy" | "FillSeries" | "FillFormats" | "FillValues" | "FillDays" | "FillWeekdays" | "FillMonths" | "FillYears" | "LinearTrend" | "GrowthTrend" | "FlashFill"): void;

Parámetros

destinationRange: Excel.Range | string

El rango de destino para autorrellenar. Si el rango de destino es null, los datos se rellenan en función de las celdas circundantes (que es el comportamiento al hacer doble clic en el controlador de relleno de rango de la interfaz de usuario).

autoFillType: "FillDefault" | "FillCopy" | "FillSeries" | "FillFormats" | "FillValues" | "FillDays" | "FillWeekdays" | "FillMonths" | "FillYears" | "LinearTrend" | "GrowthTrend" | "FlashFill"

El tipo de Autorrellenar. Especifica cómo se debe rellenar el intervalo de destino, en función del contenido del intervalo actual. El valor predeterminado es "FillDefault".

Devoluciones

void

Comentarios

Conjunto de API: ExcelApi 1.9, ExcelApi Preview for null destinationRange

calculate()

Calcula un rango de celdas en una hoja de cálculo.

calculate(): void;

Devoluciones

void

Comentarios

Conjunto de API: ExcelApi 1.6

clear(applyTo)

Borrar valores de rango y formato, como relleno y borde.

clear(applyTo?: Excel.ClearApplyTo): void;

Parámetros

applyTo: Excel.ClearApplyTo

Opcional. Determina el tipo de acción de borrado. Vea Excel.ClearApplyTo para más información.

Devoluciones

void

Comentarios

Ejemplos

// Clear the format and contents of the range.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "D:F";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.clear();
    await context.sync(); 
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/insert-delete-clear-range.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range: Excel.Range = sheet.getRange("E2:E5");

    range.clear();

    await context.sync();
});

clear(applyTo)

Borrar valores de rango y formato, como relleno y borde.

clear(applyTo?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"): void;

Parámetros

applyTo: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"

Opcional. Determina el tipo de acción de borrado. Vea Excel.ClearApplyTo para más información.

Devoluciones

void

Comentarios

convertDataTypeToText()

Convierte las celdas de rango con tipos de datos en texto.

convertDataTypeToText(): void;

Devoluciones

void

Comentarios

convertToLinkedDataType(serviceID, languageCulture)

Convierte las celdas de rango en tipos de datos vinculados en la hoja de cálculo.

convertToLinkedDataType(serviceID: number, languageCulture: string): void;

Parámetros

serviceID: number

El identificador de servicio que se usará para consultar los datos.

languageCulture: string

Referencia cultural lingüística para consultar el servicio.

Devoluciones

void

Comentarios

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Copia los datos o el formato de celda del rango de origen o RangeAreas al rango actual. El rango de destino puede tener un tamaño diferente del rango de origen o RangeAreas. El destino se expande automáticamente si es más pequeño que el origen. Nota: Al igual que la funcionalidad de copia en la interfaz de usuario de Excel, si el rango de destino es un múltiplo exacto mayor que el rango de origen en filas o columnas, el contenido de origen se replica varias veces. Por ejemplo, una copia de un rango 2x2 en un rango de 2x6 dará como resultado 3 copias del rango de 2x2 original.

copyFrom(sourceRange: Range | RangeAreas | string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean): void;

Parámetros

sourceRange: Excel.Range | Excel.RangeAreas | string

El rango de origen o RangeAreas desde el que copiar. Cuando el origen RangeAreas tiene varios rangos, su forma debe poder crearse quitando filas o columnas completas de un rango rectangular.

copyType: Excel.RangeCopyType

El tipo de datos o formato de celda que se va a copiar. El valor predeterminado es "Todos".

skipBlanks: boolean

Verdadero si quiere omitir celdas en blanco en el rango de origen. El valor predeterminado es false.

transpose: boolean

Verdadero si se transponen las celdas del rango de destino. El valor predeterminado es false.

Devoluciones

void

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-copyfrom.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    // Place a label in front of the copied data.
    sheet.getRange("F2").values = [["Copied Formula"]];

    // Copy a range preserving the formulas.
    // Note: non-formula values are copied over as is.
    sheet.getRange("G2").copyFrom("A1:E1", Excel.RangeCopyType.formulas);
    await context.sync();
});

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Copia los datos o el formato de celda del rango de origen o RangeAreas al rango actual. El rango de destino puede tener un tamaño diferente del rango de origen o RangeAreas. El destino se expande automáticamente si es más pequeño que el origen. Nota: Al igual que la funcionalidad de copia en la interfaz de usuario de Excel, si el rango de destino es un múltiplo exacto mayor que el rango de origen en filas o columnas, el contenido de origen se replica varias veces. Por ejemplo, una copia de un rango 2x2 en un rango de 2x6 dará como resultado 3 copias del rango de 2x2 original.

copyFrom(sourceRange: Range | RangeAreas | string, copyType?: "All" | "Formulas" | "Values" | "Formats" | "Link", skipBlanks?: boolean, transpose?: boolean): void;

Parámetros

sourceRange: Excel.Range | Excel.RangeAreas | string

El rango de origen o RangeAreas desde el que copiar. Cuando el origen RangeAreas tiene varios rangos, su forma debe poder crearse quitando filas o columnas completas de un rango rectangular.

copyType: "All" | "Formulas" | "Values" | "Formats" | "Link"

El tipo de datos o formato de celda que se va a copiar. El valor predeterminado es "Todos".

skipBlanks: boolean

Verdadero si quiere omitir celdas en blanco en el rango de origen. El valor predeterminado es false.

transpose: boolean

Verdadero si se transponen las celdas del rango de destino. El valor predeterminado es false.

Devoluciones

void

Comentarios

delete(shift)

Elimina las celdas asociadas al rango.

delete(shift: Excel.DeleteShiftDirection): void;

Parámetros

shift: Excel.DeleteShiftDirection

Especifica hacia dónde se desplazarán las celdas. Vea Excel.DeleteShiftDirection para más información.

Devoluciones

void

Comentarios

Ejemplos

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "D:F";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.delete("Left");
    await context.sync(); 
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet.yaml

// This function deletes data from a range and sets the delete shift direction to "up".
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range: Excel.Range = sheet.getRange("A5:F5");
    range.delete(Excel.DeleteShiftDirection.up);
});

delete(shift)

Elimina las celdas asociadas al rango.

delete(shift: "Up" | "Left"): void;

Parámetros

shift: "Up" | "Left"

Especifica hacia dónde se desplazarán las celdas. Vea Excel.DeleteShiftDirection para más información.

Devoluciones

void

Comentarios

find(text, criteria)

Busca la cadena especificada, según los criterios especificados. Si el rango actual es mayor que una celda, la búsqueda se limitará a ese rango; de lo contrario, la búsqueda cubrirá toda la hoja a partir de esa celda.

find(text: string, criteria: Excel.SearchCriteria): Excel.Range;

Parámetros

text: string

La cadena que se va a buscar.

criteria: Excel.SearchCriteria

Criterios de búsqueda adicionales, como la dirección de búsqueda y si la búsqueda debe coincidir con toda la celda o distinguir mayúsculas de minúsculas.

Devoluciones

Excel.Range

Objeto Range que representa la primera celda que contiene un valor que coincide con el texto y los criterios de búsqueda.

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-find.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const table = sheet.tables.getItem("ExpensesTable");
    const searchRange = table.getRange();

    // NOTE: If no match is found, an ItemNotFound error
    // is thrown when Range.find is evaluated.
    const searchText = (document.getElementById("searchText") as HTMLTextAreaElement).value;
    const foundRange = searchRange.find(searchText, {
        completeMatch: isCompleteMatchToggle,
        matchCase: isMatchCaseToggle,
        searchDirection: searchDirectionToggle
    });
    
    foundRange.load("address");
    await context.sync();

    console.log(foundRange.address);
});

findOrNullObject(text, criteria)

Busca la cadena especificada, según los criterios especificados. Si el rango actual es mayor que una celda, la búsqueda se limitará a ese rango; de lo contrario, la búsqueda cubrirá toda la hoja a partir de esa celda. Si no hay coincidencias, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.

findOrNullObject(text: string, criteria: Excel.SearchCriteria): Excel.Range;

Parámetros

text: string

La cadena que se va a buscar.

criteria: Excel.SearchCriteria

Criterios de búsqueda adicionales, como la dirección de búsqueda y si la búsqueda debe coincidir con toda la celda o distinguir mayúsculas de minúsculas.

Devoluciones

Excel.Range

Los Range que coincidan con los criterios de búsqueda.

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-find.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const table = sheet.tables.getItem("ExpensesTable");
    const searchRange = table.getRange();
    const searchText = (document.getElementById("searchText") as HTMLTextAreaElement).value;
    const foundRange = searchRange.findOrNullObject(searchText, {
        completeMatch: isCompleteMatchToggle,
        matchCase: isMatchCaseToggle,
        searchDirection: searchDirectionToggle
    });
    
    foundRange.load("address");
    await context.sync();

    if (foundRange.isNullObject) {
        console.log("Text not found");
    } else {
        console.log(foundRange.address);
    }
});

flashFill()

Rellena rápidamente el rango actual. Relleno rápido rellena automáticamente los datos cuando detecta un patrón, por lo que el rango debe ser un rango de una sola columna y tener datos a su alrededor para encontrar un patrón.

flashFill(): void;

Devoluciones

void

Comentarios

getAbsoluteResizedRange(numRows, numColumns)

Obtiene un Range objeto con la misma celda superior izquierda que el objeto actual Range , pero con el número especificado de filas y columnas.

getAbsoluteResizedRange(numRows: number, numColumns: number): Excel.Range;

Parámetros

numRows: number

El número de filas del nuevo tamaño de rango.

numColumns: number

El número de columnas del nuevo tamaño del rango.

Devoluciones

Excel.Range

Comentarios

getBoundingRect(anotherRange)

Obtiene el objeto de intervalo más pequeño que abarca los intervalos especificados. Por ejemplo, el GetBoundingRect valor de "B2:C5" y "D10:E15" es "B2:E15".

getBoundingRect(anotherRange: Range | string): Excel.Range;

Parámetros

anotherRange: Excel.Range | string

El objeto de rango, la dirección o el nombre del rango.

Devoluciones

Excel.Range

Comentarios

Ejemplos

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "D4:G6";
    let range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range = range.getBoundingRect("G4:H8");
    range.load('address');
    await context.sync();
    
    console.log(range.address); // Prints Sheet1!D4:H8
});

getCell(row, column)

Obtiene el objeto de intervalo que contiene la celda en función de los números de fila y columna. La celda puede estar fuera de los límites de su rango primario siempre que se mantenga dentro de la cuadrícula de la hoja de cálculo. La celda devuelta se ubica con respecto a la celda superior izquierda del intervalo.

getCell(row: number, column: number): Excel.Range;

Parámetros

row: number

Número de fila de la celda que se va a recuperar. Indizado con cero.

column: number

Número de columna de la celda que se va a recuperar. Indizado con cero.

Devoluciones

Excel.Range

Comentarios

Ejemplos

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const cell = range.getCell(0,0);
    cell.load('address');
    await context.sync();
    
    console.log(cell.address);
});

getCellProperties(cellPropertiesLoadOptions)

Devuelve una matriz 2D que encapsula los datos para la fuente, el relleno, los bordes, la alineación y otras propiedades de la celda.

getCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions): OfficeExtension.ClientResult<CellProperties[][]>;

Parámetros

cellPropertiesLoadOptions: Excel.CellPropertiesLoadOptions

Un objeto que representa las propiedades de la celda que se van a cargar.

Devoluciones

OfficeExtension.ClientResult<Excel.CellProperties[][]>

Una matriz 2D donde cada elemento representa las propiedades solicitadas de la celda correspondiente.

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml

await Excel.run(async (context) => {
    const cell = context.workbook.getActiveCell();

    // Get only the properties requested in this load-options object.
    const propertiesToGet: Excel.CellPropertiesLoadOptions = {
        address: true,
        format: {
            fill: {
                color: true
            },
            font: {
                bold: true,
                color: true
            }
        },
        style: true
    };
    const cellProperties = cell.getCellProperties(propertiesToGet);

    await context.sync();
    const activeCellProperties: Excel.CellProperties = cellProperties.value[0][0];
    console.log(JSON.stringify(activeCellProperties, null, 2));
});

getColumn(column)

Obtiene una columna contenida en el intervalo.

getColumn(column: number): Excel.Range;

Parámetros

column: number

Número de columna del intervalo que se va a recuperar. Indizado con cero.

Devoluciones

Excel.Range

Comentarios

OfficeExtension.ClientResult<Excel.ColumnProperties[]>

Ejemplos

await Excel.run(async (context) => { 
    const sheetName = "Sheet19";
    const rangeAddress = "A1:F8";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getColumn(1);
    range.load('address');
    await context.sync();

    console.log(range.address); // prints Sheet1!B1:B8
});

getColumnProperties(columnPropertiesLoadOptions)

Devuelve una matriz de una sola dimensión que encapsula los datos para la fuente, el relleno, los bordes, la alineación y otras propiedades de la columna. Se devolverá null para las propiedades que no son coherentes en cada celda de una columna determinada.

getColumnProperties(columnPropertiesLoadOptions: ColumnPropertiesLoadOptions): OfficeExtension.ClientResult<ColumnProperties[]>;

Parámetros

columnPropertiesLoadOptions: Excel.ColumnPropertiesLoadOptions

Un objeto que representa qué propiedades de columna cargar.

Devoluciones

Una matriz donde cada elemento representa las propiedades solicitadas de la columna correspondiente.

Comentarios

getColumnsAfter(count)

Obtiene un cierto número de columnas a la derecha del objeto actual Range .

getColumnsAfter(count?: number): Excel.Range;

Parámetros

count: number

Opcional. El número de columnas que se va a incluir en el rango resultante. En general, use un número positivo para crear un intervalo fuera del intervalo actual. También puede usar un número negativo para crear un intervalo dentro del intervalo actual. El valor predeterminado es 1.

Devoluciones

Excel.Range

Comentarios

getColumnsBefore(count)

Obtiene un cierto número de columnas a la izquierda del objeto actual Range .

getColumnsBefore(count?: number): Excel.Range;

Parámetros

count: number

Opcional. El número de columnas que se va a incluir en el rango resultante. En general, use un número positivo para crear un intervalo fuera del intervalo actual. También puede usar un número negativo para crear un intervalo dentro del intervalo actual. El valor predeterminado es 1.

Devoluciones

Excel.Range

Comentarios

getEntireColumn()

Obtiene un objeto que representa toda la columna del rango (por ejemplo, si el rango actual representa las celdas "B4:E11", este getEntireColumn es un rango que representa las columnas "B:E").

getEntireColumn(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

Ejemplos

// Note: the grid properties of the Range (values, numberFormat, formulas) 
// contains null since the Range in question is unbounded.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "D:F";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    const rangeEC = range.getEntireColumn();
    rangeEC.load('address');
    await context.sync();
    
    console.log(rangeEC.address);
});

getEntireRow()

Obtiene un objeto que representa toda la fila del rango (por ejemplo, si el rango actual representa las celdas "B4:E11", este GetEntireRow es un rango que representa las filas "4:11").

getEntireRow(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

Ejemplos

// Gets an object that represents the entire row of the range 
// (for example, if the current range represents cells "B4:E11", 
// its GetEntireRow is a range that represents rows "4:11").
await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "D:F"; 
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    const rangeER = range.getEntireRow();
    rangeER.load('address');
    await context.sync();
    
    console.log(rangeER.address);
});

getImage()

Representa el rango como una imagen PNG codificada en Base64.

getImage(): OfficeExtension.ClientResult<string>;

Devoluciones

OfficeExtension.ClientResult<string>

Comentarios

getIntersection(anotherRange)

Obtiene el objeto de rango que representa la intersección rectangular de los rangos especificados.

getIntersection(anotherRange: Range | string): Excel.Range;

Parámetros

anotherRange: Excel.Range | string

Objeto de intervalo o dirección de intervalo que se usará para determinar la intersección de los intervalos.

Devoluciones

Excel.Range

Comentarios

Conjunto de API: ExcelApi 1.4

Ejemplos

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const range = 
        context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getIntersection("D4:G6");
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!D4:F6
});

getIntersectionOrNullObject(anotherRange)

Obtiene el objeto de rango que representa la intersección rectangular de los rangos especificados. Si no se encuentra ninguna intersección, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.

getIntersectionOrNullObject(anotherRange: Range | string): Excel.Range;

Parámetros

anotherRange: Excel.Range | string

Objeto de intervalo o dirección de intervalo que se usará para determinar la intersección de los intervalos.

Devoluciones

Excel.Range

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-relationships.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const salesTable = sheet.tables.getItem("SalesTable");
    const dataRange = salesTable.getDataBodyRange();

    // We want the most recent quarter that has data, so
    // exclude quarters without data and get the last of
    // the remaining columns.
    const usedDataRange = dataRange.getUsedRange(true /* valuesOnly */);
    const currentQuarterRange = usedDataRange.getLastColumn();

    // Asian and European teams have separate contests.
    const asianSalesRange = sheet.getRange("A2:E4");
    const europeanSalesRange = sheet.getRange("A5:E7");

    // The data for each chart is the intersection of the
    // current quarter column and the rows for the continent.
    const asianContestRange = asianSalesRange.getIntersectionOrNullObject(currentQuarterRange);
    const europeanContestRange = europeanSalesRange.getIntersectionOrNullObject(currentQuarterRange);

    // Must sync before you can test the output of *OrNullObject
    // method/property.
    await context.sync();

    if (asianContestRange.isNullObject) {
        // See the declaration of this function for how to
        // test this code path.
        reportMissingData("Asian");
    } else {
        createContinentChart(
            sheet,
            "Asian",
            asianContestRange,
            "A9",
            "F24"
        );
    }

    if (europeanContestRange.isNullObject) {
        // See the declaration of this function for how to
        // test this code path.
        reportMissingData("European");
    } else {
        createContinentChart(
            sheet,
            "European",
            europeanContestRange,
            "A25",
            "F40"
        );
    }

    await context.sync();
});

getLastCell()

Obtiene la última celda del intervalo. Por ejemplo, la última celda de "B2:D5" es "D5".

getLastCell(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

Ejemplos

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastCell();
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!F8
});

getLastColumn()

Obtiene la última columna del intervalo. Por ejemplo, la última columna de "B2:D5" es "D2:D5".

getLastColumn(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

Ejemplos

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastColumn();
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!F1:F8
});

getLastRow()

Obtiene la última fila del intervalo. Por ejemplo, la última fila de "B2:D5" es "B5:D5".

getLastRow(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

Ejemplos

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastRow();
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!A8:F8
});

getOffsetRange(rowOffset, columnOffset)

Obtiene un objeto que representa un intervalo desplazado con respecto al intervalo especificado. La dimensión del rango devuelto coincidirá con este rango. Si el rango resultante se fuerza más allá de los límites de la cuadrícula de la hoja de cálculo, se producirá un error.

getOffsetRange(rowOffset: number, columnOffset: number): Excel.Range;

Parámetros

rowOffset: number

Número de filas (número positivo, negativo o 0) que debe desplazarse el intervalo. Los valores positivos desplazan hacia abajo, mientras que los negativos lo hacen hacia arriba.

columnOffset: number

Número de columnas (número positivo, negativo o 0) que debe desplazarse el intervalo. Los valores positivos desplazan hacia la derecha, mientras que los negativos lo hacen hacia la izquierda.

Devoluciones

Excel.Range

Comentarios

Ejemplos

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "D4:F6";
    const range = 
        context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getOffsetRange(-1,4);
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!H3:J5
});

getResizedRange(deltaRows, deltaColumns)

Obtiene un Range objeto similar al objeto actual Range , pero con su esquina inferior derecha expandida (o contraída) por un cierto número de filas y columnas.

getResizedRange(deltaRows: number, deltaColumns: number): Excel.Range;

Parámetros

deltaRows: number

El número de filas en el que se va a expandir la esquina inferior derecha, con respecto al intervalo actual. Use un número positivo para expandir el intervalo, o un número negativo para reducirlo.

deltaColumns: number

Número de columnas por las que se va a expandir la esquina inferior derecha, en relación con el rango actual. Use un número positivo para expandir el intervalo, o un número negativo para reducirlo.

Devoluciones

Excel.Range

Comentarios

getRow(row)

Obtiene una fila contenida en el intervalo.

getRow(row: number): Excel.Range;

Parámetros

row: number

Número de fila del intervalo que se va a recuperar. Indizado con cero.

Devoluciones

Excel.Range

Comentarios

OfficeExtension.ClientResult<Excel.RowProperties[]>

Ejemplos

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getRow(1);
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!A2:F2
});

getRowProperties(rowPropertiesLoadOptions)

Devuelve una matriz de una sola dimensión que encapsula los datos para la fuente, el relleno, los bordes, la alineación y otras propiedades de la fila. Para las propiedades que no son coherentes en todas las celdas de una fila determinada, null se devolverá.

getRowProperties(rowPropertiesLoadOptions: RowPropertiesLoadOptions): OfficeExtension.ClientResult<RowProperties[]>;

Parámetros

rowPropertiesLoadOptions: Excel.RowPropertiesLoadOptions

Un objeto que representa qué propiedades de fila se van a cargar.

Devoluciones

Una matriz donde cada elemento representa las propiedades solicitadas de la fila correspondiente.

Comentarios

getRowsAbove(count)

Obtiene un número determinado de filas por encima del objeto actual Range .

getRowsAbove(count?: number): Excel.Range;

Parámetros

count: number

Opcional. El número de filas que se va a incluir en el intervalo resultante. En general, use un número positivo para crear un intervalo fuera del intervalo actual. También puede usar un número negativo para crear un intervalo dentro del intervalo actual. El valor predeterminado es 1.

Devoluciones

Excel.Range

Comentarios

getRowsBelow(count)

Obtiene un cierto número de filas debajo del objeto actual Range .

getRowsBelow(count?: number): Excel.Range;

Parámetros

count: number

Opcional. El número de filas que se va a incluir en el intervalo resultante. En general, use un número positivo para crear un intervalo fuera del intervalo actual. También puede usar un número negativo para crear un intervalo dentro del intervalo actual. El valor predeterminado es 1.

Devoluciones

Excel.Range

Comentarios

getSpecialCells(cellType, cellValueType)

Obtiene el RangeAreas objeto, que comprende uno o más rangos rectangulares, que representa todas las celdas que coinciden con el tipo y valor especificados. Si no se encuentra ninguna celda especial, se producirá un ItemNotFound error.

getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;

Parámetros

cellType: Excel.SpecialCellType

El tipo de celdas que se van a incluir.

cellValueType: Excel.SpecialCellValueType

Si cellType es o constantsformulas, este argumento se usa para determinar qué tipos de celdas incluir en el resultado. Estos valores se pueden combinar para devolver más de un tipo. El valor predeterminado es seleccionar todas las constantes o fórmulas, sea cual sea el tipo.

Devoluciones

Excel.RangeAreas

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-areas.yaml

await Excel.run(async (context) => {

    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const usedRange = sheet.getUsedRange();

    // Find the ranges with either text or logical (boolean) values.
    const formulaRanges = usedRange.getSpecialCells("Constants", "LogicalText");
    formulaRanges.format.fill.color = "orange";

    return context.sync();
});

getSpecialCells(cellType, cellValueType)

Obtiene el RangeAreas objeto, que comprende uno o más rangos rectangulares, que representa todas las celdas que coinciden con el tipo y valor especificados. Si no se encuentra ninguna celda especial, se producirá un ItemNotFound error.

getSpecialCells(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

Parámetros

cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

El tipo de celdas que se van a incluir.

cellValueType: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

Si cellType es o constantsformulas, este argumento se usa para determinar qué tipos de celdas incluir en el resultado. Estos valores se pueden combinar para devolver más de un tipo. El valor predeterminado es seleccionar todas las constantes o fórmulas, sea cual sea el tipo.

Devoluciones

Excel.RangeAreas

Comentarios

getSpecialCellsOrNullObject(cellType, cellValueType)

Obtiene el RangeAreas objeto, que comprende uno o más rangos, que representa todas las celdas que coinciden con el tipo y valor especificados. Si no se encuentran celdas especiales, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.

getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;

Parámetros

cellType: Excel.SpecialCellType

El tipo de celdas que se van a incluir.

cellValueType: Excel.SpecialCellValueType

Si cellType es o constantsformulas, este argumento se usa para determinar qué tipos de celdas incluir en el resultado. Estos valores se pueden combinar para devolver más de un tipo. El valor predeterminado es seleccionar todas las constantes o fórmulas, sea cual sea el tipo.

Devoluciones

Excel.RangeAreas

Comentarios

getSpecialCellsOrNullObject(cellType, cellValueType)

Obtiene el RangeAreas objeto, que comprende uno o más rangos, que representa todas las celdas que coinciden con el tipo y valor especificados. Si no se encuentran celdas especiales, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.

getSpecialCellsOrNullObject(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

Parámetros

cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

El tipo de celdas que se van a incluir.

cellValueType: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

Si cellType es o constantsformulas, este argumento se usa para determinar qué tipos de celdas incluir en el resultado. Estos valores se pueden combinar para devolver más de un tipo. El valor predeterminado es seleccionar todas las constantes o fórmulas, sea cual sea el tipo.

Devoluciones

Excel.RangeAreas

Comentarios

getSurroundingRegion()

Devuelve un Range objeto que representa la región circundante de la celda superior izquierda de este rango. Una región circundante es un intervalo limitado por cualquier combinación de filas y columnas en blanco en relación a este intervalo.

getSurroundingRegion(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

getTables(fullyContained)

Obtiene una colección con ámbito de tablas que se superpone con el intervalo.

getTables(fullyContained?: boolean): Excel.TableScopedCollection;

Parámetros

fullyContained: boolean

Si true, devuelve solo las tablas que están completamente contenidas dentro de los límites del rango. El valor predeterminado es false.

Devoluciones

Excel.TableScopedCollection

Comentarios

getUsedRange(valuesOnly)

Devuelve el intervalo usado del objeto de rango especificado. Si no hay celdas usadas en el rango, esta función generará un ItemNotFound error.

getUsedRange(valuesOnly?: boolean): Excel.Range;

Parámetros

valuesOnly: boolean

Solo tiene en cuenta las celdas con valores como celdas usadas. [Conjunto de API: ExcelApi 1.2]

Devoluciones

Excel.Range

Comentarios

Conjunto de API: ExcelApi 1.4

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-relationships.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const salesTable = sheet.tables.getItem("SalesTable");
    const dataRange = salesTable.getDataBodyRange();

    // We want the most recent quarter that has data, so
    // exclude quarters without data and get the last of
    // the remaining columns.
    const usedDataRange = dataRange.getUsedRange(true /* valuesOnly */);
    const currentQuarterRange = usedDataRange.getLastColumn();

    // Asian and European teams have separate contests.
    const asianSalesRange = sheet.getRange("A2:E4");
    const europeanSalesRange = sheet.getRange("A5:E7");

    // The data for each chart is the intersection of the
    // current quarter column and the rows for the continent.
    const asianContestRange = asianSalesRange.getIntersectionOrNullObject(currentQuarterRange);
    const europeanContestRange = europeanSalesRange.getIntersectionOrNullObject(currentQuarterRange);

    // Must sync before you can test the output of *OrNullObject
    // method/property.
    await context.sync();

    if (asianContestRange.isNullObject) {
        // See the declaration of this function for how to
        // test this code path.
        reportMissingData("Asian");
    } else {
        createContinentChart(
            sheet,
            "Asian",
            asianContestRange,
            "A9",
            "F24"
        );
    }

    if (europeanContestRange.isNullObject) {
        // See the declaration of this function for how to
        // test this code path.
        reportMissingData("European");
    } else {
        createContinentChart(
            sheet,
            "European",
            europeanContestRange,
            "A25",
            "F40"
        );
    }

    await context.sync();
});

getUsedRangeOrNullObject(valuesOnly)

Devuelve el intervalo usado del objeto de rango especificado. Si no hay celdas usadas en el rango, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.

getUsedRangeOrNullObject(valuesOnly?: boolean): Excel.Range;

Parámetros

valuesOnly: boolean

Solo tiene en cuenta las celdas con valores como celdas usadas.

Devoluciones

Excel.Range

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/used-range.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const salesTable = sheet.tables.getItem("SalesTable");
    const dataRange = salesTable.getDataBodyRange();

    // Pass true so only cells with values count as used
    const usedDataRange = dataRange.getUsedRangeOrNullObject(
        true /* valuesOnly */
    );

    //Must sync before reading value returned from *OrNullObject method/property.
    await context.sync();

    if (usedDataRange.isNullObject) {
        console.log("Need Data to Make Chart");
        console.log("To create a meaningful chart, press 'Fill the table' (or add names to the Product column and numbers to some of the other cells). Then press 'Try to create chart' again.");
    } else {
        const chart = sheet.charts.add(
            Excel.ChartType.columnClustered,
            dataRange,
            "Columns"
        );
        chart.setPosition("A15", "F30");
        chart.title.text = "Quarterly sales chart";
        chart.legend.position = "Right";
        chart.legend.format.fill.setSolidColor("white");
        chart.dataLabels.format.font.size = 15;
        chart.dataLabels.format.font.color = "black";
    }

    await context.sync();
});

getVisibleView()

Representa las filas visibles del intervalo actual.

getVisibleView(): Excel.RangeView;

Devoluciones

Excel.RangeView

Comentarios

Conjunto de API: ExcelApi 1.3

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/46-table/get-visible-range-of-a-filtered-table.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const expensesTable = sheet.tables.getItem("ExpensesTable");                    
    const visibleRange = expensesTable.getDataBodyRange().getVisibleView().load("values");
    await sheet.context.sync();

    const visibleValues = visibleRange.values;
    console.log(visibleValues);
    await context.sync();
});

group(groupOption)

Agrupa columnas y filas para obtener un esquema.

group(groupOption: Excel.GroupOption): void;

Parámetros

groupOption: Excel.GroupOption

Especifica cómo se puede agrupar el rango por filas o columnas. Se genera un InvalidArgument error cuando la opción de grupo difiere de la propiedad o isEntireColumn del rango isEntireRow (es decir, range.isEntireRow es verdadera y groupOption es "ByColumns" o range.isEntireColumn es verdadera y groupOption es "ByRows").

Devoluciones

void

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/outline.yaml

Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    
    // Group the larger, main level. Note that the outline controls
    // will be on row 10, meaning 4-9 will collapse and expand.
    sheet.getRange("4:9").group(Excel.GroupOption.byRows);

    // Group the smaller, sublevels. Note that the outline controls
    // will be on rows 6 and 9, meaning 4-5 and 7-8 will collapse and expand.
    sheet.getRange("4:5").group(Excel.GroupOption.byRows);
    sheet.getRange("7:8").group(Excel.GroupOption.byRows);
    await context.sync();
});

group(groupOption)

Agrupa columnas y filas para obtener un esquema.

group(groupOption: "ByRows" | "ByColumns"): void;

Parámetros

groupOption: "ByRows" | "ByColumns"

Especifica cómo se puede agrupar el rango por filas o columnas. Se genera un InvalidArgument error cuando la opción de grupo difiere de la propiedad o isEntireColumn del rango isEntireRow (es decir, range.isEntireRow es verdadera y groupOption es "ByColumns" o range.isEntireColumn es verdadera y groupOption es "ByRows").

Devoluciones

void

Comentarios

hideGroupDetails(groupOption)

Oculta los detalles del grupo de filas o columnas.

hideGroupDetails(groupOption: Excel.GroupOption): void;

Parámetros

groupOption: Excel.GroupOption

Especifica si se ocultan los detalles de las filas o columnas agrupadas.

Devoluciones

void

Comentarios

hideGroupDetails(groupOption)

Oculta los detalles del grupo de filas o columnas.

hideGroupDetails(groupOption: "ByRows" | "ByColumns"): void;

Parámetros

groupOption: "ByRows" | "ByColumns"

Especifica si se ocultan los detalles de las filas o columnas agrupadas.

Devoluciones

void

Comentarios

insert(shift)

Inserta una celda o un intervalo de celdas en la hoja de cálculo en lugar de este intervalo y desplaza las demás celdas para crear espacio. Devuelve un nuevo Range objeto en el espacio en blanco.

insert(shift: Excel.InsertShiftDirection): Excel.Range;

Parámetros

shift: Excel.InsertShiftDirection

Especifica hacia dónde se desplazarán las celdas. Vea Excel.InsertShiftDirection para más información.

Devoluciones

Excel.Range

Comentarios

Ejemplos

await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "F5:F10";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.insert(Excel.InsertShiftDirection.down);
    await context.sync();
});

insert(shift)

Inserta una celda o un intervalo de celdas en la hoja de cálculo en lugar de este intervalo y desplaza las demás celdas para crear espacio. Devuelve un nuevo Range objeto en el espacio en blanco.

insert(shift: "Down" | "Right"): Excel.Range;

Parámetros

shift: "Down" | "Right"

Especifica hacia dónde se desplazarán las celdas. Vea Excel.InsertShiftDirection para más información.

Devoluciones

Excel.Range

Comentarios

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Excel.Interfaces.RangeLoadOptions): Excel.Range;

Parámetros

options: Excel.Interfaces.RangeLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.Range

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNames?: string | string[]): Excel.Range;

Parámetros

propertyNames: string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Excel.Range

Ejemplos

// Use the range address to get the range object.
await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8"; 
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    range.load('cellCount');
    await context.sync();
    
    console.log(range.cellCount);
});

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Range;

Parámetros

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Excel.Range

merge(across)

Combina las celdas del intervalo en una región de la hoja de cálculo.

merge(across?: boolean): void;

Parámetros

across: boolean

Opcional. Establecer true para combinar las celdas de cada fila del rango especificado como celdas combinadas independientes. El valor predeterminado es false.

Devoluciones

void

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-merged-ranges.yaml

await Excel.run(async (context) => {
  // Retrieve the worksheet and the table in that worksheet.
  const sheet = context.workbook.worksheets.getActiveWorksheet();
  const tableRange = sheet.getRange("B2:E6");

  // Create a merged range in the first row of the table.
  const chartTitle = tableRange.getRow(0);
  chartTitle.merge(true);

  // Format the merged range.
  chartTitle.format.horizontalAlignment = "Center";

  await context.sync();
});

removeDuplicates(columns, includesHeader)

Quita los valores duplicados del intervalo especificado por las columnas.

removeDuplicates(columns: number[], includesHeader: boolean): Excel.RemoveDuplicatesResult;

Parámetros

columns: number[]

Las columnas del rango que pueden contener duplicados. Es necesario especificar al menos una columna. Indizado con cero.

includesHeader: boolean

True si los datos de entrada contienen un encabezado. El valor predeterminado es false.

Devoluciones

Excel.RemoveDuplicatesResult

El objeto resultante que contiene el número de filas eliminadas y el número de filas únicas restantes.

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-remove-duplicates.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B2:D11");

    const deleteResult = range.removeDuplicates([0],true);    
    deleteResult.load();    
    await context.sync();

    console.log(deleteResult.removed + " entries with duplicate names removed.");
    console.log(deleteResult.uniqueRemaining + " entries with unique names remain in the range.");
});

replaceAll(text, replacement, criteria)

Busca y reemplaza la cadena especificada, según los criterios especificados dentro del intervalo actual.

replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria): OfficeExtension.ClientResult<number>;

Parámetros

text: string

Cadena que se va a buscar.

replacement: string

Cadena que reemplaza a la cadena original.

criteria: Excel.ReplaceCriteria

Criterios de reemplazo adicionales.

Devoluciones

OfficeExtension.ClientResult<number>

El número de reemplazos realizados.

Comentarios

select()

Selecciona el intervalo especificado en la interfaz de usuario de Excel.

select(): void;

Devoluciones

void

Comentarios

Ejemplos

await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "F5:F10"; 
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.select();
    await context.sync(); 
});

set(properties, options)

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo.

set(properties: Interfaces.RangeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties: Excel.Interfaces.RangeUpdateData

Un objeto JavaScript con propiedades que están estructuradas isomorfamente a las propiedades del objeto en el que se llama al método.

options: OfficeExtension.UpdateOptions

Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.

Devoluciones

void

set(properties)

Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente.

set(properties: Excel.Range): void;

Parámetros

properties: Excel.Range

Devoluciones

void

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/90-scenarios/multiple-property-set.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    const sourceRange = sheet.getRange("B2:E2");
    sourceRange.load("format/fill/color, format/font/name, format/font/color");
    await context.sync();

    // Set properties based on the loaded and synced 
    // source range.
    const targetRange = sheet.getRange("B7:E7");
    targetRange.set(sourceRange); 
    targetRange.format.autofitColumns();
    await context.sync();
});

setCellProperties(cellPropertiesData)

Actualiza las novedades del rango en función de una matriz 2D de propiedades de celda, encapsulando elementos como fuente, relleno, bordes y alineación.

setCellProperties(cellPropertiesData: SettableCellProperties[][]): void;

Parámetros

cellPropertiesData: Excel.SettableCellProperties[][]

Una matriz 2D que representa qué propiedades establecer en cada celda.

Devoluciones

void

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // Create the SettableCellProperties objects for the range.
    // Create these objects once, outside the function, in your add-in.
    const topHeaderProps: Excel.SettableCellProperties = {
        // Set the style property to the name of an Excel style.
        // The `BuiltInStyle` enum lists the built-in style names.
        // A style overwrites formatting, so don't use style and format in the same object.
        style: Excel.BuiltInStyle.heading1
    };

    const headerProps: Excel.SettableCellProperties = {
        // Setting these cell properties doesn't change unspecified format subproperties.
        format: {
            fill: {
                color: "Blue"
            },
            font: {
                color: "White",
                bold: true
            }
        }
    };

    const nonApplicableProps: Excel.SettableCellProperties = {
        format: {
            fill: {
                pattern: Excel.FillPattern.gray25
            },
            font: {
                color: "Gray",
                italic: true
            }
        }
    };

    const matchupScoreProps: Excel.SettableCellProperties = {
        format: {
            borders: {
                bottom: {
                    style: Excel.BorderLineStyle.continuous
                },
                left: {
                    style: Excel.BorderLineStyle.continuous
                },
                right: {
                    style: Excel.BorderLineStyle.continuous
                },
                top: {
                    style: Excel.BorderLineStyle.continuous
                }
            },
            horizontalAlignment: Excel.HorizontalAlignment.center
        }
    };

    const range = sheet.getRange("A1:E5");

    // Use empty JSON objects to leave a cell's properties unchanged.
    range.setCellProperties([
        [topHeaderProps, {}, {}, {}, {}],
        [{}, {}, headerProps, headerProps, headerProps],
        [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps],
        [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps],
        [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps]
    ]);

    sheet.getUsedRange().format.autofitColumns();
    await context.sync();
});

setColumnProperties(columnPropertiesData)

Novedades el rango en función de una matriz unidimensional de propiedades de columna, encapsulando elementos como la fuente, el relleno, los bordes y la alineación.

setColumnProperties(columnPropertiesData: SettableColumnProperties[]): void;

Parámetros

columnPropertiesData: Excel.SettableColumnProperties[]

Una matriz que representa qué propiedades establecer en cada columna.

Devoluciones

void

Comentarios

setDirty()

Establece un intervalo que se deberá actualizar cuando se realice la próxima actualización.

setDirty(): void;

Devoluciones

void

Comentarios

setRowProperties(rowPropertiesData)

Novedades el rango en función de una matriz unidimensional de propiedades de fila, encapsulando elementos como fuente, relleno, bordes y alineación.

setRowProperties(rowPropertiesData: SettableRowProperties[]): void;

Parámetros

rowPropertiesData: Excel.SettableRowProperties[]

Una matriz que representa qué propiedades establecer en cada fila.

Devoluciones

void

Comentarios

showCard()

Muestra la tarjeta de una celda activa si tiene contenido de valor enriquecido.

showCard(): void;

Devoluciones

void

Comentarios

showGroupDetails(groupOption)

Muestra los detalles del grupo de filas o columnas.

showGroupDetails(groupOption: Excel.GroupOption): void;

Parámetros

groupOption: Excel.GroupOption

Especifica si se mostrarán los detalles de las filas o columnas agrupadas.

Devoluciones

void

Comentarios

showGroupDetails(groupOption)

Muestra los detalles del grupo de filas o columnas.

showGroupDetails(groupOption: "ByRows" | "ByColumns"): void;

Parámetros

groupOption: "ByRows" | "ByColumns"

Especifica si se mostrarán los detalles de las filas o columnas agrupadas.

Devoluciones

void

Comentarios

toJSON()

Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.Range es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.RangeData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

toJSON(): Excel.Interfaces.RangeData;

Devoluciones

Excel.Interfaces.RangeData

track()

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura de context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y recibe un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos objeto de seguimiento cuando se creó el objeto por primera vez.

track(): Excel.Range;

Devoluciones

Excel.Range

ungroup(groupOption)

Desagrupa las columnas y filas para obtener un esquema.

ungroup(groupOption: Excel.GroupOption): void;

Parámetros

groupOption: Excel.GroupOption

Especifica cómo se puede desagrupar el rango por filas o columnas.

Devoluciones

void

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/outline.yaml

Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    
    // This removes two levels of groups from the "A1-R10" range.
    // Any groups at the same level on the same dimension will be removed by a single call.
    sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byRows);
    sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byRows);
    sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byColumns);
    sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byColumns);
    await context.sync();
});

ungroup(groupOption)

Desagrupa las columnas y filas para obtener un esquema.

ungroup(groupOption: "ByRows" | "ByColumns"): void;

Parámetros

groupOption: "ByRows" | "ByColumns"

Especifica cómo se puede desagrupar el rango por filas o columnas.

Devoluciones

void

Comentarios

unmerge()

Separa las celdas del intervalo en celdas independientes.

unmerge(): void;

Devoluciones

void

Comentarios