Excel.Interfaces.RangeLoadOptions interface
Range representa un conjunto de una o varias celdas contiguas, como una celda, una fila, una columna o un bloque de celdas. Para obtener más información sobre cómo se usan los intervalos en toda la API, comience con Rangos en la API de JavaScript de Excel.
Comentarios
[ Conjunto de API: ExcelApi 1.1 ]
Propiedades
$all |
|
address | Especifica la referencia de rango en estilo A1. El valor de dirección contiene la referencia de hoja (por ejemplo, "Sheet1! A1:B4"). |
address |
Representa la referencia de intervalo para el intervalo especificado en el idioma del usuario. |
cell |
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). |
column |
Especifica el número total de columnas del intervalo. |
column |
Representa si todas las columnas del intervalo actual están ocultas. El valor es |
column |
Especifica el número de columna de la primera celda del intervalo. Indizado con cero. |
control | Obtiene acceso al control de celda aplicado a este rango. Si el rango tiene varios controles de celda, devuelve |
data |
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. |
formulas |
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. |
has |
Indica si todas las celdas tienen un borde de desbordamiento. Devuelve |
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 |
hyperlink | Representa el hipervínculo del intervalo actual. |
is |
Representa si el intervalo actual es una columna completa. |
is |
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. |
linked |
Indica el estado del tipo de datos de cada celda. |
number |
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. |
number |
Representa la categoría de formato numérico de cada celda. |
number |
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 |
row |
Devuelve el número total de filas del intervalo. |
row |
Representa si todas las filas del intervalo actual están ocultas. El valor es |
row |
Devuelve el número de fila de la primera celda del intervalo. Indizado con cero. |
saved |
Representa si todas las celdas se guardarían como una fórmula de matriz. Devuelve |
style | Representa el estilo del rango actual. Si los estilos de las celdas son incoherentes, |
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. |
values |
Representación JSON de los valores de las celdas de este rango. A diferencia de |
values |
Representación JSON de los valores de las celdas de este rango. A diferencia de |
value |
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. |
Detalles de las propiedades
$all
$all
Al especificar para las opciones de carga, se cargan todas las propiedades escalares (comoRange.address
), pero no las propiedades de navegación (como Range.format.fill.color
).
$all?: boolean;
Valor de propiedad
boolean
address
Especifica la referencia de rango en estilo A1. El valor de dirección contiene la referencia de hoja (por ejemplo, "Sheet1! A1:B4").
address?: boolean;
Valor de propiedad
boolean
Comentarios
addressLocal
Representa la referencia de intervalo para el intervalo especificado en el idioma del usuario.
addressLocal?: boolean;
Valor de propiedad
boolean
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).
cellCount?: boolean;
Valor de propiedad
boolean
Comentarios
columnCount
Especifica el número total de columnas del intervalo.
columnCount?: boolean;
Valor de propiedad
boolean
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.
columnIndex?: boolean;
Valor de propiedad
boolean
Comentarios
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?: boolean;
Valor de propiedad
boolean
Comentarios
[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]
dataValidation
Devuelve un objeto de validación de datos.
dataValidation?: Excel.Interfaces.DataValidationLoadOptions;
Valor de propiedad
Comentarios
format
Devuelve un objeto de formato que encapsula la fuente, el relleno, los bordes, la alineación y otras propiedades del rango.
format?: Excel.Interfaces.RangeFormatLoadOptions;
Valor de propiedad
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?: boolean;
Valor de propiedad
boolean
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?: boolean;
Valor de propiedad
boolean
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?: boolean;
Valor de propiedad
boolean
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.
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.
height?: boolean;
Valor de propiedad
boolean
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.
hidden?: boolean;
Valor de propiedad
boolean
Comentarios
hyperlink
Representa el hipervínculo del intervalo actual.
hyperlink?: boolean;
Valor de propiedad
boolean
Comentarios
isEntireColumn
Representa si el intervalo actual es una columna completa.
isEntireColumn?: boolean;
Valor de propiedad
boolean
Comentarios
isEntireRow
Representa si el intervalo actual es una fila completa.
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.
left?: boolean;
Valor de propiedad
boolean
Comentarios
linkedDataTypeState
Indica el estado del tipo de datos de cada celda.
linkedDataTypeState?: boolean;
Valor de propiedad
boolean
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?: boolean;
Valor de propiedad
boolean
Comentarios
numberFormatCategories
Representa la categoría de formato numérico de cada celda.
numberFormatCategories?: boolean;
Valor de propiedad
boolean
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?: boolean;
Valor de propiedad
boolean
Comentarios
rowCount
Devuelve el número total de filas del intervalo.
rowCount?: boolean;
Valor de propiedad
boolean
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.
rowIndex?: boolean;
Valor de propiedad
boolean
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.
savedAsArray?: boolean;
Valor de propiedad
boolean
Comentarios
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?: boolean;
Valor de propiedad
boolean
Comentarios
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.
text?: boolean;
Valor de propiedad
boolean
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.
top?: boolean;
Valor de propiedad
boolean
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?: boolean;
Valor de propiedad
boolean
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?: boolean;
Valor de propiedad
boolean
Comentarios
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?: boolean;
Valor de propiedad
boolean
Comentarios
valueTypes
Especifica el tipo de datos de cada celda.
valueTypes?: boolean;
Valor de propiedad
boolean
Comentarios
width
Devuelve la distancia en puntos, para un zoom del 100 %, desde el borde izquierdo del intervalo hasta el borde derecho del intervalo.
width?: boolean;
Valor de propiedad
boolean
Comentarios
worksheet
Hoja de cálculo que contiene el rango actual.
worksheet?: Excel.Interfaces.WorksheetLoadOptions;