Excel. Range class

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 la referencia de rango en estilo A1. El valor de dirección contiene la referencia de hoja (por ejemplo, "Sheet1! A1:B4").
addressLocal	Representa la referencia de intervalo para el intervalo 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 intervalo.
columnHidden	Representa si todas las columnas del intervalo actual están ocultas. El valor es `true` cuando todas las columnas de un intervalo están ocultas. El valor es `false` cuando no se oculta ninguna columna del 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 intervalo. Indizado con cero.
conditionalFormats	La colección de `ConditionalFormats` que interseca el intervalo.
context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
control	Obtiene acceso al control de celda aplicado a este rango. Si el rango tiene varios controles de celda, devuelve `EmptyCellControl`.
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 ninguna fórmula, su valor se devuelve 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 ninguna fórmula, su valor se devuelve en su lugar.
formulasR1C1	Representa la fórmula en notación de estilo R1C1. Si una celda no tiene ninguna fórmula, su valor se devuelve en su lugar.
hasSpill	Indica si todas las celdas tienen un borde de desbordamiento. Devuelve `true` si todas las celdas tienen un borde de derrame o `false` si todas las celdas no tienen un borde de desbordamiento. Devuelve `null` si hay celdas con y sin bordes de desbordamiento dentro del intervalo.
height	Devuelve la distancia en puntos, para un zoom del 100 %, desde el borde superior del rango hasta el borde inferior del intervalo.
hidden	Representa si todas las celdas del rango actual están ocultas. El valor es `true` cuando todas las celdas de un rango están ocultas. El valor es `false` cuando no se oculta ninguna celda del rango. El valor es `null` cuando algunas celdas de un rango están ocultas y otras celdas del mismo rango no están ocultas.
hyperlink	Representa el hipervínculo del intervalo 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 el intervalo especificado. Para obtener más información sobre el formato de números de Excel, vea Códigos de formato de número.
numberFormatCategories	Representa la categoría de formato numérico de cada celda.
numberFormatLocal	Representa el código de formato de número de Excel para el intervalo especificado, en función de la configuración de idioma del usuario. Excel no realiza ninguna coerción de idioma o formato al obtener o establecer la `numberFormatLocal` propiedad. Cualquier texto devuelto usa las cadenas con formato local en función del 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 intervalo actual están ocultas. El valor es `true` cuando todas las filas de un intervalo están ocultas. El valor es `false` cuando no se oculta ninguna fila del intervalo. El valor es `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.
savedAsArray	Representa si todas las celdas se guardarían como una fórmula de matriz. Devuelve `true` si todas las celdas se guardarían como una fórmula de matriz o `false` si todas las celdas no se guardarían como una fórmula de matriz. Devuelve `null` si algunas celdas se guardarían como una fórmula de matriz y otras no lo serían.
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án. En el caso de los estilos personalizados, se devolverá el nombre del estilo. Para los estilos integrados, se devolverá una cadena que representa un valor en la `BuiltInStyle` enumeración.
text	Valores de texto del intervalo especificado. El valor Text no dependerá del ancho de la celda. La sustitución del signo 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 podrían 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 un signo igual ("="), Excel interpreta este valor como una fórmula.
valuesAsJson	Representación JSON de los valores de las celdas de este rango. A diferencia de `Range.values`, `Range.valuesAsJson` admite todos los tipos de datos que pueden estar en una celda. Entre los ejemplos se incluyen valores de número con formato e imágenes web, además de los valores booleanos, numéricos y de cadena estándar. Los datos devueltos desde esta API siempre se alinean con la configuración regional en-US. Para recuperar datos en la configuración regional de visualización del usuario, use `Range.valuesAsJsonLocal`.
valuesAsJsonLocal	Representación JSON de los valores de las celdas de este rango. A diferencia de `Range.values`, `Range.valuesAsJsonLocal` admite todos los tipos de datos que pueden estar en una celda. Entre los ejemplos se incluyen valores de número con formato e imágenes web, además de los valores booleanos, numéricos y de cadena estándar. Los datos devueltos desde esta API siempre se alinean con la configuración regional de visualización del usuario. Para recuperar datos independientes de la configuración regional, use `Range.valuesAsJson`.
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 intervalo hasta el borde derecho del intervalo.
worksheet	Hoja de cálculo que contiene el rango actual.

Métodos

autoFill(destinationRange, autoFillType)	Rellena un intervalo desde el intervalo actual hasta el intervalo de destino mediante la lógica de autorrellenar especificada. El intervalo de destino puede ser `null` o puede extender el intervalo de origen horizontal o verticalmente. No se admiten intervalos de discontiguous. Para obtener más información, consulte Uso de autorrellenar y relleno flash.
autoFill(destinationRange, autoFillTypeString)	Rellena un intervalo desde el intervalo actual hasta el intervalo de destino mediante la lógica de autorrellenar especificada. El intervalo de destino puede ser `null` o puede extender el intervalo de origen horizontal o verticalmente. No se admiten intervalos de discontiguous. Para obtener más información, consulte Uso de autorrellenar y relleno flash.
calculate()	Calcula un rango de celdas en una hoja de cálculo.
clear(applyTo)	Borre los valores de intervalo y el formato, como el relleno y el borde.
clear(applyToString)	Borre los valores de intervalo y el formato, como el relleno y el borde.
clearOrResetContents()	Borra los valores de las celdas del rango, teniendo especial en cuenta las celdas que contienen controles. Si el intervalo contiene solo valores en blanco y controles establecidos en su valor predeterminado, se quitan los valores y el formato de control. De lo contrario, establece las celdas con controles en su valor predeterminado y borra los valores de las otras celdas del rango.
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 de celda o el formato del intervalo de origen o `RangeAreas` al intervalo actual. El intervalo de destino puede tener un tamaño diferente al intervalo de origen o `RangeAreas`. El destino se expande automáticamente si es menor que el origen. Nota: Al igual que la funcionalidad de copia en la interfaz de usuario de Excel, si el intervalo de destino es un múltiplo exacto mayor que el intervalo de origen en filas o columnas, el contenido de origen se replica varias veces. Por ejemplo, una copia de intervalo 2x2 en un intervalo de 2x6 dará como resultado 3 copias del intervalo 2x2 original.
copyFrom(sourceRange, copyTypeString, skipBlanks, transpose)	Copia los datos de celda o el formato del intervalo de origen o `RangeAreas` al intervalo actual. El intervalo de destino puede tener un tamaño diferente al intervalo de origen o `RangeAreas`. El destino se expande automáticamente si es menor que el origen. Nota: Al igual que la funcionalidad de copia en la interfaz de usuario de Excel, si el intervalo de destino es un múltiplo exacto mayor que el intervalo de origen en filas o columnas, el contenido de origen se replica varias veces. Por ejemplo, una copia de intervalo 2x2 en un intervalo de 2x6 dará como resultado 3 copias del intervalo 2x2 original.
delete(shift)	Elimina las celdas asociadas al rango.
delete(shiftString)	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 sola 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 sola 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 OrNullObject methods and properties( Métodos y propiedades de OrNullObject).
flashFill()	Realiza un relleno flash en el intervalo actual. El relleno flash rellena automáticamente los datos cuando detecta un patrón, por lo que el intervalo debe ser un único rango de columnas y tener datos alrededor de él 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 los números especificados de filas y columnas.
getBoundingRect(anotherRange)	Obtiene el objeto de intervalo más pequeño que abarca los intervalos especificados. Por ejemplo, el `GetBoundingRect` 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 y cuando permanezca 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 determinado número de columnas a la derecha del objeto actual `Range` .
getColumnsBefore(count)	Obtiene un determinado número de columnas a la izquierda del objeto actual `Range` .
getDependents()	Devuelve un `WorkbookRangeAreas` objeto que representa el rango que contiene todas las celdas dependientes de un rango especificado en la misma hoja de cálculo o en varias hojas de cálculo. Nota: Esta API devuelve un `ItemNotFound` error si no se encuentra ningún dependiente.
getDirectDependents()	Devuelve un `WorkbookRangeAreas` objeto que representa el rango que contiene todas las celdas dependientes directas de un rango especificado en la misma hoja de cálculo o en varias hojas de cálculo. Nota: Esta API devuelve un `ItemNotFound` error si no se encuentra ningún dependiente.
getDirectPrecedents()	Devuelve un `WorkbookRangeAreas` objeto que representa el rango que contiene todas las celdas precedentes directas de un rango especificado en la misma hoja de cálculo o en varias hojas de cálculo. Nota: Esta API devuelve un `ItemNotFound` error si no se encuentra ningún precedente.
getEntireColumn()	Obtiene un objeto que representa toda la columna del rango (por ejemplo, si el rango actual representa las celdas "B4:E11", es `getEntireColumn` 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", es `GetEntireRow` un rango que representa las filas "4:11").
getExtendedRange(direction, activeCell)	Devuelve un objeto de rango que incluye el intervalo actual y hasta el borde del intervalo, en función de la dirección proporcionada. Esto coincide con el comportamiento de la tecla Ctrl+Mayús+Flecha en la interfaz de usuario de Excel en Windows.
getExtendedRange(directionString, activeCell)	Devuelve un objeto de rango que incluye el intervalo actual y hasta el borde del intervalo, en función de la dirección proporcionada. Esto coincide con el comportamiento de la tecla Ctrl+Mayús+Flecha en la interfaz de usuario de Excel en Windows.
getImage()	Representa el intervalo como una imagen png codificada en Base64. Importante*: esta API no se admite actualmente en Excel para Mac. Visite OfficeDev/office-js Issue #235 para ver el estado actual.
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 OrNullObject methods and properties( Métodos y propiedades de 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".
getMergedAreasOrNullObject()	Devuelve un `RangeAreas` objeto que representa las áreas combinadas de este intervalo. Tenga en cuenta que si el recuento de áreas combinadas en este intervalo es superior a 512, este método no devolverá el resultado. Si el `RangeAreas` objeto no existe, esta función devolverá un objeto con su `isNullObject` propiedad establecida en `true`. Para obtener más información, vea OrNullObject methods and properties( Métodos y propiedades de OrNullObject).
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.
getPivotTables(fullyContained)	Obtiene una colección con ámbito de tablas dinámicas que se superponen con el intervalo.
getPrecedents()	Devuelve un `WorkbookRangeAreas` objeto que representa el rango que contiene todas las celdas anteriores de un rango especificado en la misma hoja de cálculo o en varias hojas de cálculo. Nota: Esta API devuelve un `ItemNotFound` error si no se encuentra ningún precedente.
getRangeEdge(direction, activeCell)	Devuelve un objeto de rango que es la celda perimetral de la región de datos que corresponde a la dirección proporcionada. Esto coincide con el comportamiento de la tecla Ctrl+Flecha en la interfaz de usuario de Excel en Windows.
getRangeEdge(directionString, activeCell)	Devuelve un objeto de rango que es la celda perimetral de la región de datos que corresponde a la dirección proporcionada. Esto coincide con el comportamiento de la tecla Ctrl+Flecha en la interfaz de usuario de Excel en Windows.
getResizedRange(deltaRows, deltaColumns)	Obtiene un `Range` objeto similar al objeto actual `Range` , pero con su esquina inferior derecha expandida (o contratada) por algún 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 cada celda dentro 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 número determinado de filas por debajo del objeto actual `Range` .
getSpecialCells(cellType, cellValueType)	Obtiene el `RangeAreas` objeto, que consta de uno o varios 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(cellTypeString, cellValueTypeString)	Obtiene el `RangeAreas` objeto, que consta de uno o varios 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 consta de uno o varios rangos, que representa todas las celdas que coinciden con el tipo y valor especificados. Si no se encuentra ninguna celda especial, este método devuelve un objeto con su `isNullObject` propiedad establecida en `true`. Para obtener más información, vea OrNullObject methods and properties( Métodos y propiedades de OrNullObject).
getSpecialCellsOrNullObject(cellTypeString, cellValueTypeString)	Obtiene el `RangeAreas` objeto, que consta de uno o varios rangos, que representa todas las celdas que coinciden con el tipo y valor especificados. Si no se encuentra ninguna celda especial, este método devuelve un objeto con su `isNullObject` propiedad establecida en `true`. Para obtener más información, vea OrNullObject methods and properties( Métodos y propiedades de OrNullObject).
getSpillingToRange()	Obtiene el objeto de intervalo que contiene el intervalo de desbordamiento al llamar en una celda de delimitador. Se produce un error si se aplica a un intervalo con más de una celda.
getSpillingToRangeOrNullObject()	Obtiene el objeto de intervalo que contiene el intervalo de desbordamiento al llamar en una celda de delimitador. Si el rango no es una celda delimitadora o no se puede encontrar el intervalo de desbordamiento, este método devuelve un objeto con su `isNullObject` propiedad establecida en `true`. Para obtener más información, vea OrNullObject methods and properties( Métodos y propiedades de OrNullObject).
getSpillParent()	Obtiene el intervalo que contiene la celda de delimitador de una celda en la que se derrama. Se produce un error si se aplica a un intervalo con más de una celda.
getSpillParentOrNullObject()	Obtiene el objeto de rango que contiene la celda delimitadora en la que se derrama la celda. Si no es una celda derramada o se proporciona más de una celda, este método devuelve un objeto con su `isNullObject` propiedad establecida en `true`. Para obtener más información, vea OrNullObject methods and properties( Métodos y propiedades de 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 dentro del rango, esta función producirá un `ItemNotFound` error.
getUsedRangeOrNullObject(valuesOnly)	Devuelve el intervalo usado del objeto de rango especificado. Si no hay celdas usadas dentro del rango, este método devuelve un objeto con su `isNullObject` propiedad establecida en `true`. Para obtener más información, vea OrNullObject methods and properties( Métodos y propiedades de OrNullObject).
getVisibleView()	Representa las filas visibles del intervalo actual.
group(groupOption)	Grupos columnas y filas para un esquema.
group(groupOptionString)	Grupos columnas y filas para un esquema.
hideGroupDetails(groupOption)	Oculta los detalles del grupo de filas o columnas.
hideGroupDetails(groupOptionString)	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 ahora en blanco.
insert(shiftString)	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 ahora 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.
moveTo(destinationRange)	Mueve los valores de celda, el formato y las fórmulas del rango actual al intervalo de destino, reemplazando la información antigua de esas celdas. El intervalo de destino se expandirá automáticamente si es menor que el intervalo actual. No se cambian las celdas del rango de destino que están fuera del área del rango original.
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 de API del mismo tipo.
set(properties)	Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
setCellProperties(cellPropertiesData)	Novedades el 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 intervalo en función de una matriz unidimensional de propiedades de columna, encapsulando elementos como fuente, relleno, bordes y alineación.
setDirty()	Establece un intervalo que se deberá actualizar cuando se realice la próxima actualización.
setRowProperties(rowPropertiesData)	Novedades el intervalo 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(groupOptionString)	Muestra los detalles del grupo de filas o columnas.
toJSON()	Invalida el método JavaScript `toJSON()` para proporcionar una salida más útil cuando se pasa un objeto de 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 de API, el `toJSON` método devuelve un objeto JavaScript sin formato (escrito como `Excel.Interfaces.RangeData`) que contiene copias superficiales de las propiedades secundarias cargadas 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 para context.trackedObjects.add(thisObject). Si usa este objeto entre `.sync` llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene 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 de seguimiento cuando se creó el objeto por primera vez.
ungroup(groupOption)	Desagrupa columnas y filas para un esquema.
ungroup(groupOptionString)	Desagrupa columnas y filas para 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 abreviada para 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. Tendrá que llamar `context.sync()` a antes de que la versión de memoria surta efecto.

Detalles de las propiedades

address

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

readonly address: string;

Valor de propiedad

string

Comentarios

addressLocal

Representa la referencia de intervalo para el intervalo 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 intervalo.

readonly columnCount: number;

Valor de propiedad

number

Comentarios

columnHidden

Representa si todas las columnas del intervalo actual están ocultas. El valor es true cuando todas las columnas de un intervalo están ocultas. El valor es false cuando no se oculta ninguna columna del 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 intervalo. Indizado con cero.

readonly columnIndex: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

conditionalFormats

La colección de ConditionalFormats que interseca el intervalo.

readonly conditionalFormats: Excel.ConditionalFormatCollection;

Valor de propiedad

Excel.ConditionalFormatCollection

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Excel.RequestContext

control

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene acceso al control de celda aplicado a este rango. Si el rango tiene varios controles de celda, devuelve EmptyCellControl.

control: CellControl;

Valor de propiedad

Excel.CellControl

Comentarios

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 ]

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

formulas

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

formulas: any[][];

Valor de propiedad

any[][]

Comentarios

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 ninguna fórmula, su valor se devuelve 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 ninguna fórmula, su valor se devuelve en su lugar.

formulasR1C1: any[][];

Valor de propiedad

any[][]

Comentarios

hasSpill

Indica si todas las celdas tienen un borde de desbordamiento. Devuelve true si todas las celdas tienen un borde de derrame o false si todas las celdas no tienen un borde de desbordamiento. Devuelve null si hay celdas con y sin bordes de desbordamiento dentro del intervalo.

readonly hasSpill: boolean;

Valor de propiedad

boolean

Comentarios

height

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

readonly height: number;

Valor de propiedad

number

Comentarios

hidden

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

readonly hidden: boolean;

Valor de propiedad

boolean

Comentarios

hyperlink

Representa el hipervínculo del intervalo 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 el intervalo especificado. Para obtener más información sobre el formato de números 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);
});

numberFormatCategories

Representa la categoría de formato numérico de cada celda.

readonly numberFormatCategories: Excel.NumberFormatCategory[][];

Valor de propiedad

Excel.NumberFormatCategory[][]

Comentarios

numberFormatLocal

Representa el código de formato de número de Excel para el intervalo especificado, en función de la configuración de idioma del usuario. Excel no realiza ninguna coerción de idioma o formato al obtener o establecer la numberFormatLocal propiedad. Cualquier texto devuelto usa las cadenas con formato local en función del 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 intervalo actual están ocultas. El valor es true cuando todas las filas de un intervalo están ocultas. El valor es false cuando no se oculta ninguna fila del intervalo. El valor es 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

savedAsArray

Representa si todas las celdas se guardarían como una fórmula de matriz. Devuelve true si todas las celdas se guardarían como una fórmula de matriz o false si todas las celdas no se guardarían como una fórmula de matriz. Devuelve null si algunas celdas se guardarían como una fórmula de matriz y otras no lo serían.

readonly savedAsArray: boolean;

Valor de propiedad

boolean

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án. En el caso de los estilos personalizados, se devolverá el nombre del estilo. Para los estilos integrados, se devolverá una cadena que representa un valor en 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 del signo 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 podrían 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 un signo igual ("="), Excel interpreta este valor como una fórmula.

values: any[][];

Valor de propiedad

any[][]

Comentarios

valuesAsJson

Representación JSON de los valores de las celdas de este rango. A diferencia de Range.values, Range.valuesAsJson admite todos los tipos de datos que pueden estar en una celda. Entre los ejemplos se incluyen valores de número con formato e imágenes web, además de los valores booleanos, numéricos y de cadena estándar. Los datos devueltos desde esta API siempre se alinean con la configuración regional en-US. Para recuperar datos en la configuración regional de visualización del usuario, use Range.valuesAsJsonLocal.

valuesAsJson: CellValue[][];

Valor de propiedad

Excel.CellValue[][]

Comentarios

[ Conjunto de API: ExcelApi 1.16 ]

Ejemplos

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

// This function creates a formatted number data type,
// and sets the format of this data type as a date.
await Excel.run(async (context) => {
  // Get the Sample worksheet and a range on that sheet.
  const sheet = context.workbook.worksheets.getItemOrNullObject("Sample");
  const dateRange = sheet.getRange("A1");

  // Write a number formatted as a date to cell A1.
  dateRange.valuesAsJson = [
    [
      {
        type: Excel.CellValueType.formattedNumber,
        basicValue: 32889.0,
        numberFormat: "m/d/yyyy"
      }
    ]
  ];
  await context.sync();
});

valuesAsJsonLocal

Representación JSON de los valores de las celdas de este rango. A diferencia de Range.values, Range.valuesAsJsonLocal admite todos los tipos de datos que pueden estar en una celda. Entre los ejemplos se incluyen valores de número con formato e imágenes web, además de los valores booleanos, numéricos y de cadena estándar. Los datos devueltos desde esta API siempre se alinean con la configuración regional de visualización del usuario. Para recuperar datos independientes de la configuración regional, use Range.valuesAsJson.

valuesAsJsonLocal: CellValue[][];

Valor de propiedad

Excel.CellValue[][]

Comentarios

[ Conjunto de API: ExcelApi 1.16 ]

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 intervalo hasta el borde derecho del intervalo.

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 ]

Detalles del método

autoFill(destinationRange, autoFillType)

Rellena un intervalo desde el intervalo actual hasta el intervalo de destino mediante la lógica de autorrellenar especificada. El intervalo de destino puede ser null o puede extender el intervalo de origen horizontal o verticalmente. No se admiten intervalos de discontiguous.

Para obtener más información, consulte Uso de autorrellenar y relleno flash.

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

Parámetros

destinationRange: Excel.Range | string

Intervalo de destino que se va a Autorrellenar. Si el intervalo 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 identificador de relleno de rango de la interfaz de usuario).

autoFillType: Excel.AutoFillType

Tipo de Autorrellenar. Especifica cómo se va a 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, autoFillTypeString)

Para obtener más información, consulte Uso de autorrellenar y relleno flash.

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

Parámetros

destinationRange: Excel.Range | string

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

Tipo de Autorrellenar. Especifica cómo se va a 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)

Borre los valores de intervalo y el formato, como el relleno y el 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(); 
});

clear(applyToString)

Borre los valores de intervalo y el formato, como el relleno y el borde.

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

Parámetros

applyToString: "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

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

clearOrResetContents()

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Borra los valores de las celdas del rango, teniendo especial en cuenta las celdas que contienen controles. Si el intervalo contiene solo valores en blanco y controles establecidos en su valor predeterminado, se quitan los valores y el formato de control. De lo contrario, establece las celdas con controles en su valor predeterminado y borra los valores de las otras celdas del rango.

clearOrResetContents(): void;

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

Identificador de servicio que se usará para consultar los datos.

languageCulture: string

Referencia cultural del lenguaje para consultar el servicio.

Devoluciones

void

Comentarios

copyFrom(sourceRange, copyType, skipBlanks, transpose)

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

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

Parámetros

sourceRange: Excel.Range | Excel.RangeAreas | string

Intervalo de origen o RangeAreas desde el que se va a copiar. Cuando el origen RangeAreas tiene varios intervalos, su formulario debe poder crearse quitando filas o columnas completas de un intervalo rectangular.

copyType: Excel.RangeCopyType

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

skipBlanks: boolean

True si se omiten las celdas en blanco en el intervalo de origen. El valor predeterminado es false.

transpose: boolean

True si se van a transponer las celdas en el intervalo 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, copyTypeString, skipBlanks, transpose)

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

Parámetros

sourceRange: Excel.Range | Excel.RangeAreas | string

copyTypeString: "All" | "Formulas" | "Values" | "Formats" | "Link" | "ColumnWidths"

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

skipBlanks: boolean

True si se omiten las celdas en blanco en el intervalo de origen. El valor predeterminado es false.

transpose: boolean

True si se van a transponer las celdas en el intervalo 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(); 
});

delete(shiftString)

Elimina las celdas asociadas al rango.

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

Parámetros

shiftString: "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)

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

Parámetros

text: string

Cadena que se va a buscar.

criteria: Excel.SearchCriteria

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

Devoluciones

Excel.Range

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

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 foundRange = searchRange.find($("#searchText").val().toString(), {
        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 sola 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 *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

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

Parámetros

text: string

Cadena que se va a buscar.

criteria: Excel.SearchCriteria

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

Devoluciones

Excel.Range

que Range coincidía 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 foundRange = searchRange.findOrNullObject($("#searchText").val().toString(), {
        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()

Realiza un relleno flash en el intervalo actual. El relleno flash rellena automáticamente los datos cuando detecta un patrón, por lo que el intervalo debe ser un único rango de columnas y tener datos alrededor de él 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 los números especificados de filas y columnas.

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

Parámetros

numRows: number

Número de filas del nuevo tamaño de intervalo.

numColumns: number

Número de columnas del nuevo tamaño de intervalo.

Devoluciones

Excel.Range

Comentarios

getBoundingRect(anotherRange)

Obtiene el objeto de intervalo más pequeño que abarca los intervalos especificados. Por ejemplo, el GetBoundingRect 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 y cuando permanezca 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

Objeto que representa las propiedades de celda que se van a cargar.

Devoluciones

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

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();

    // Define the cell properties to get by setting the matching LoadOptions to true.
    const propertiesToGet = cell.getCellProperties({
        address: true,
        format: {
            fill: {
                color: true
            },
            font: {
                color: true
            }
        },
        style: true
    });

    // Sync to get the data from the workbook.
    await context.sync();
    const cellProperties = propertiesToGet.value[0][0];
    console.log(
        `Address: ${cellProperties.address}\nStyle: ${cellProperties.style}\nFill Color: ${cellProperties.format.fill.color}\nFont Color: ${cellProperties.format.font.color}`);
});

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

Objeto que representa las propiedades de columna que se van a cargar.

Devoluciones

Matriz en la que cada elemento representa las propiedades solicitadas de la columna correspondiente.

Comentarios

getColumnsAfter(count)

Obtiene un determinado 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 determinado número de columnas a la izquierda del objeto actual Range .

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

Parámetros

count: number

Devoluciones

Excel.Range

Comentarios

getDependents()

Devuelve un WorkbookRangeAreas objeto que representa el rango que contiene todas las celdas dependientes de un rango especificado en la misma hoja de cálculo o en varias hojas de cálculo. Nota: Esta API devuelve un ItemNotFound error si no se encuentra ningún dependiente.

getDependents(): Excel.WorkbookRangeAreas;

Devoluciones

Excel.WorkbookRangeAreas

Comentarios

[ Conjunto de API: ExcelApi 1.15 ]

Ejemplos

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

// This function highlights all the dependent cells of the active cell.
// Dependent cells contain formulas that refer to other cells.
await Excel.run(async (context) => {
  // Get addresses of the active cell's dependent cells.
  const range = context.workbook.getActiveCell();
  const dependents = range.getDependents();
  range.load("address");
  dependents.areas.load("address");
  await context.sync();

  console.log(`All dependent cells of ${range.address}:`);

  // Use the dependents API to loop through dependents of the active cell.
  for (let i = 0; i < dependents.areas.items.length; i++) {
    // Highlight and print out the address of each dependent cell.
    dependents.areas.items[i].format.fill.color = "Orange";
    console.log(`  ${dependents.areas.items[i].address}`);
  }
  await context.sync();
});

getDirectDependents()

Devuelve un WorkbookRangeAreas objeto que representa el rango que contiene todas las celdas dependientes directas de un rango especificado en la misma hoja de cálculo o en varias hojas de cálculo. Nota: Esta API devuelve un ItemNotFound error si no se encuentra ningún dependiente.

getDirectDependents(): Excel.WorkbookRangeAreas;

Devoluciones

Excel.WorkbookRangeAreas

Comentarios

Ejemplos

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

await Excel.run(async (context) => {
  // Direct dependents are cells that contain formulas that refer to other cells.
  let range = context.workbook.getActiveCell();
  let directDependents = range.getDirectDependents();
  range.load("address");
  directDependents.areas.load("address");
  await context.sync();
  
  console.log(`Direct dependent cells of ${range.address}:`);
  
  // Use the direct dependents API to loop through direct dependents of the active cell.
  for (let i = 0; i < directDependents.areas.items.length; i++) {
    // Highlight and print the address of each dependent cell.
    directDependents.areas.items[i].format.fill.color = "Yellow";
    console.log(`  ${directDependents.areas.items[i].address}`);
  }
  await context.sync();
});

getDirectPrecedents()

Devuelve un WorkbookRangeAreas objeto que representa el rango que contiene todas las celdas precedentes directas de un rango especificado en la misma hoja de cálculo o en varias hojas de cálculo. Nota: Esta API devuelve un ItemNotFound error si no se encuentra ningún precedente.

getDirectPrecedents(): Excel.WorkbookRangeAreas;

Devoluciones

Excel.WorkbookRangeAreas

Comentarios

Ejemplos

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

await Excel.run(async (context) => {
  // Precedents are cells referenced by the formula in a cell.
  // A "direct precedent" is a cell directly referenced by the selected formula.
  let range = context.workbook.getActiveCell();
  let directPrecedents = range.getDirectPrecedents();
  range.load("address");
  directPrecedents.areas.load("address");
  await context.sync();

  console.log(`Direct precedent cells of ${range.address}:`);

  // Use the direct precedents API to loop through precedents of the active cell.
  for (let i = 0; i < directPrecedents.areas.items.length; i++) {
    // Highlight and console the address of each precedent cell.
    directPrecedents.areas.items[i].format.fill.color = "Yellow";
    console.log(`  ${directPrecedents.areas.items[i].address}`);
  }
  await context.sync();
});

getEntireColumn()

Obtiene un objeto que representa toda la columna del rango (por ejemplo, si el rango actual representa las celdas "B4:E11", es getEntireColumn 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", es GetEntireRow 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);
});

getExtendedRange(direction, activeCell)

Devuelve un objeto de rango que incluye el intervalo actual y hasta el borde del intervalo, en función de la dirección proporcionada. Esto coincide con el comportamiento de la tecla Ctrl+Mayús+Flecha en la interfaz de usuario de Excel en Windows.

getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range;

Parámetros

direction: Excel.KeyboardDirection

Dirección de la celda activa.

activeCell: Excel.Range | string

Celda activa de este rango. De forma predeterminada, la celda activa es la celda superior izquierda del rango. Se produce un error si la celda activa no está en este intervalo.

Devoluciones

Excel.Range

Comentarios

Ejemplos

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

await Excel.run(async (context) => {
  // Get the selected range.
  const range = context.workbook.getSelectedRange();

  // Specify the direction with the `KeyboardDirection` enum.
  const direction = Excel.KeyboardDirection.down;

  // Get the active cell in the workbook.
  const activeCell = context.workbook.getActiveCell();

  // Get all the cells from the currently selected range to the bottom-most edge of the used range.
  // This method acts like the Ctrl+Shift+Arrow key keyboard shortcut while a range is selected.
  const extendedRange = range.getExtendedRange(
    direction,
    activeCell // If the selected range contains more than one cell, the active cell must be defined.
  );
  extendedRange.select();

  await context.sync();
});

getExtendedRange(directionString, activeCell)

getExtendedRange(directionString: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range;

Parámetros

directionString: "Left" | "Right" | "Up" | "Down"

Dirección de la celda activa.

activeCell: Excel.Range | string

Celda activa de este rango. De forma predeterminada, la celda activa es la celda superior izquierda del rango. Se produce un error si la celda activa no está en este intervalo.

Devoluciones

Excel.Range

Comentarios

getImage()

Representa el intervalo como una imagen png codificada en Base64. Importante*: esta API no se admite actualmente en Excel para Mac. Visite OfficeDev/office-js Issue #235 para ver el estado actual.

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

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 *OrNullObject methods and properties( Métodos y propiedades de *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

[ 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();
});

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
});

getMergedAreasOrNullObject()

Devuelve un RangeAreas objeto que representa las áreas combinadas de este intervalo. Tenga en cuenta que si el recuento de áreas combinadas en este intervalo es superior a 512, este método no devolverá el resultado. Si el RangeAreas objeto no existe, esta función devolverá un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getMergedAreasOrNullObject(): Excel.RangeAreas;

Devoluciones

Excel.RangeAreas

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");

  // Retrieve the merged range within the table and load its details.
  const mergedAreas = tableRange.getMergedAreasOrNullObject();
  mergedAreas.load("address");
  mergedAreas.load("cellCount");

  // Select the merged range.
  const range = mergedAreas.areas.getItemAt(0);
  range.select();
  await context.sync();

  // Print out the details of the `mergedAreas` range object.
  console.log(`Address of the merged range: ${mergedAreas.address}`);
  console.log(`Number of cells in the merged range: ${mergedAreas.cellCount}`);

  await context.sync();
});

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
});

getPivotTables(fullyContained)

Obtiene una colección con ámbito de tablas dinámicas que se superponen con el intervalo.

getPivotTables(fullyContained?: boolean): Excel.PivotTableScopedCollection;

Parámetros

fullyContained: boolean

Si truees , devuelve solo tablas dinámicas que están totalmente contenidas dentro de los límites del intervalo. El valor predeterminado es false.

Devoluciones

Excel.PivotTableScopedCollection

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-get-pivottables.yaml

await Excel.run(async (context) => {
  const activeRange = context.workbook.getSelectedRange();

  // Get all the PivotTables that intersect with this range.
  const partiallyContainedPivotTables = activeRange.getPivotTables();
  // Get all the PivotTables that are completely contained within this range.
  const fullyContainedPivotTables = activeRange.getPivotTables(true);

  partiallyContainedPivotTables.load("name");
  fullyContainedPivotTables.load("name");
  await context.sync();

  // Display the names in the console.
  console.log("PivotTables in the current range:")
  partiallyContainedPivotTables.items.forEach((pivotTable) => {
    console.log(`\t${pivotTable.name}`);
  });
  console.log("PivotTables completely contained in the current range:")
  fullyContainedPivotTables.items.forEach((pivotTable) => {
    console.log(`\t${pivotTable.name}`);
  });
});

getPrecedents()

Devuelve un WorkbookRangeAreas objeto que representa el rango que contiene todas las celdas anteriores de un rango especificado en la misma hoja de cálculo o en varias hojas de cálculo. Nota: Esta API devuelve un ItemNotFound error si no se encuentra ningún precedente.

getPrecedents(): Excel.WorkbookRangeAreas;

Devoluciones

Excel.WorkbookRangeAreas

Comentarios

[ Conjunto de API: ExcelApi 1.14 ]

Ejemplos

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

await Excel.run(async (context) => {
  // Precedents are cells referenced by the formula in a cell.
  let range = context.workbook.getActiveCell();
  let precedents = range.getPrecedents();
  range.load("address");
  precedents.areas.load("address");
  await context.sync();

  console.log(`All precedent cells of ${range.address}:`);

  // Use the precedents API to loop through precedents of the active cell.
  for (let i = 0; i < precedents.areas.items.length; i++) {
    // Highlight and console the address of each precedent cell.
    precedents.areas.items[i].format.fill.color = "Orange";
    console.log(`  ${precedents.areas.items[i].address}`);
  }
  await context.sync();
});

getRangeEdge(direction, activeCell)

Devuelve un objeto de rango que es la celda perimetral de la región de datos que corresponde a la dirección proporcionada. Esto coincide con el comportamiento de la tecla Ctrl+Flecha en la interfaz de usuario de Excel en Windows.

getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range;

Parámetros

direction: Excel.KeyboardDirection

Dirección de la celda activa.

activeCell: Excel.Range | string

Celda activa de este rango. De forma predeterminada, la celda activa es la celda superior izquierda del rango. Se produce un error si la celda activa no está en este intervalo.

Devoluciones

Excel.Range

Comentarios

Ejemplos

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

await Excel.run(async (context) => {
  // Get the selected range.
  const range = context.workbook.getSelectedRange();

  // Specify the direction with the `KeyboardDirection` enum.
  const direction = Excel.KeyboardDirection.up;

  // Get the active cell in the workbook.
  const activeCell = context.workbook.getActiveCell();

  // Get the top-most cell of the current used range.
  // This method acts like the Ctrl+Arrow key keyboard shortcut while a range is selected.
  const rangeEdge = range.getRangeEdge(
    direction,
    activeCell // If the selected range contains more than one cell, the active cell must be defined.
  );
  rangeEdge.select();

  await context.sync();
});

getRangeEdge(directionString, activeCell)

getRangeEdge(directionString: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range;

Parámetros

directionString: "Left" | "Right" | "Up" | "Down"

Dirección de la celda activa.

activeCell: Excel.Range | string

Celda activa de este rango. De forma predeterminada, la celda activa es la celda superior izquierda del rango. Se produce un error si la celda activa no está en este intervalo.

Devoluciones

Excel.Range

Comentarios

getResizedRange(deltaRows, deltaColumns)

Obtiene un Range objeto similar al objeto actual Range , pero con su esquina inferior derecha expandida (o contratada) por algún 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 intervalo 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 cada celda dentro de una fila determinada, null se devolverá.

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

Parámetros

rowPropertiesLoadOptions: Excel.RowPropertiesLoadOptions

Objeto que representa las propiedades de fila que se van a cargar.

Devoluciones

Matriz en la que 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 número determinado de filas por debajo del objeto actual Range .

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

Parámetros

count: number

Devoluciones

Excel.Range

Comentarios

getSpecialCells(cellType, cellValueType)

Obtiene el RangeAreas objeto, que consta de uno o varios 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

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 se van a 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(cellTypeString, cellValueTypeString)

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

Parámetros

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

Tipo de celdas que se van a incluir.

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

Devoluciones

Excel.RangeAreas

Comentarios

getSpecialCellsOrNullObject(cellType, cellValueType)

Obtiene el RangeAreas objeto, que consta de uno o varios rangos, que representa todas las celdas que coinciden con el tipo y valor especificados. Si no se encuentra ninguna celda especial, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

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

Parámetros

cellType: Excel.SpecialCellType

Tipo de celdas que se van a incluir.

cellValueType: Excel.SpecialCellValueType

Devoluciones

Excel.RangeAreas

Comentarios

getSpecialCellsOrNullObject(cellTypeString, cellValueTypeString)

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

Parámetros

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

Tipo de celdas que se van a incluir.

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

Devoluciones

Excel.RangeAreas

Comentarios

getSpillingToRange()

Obtiene el objeto de intervalo que contiene el intervalo de desbordamiento al llamar en una celda de delimitador. Se produce un error si se aplica a un intervalo con más de una celda.

getSpillingToRange(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

Ejemplos

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

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

  // Set G4 to a formula that returns a dynamic array.
  const targetCell = sheet.getRange("G4");
  targetCell.formulas = [["=A4:D4"]];

  // Get the address of the cells that the dynamic array spilled into.
  const spillRange = targetCell.getSpillingToRange();
  spillRange.load("address");

  // Fit the columns for readability.
  sheet.getUsedRange().format.autofitColumns();
  await context.sync();

  console.log(`Copying the table headers spilled into ${spillRange.address}.`);
});

getSpillingToRangeOrNullObject()

Obtiene el objeto de intervalo que contiene el intervalo de desbordamiento al llamar en una celda de delimitador. Si el rango no es una celda delimitadora o no se puede encontrar el intervalo de desbordamiento, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getSpillingToRangeOrNullObject(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

getSpillParent()

Obtiene el intervalo que contiene la celda de delimitador de una celda en la que se derrama. Se produce un error si se aplica a un intervalo con más de una celda.

getSpillParent(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

getSpillParentOrNullObject()

Obtiene el objeto de rango que contiene la celda delimitadora en la que se derrama la celda. Si no es una celda derramada o se proporciona más de una celda, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getSpillParentOrNullObject(): Excel.Range;

Devoluciones

Excel.Range

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 truees , devuelve solo las tablas que están totalmente contenidas dentro de los límites del intervalo. 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 dentro del rango, esta función producirá 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

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 dentro del rango, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *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

[ Conjunto de API: ExcelApi 1.4 ]

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 ]

group(groupOption)

Grupos columnas y filas para un esquema.

group(groupOption: Excel.GroupOption): void;

Parámetros

groupOption: Excel.GroupOption

Especifica cómo se puede agrupar el intervalo por filas o columnas. Se produce un InvalidArgument error cuando la opción de grupo difiere de la propiedad o isEntireColumn del isEntireRow intervalo (es decir, range.isEntireRow es true y groupOption es "ByColumns" o range.isEntireColumn es true 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(groupOptionString)

Grupos columnas y filas para un esquema.

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

Parámetros

groupOptionString: "ByRows" | "ByColumns"

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 filas agrupadas o columnas agrupadas.

Devoluciones

void

Comentarios

hideGroupDetails(groupOptionString)

Oculta los detalles del grupo de filas o columnas.

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

Parámetros

groupOptionString: "ByRows" | "ByColumns"

Especifica si se ocultan los detalles de filas agrupadas 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 ahora 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(shiftString)

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

Parámetros

shiftString: "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. Establézcalo true en celdas de combinación en cada fila del rango especificado como celdas combinadas independientes. El valor predeterminado es false.

Devoluciones

void

Comentarios

Ejemplos

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:C3";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.merge(true);
    await context.sync(); 
});

// 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();
});

moveTo(destinationRange)

Mueve los valores de celda, el formato y las fórmulas del rango actual al intervalo de destino, reemplazando la información antigua de esas celdas. El intervalo de destino se expandirá automáticamente si es menor que el intervalo actual. No se cambian las celdas del rango de destino que están fuera del área del rango original.

moveTo(destinationRange: Range | string): void;

Parámetros

destinationRange: Excel.Range | string

destinationRange Especifica el intervalo al que se moverá la información de este intervalo.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.11 ]

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 moved data.
    sheet.getRange("F12").values = [["Moved Range:"]];

    // Move the range from A1:E1 to G12:K12.
    sheet.getRange("A1:E1").moveTo("G12");
    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[]

Columnas dentro del intervalo que pueden contener duplicados. Se debe especificar al menos una columna. Indizado con cero.

includesHeader: boolean

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

Devoluciones

Excel.RemoveDuplicatesResult

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>

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 de API del mismo tipo.

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

Parámetros

properties: Excel.Interfaces.RangeUpdateData

Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al 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, en función de 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)

Novedades el 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[][]

Matriz 2D que representa las propiedades que se van a 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();

    // Creating the SettableCellProperties objects to use for the range.
    // In your add-in, these should be created once, outside the function.
    const topHeaderProps: Excel.SettableCellProperties = {
        // The style property takes a string matching the name of an Excel style.
        // Built-in style names are listed in the `BuiltInStyle` enum.
        // Note that a style will overwrite any formatting,
        // so do not use the format property with the style property.
        style: "Heading1"
    };

    const headerProps: Excel.SettableCellProperties = {
        // Any subproperties of format that are not set will not be changed when these cell properties are set.
        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
                }
            }
        }
    };

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

    // You can use empty JSON objects to avoid changing a cell's properties.
    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 intervalo en función de una matriz unidimensional de propiedades de columna, encapsulando elementos como fuente, relleno, bordes y alineación.

setColumnProperties(columnPropertiesData: SettableColumnProperties[]): void;

Parámetros

columnPropertiesData: Excel.SettableColumnProperties[]

Matriz que representa las propiedades que se van a 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 intervalo 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[]

Matriz que representa las propiedades que se van a 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 deben mostrar los detalles de las filas agrupadas o las columnas agrupadas.

Devoluciones

void

Comentarios

showGroupDetails(groupOptionString)

Muestra los detalles del grupo de filas o columnas.

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

Parámetros

groupOptionString: "ByRows" | "ByColumns"

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

Devoluciones

void

Comentarios

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.Range es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.RangeData) que contiene copias superficiales de las propiedades secundarias cargadas 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 para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene 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 de seguimiento cuando se creó el objeto por primera vez.

track(): Excel.Range;

Devoluciones

Excel.Range

ungroup(groupOption)

Desagrupa columnas y filas para un esquema.

ungroup(groupOption: Excel.GroupOption): void;

Parámetros

groupOption: Excel.GroupOption

Especifica cómo se puede desagrupar el intervalo 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(groupOptionString)

Desagrupa columnas y filas para un esquema.

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

Parámetros

groupOptionString: "ByRows" | "ByColumns"

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

Devoluciones

void

Comentarios

unmerge()

Separa las celdas del intervalo en celdas independientes.

unmerge(): void;

Devoluciones

void

Comentarios