Excel.TableRow class

Paquete:

excel

Representa una fila de una tabla.

Tenga en cuenta que, a diferencia de los intervalos o columnas, que se ajustarán si se agregan nuevas filas o columnas antes que ellos, un TableRow objeto representa la ubicación física de la fila de tabla, pero no los datos. Es decir, si los datos están ordenados o si se agregan nuevas filas, una fila de tabla seguirá apuntando al índice para el que se creó.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Propiedades

context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
index	Devuelve el número de índice de la fila dentro de la colección de filas de la tabla. Indizado con cero.
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 esta fila de tabla. A diferencia de TableRow.values, TableRow.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 TableRow.valuesAsJsonLocal.
valuesAsJsonLocal	Representación JSON de los valores de las celdas de esta fila de tabla. A diferencia de TableRow.values, TableRow.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 TableRow.valuesAsJson.

Métodos

delete()	Elimina la fila de la tabla.
getRange()	Devuelve el objeto de rango asociado a toda la fila.
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.
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.
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.TableRow es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.TableRowData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

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

index

Devuelve el número de índice de la fila dentro de la colección de filas de la tabla. Indizado con cero.

readonly index: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

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

[ Conjunto de API: ExcelApi 1.1 ]

valuesAsJson

Representación JSON de los valores de las celdas de esta fila de tabla. A diferencia de TableRow.values, TableRow.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 TableRow.valuesAsJsonLocal.

valuesAsJson: CellValue[][];

Valor de propiedad

Excel.CellValue[][]

Comentarios

[ Conjunto de API: ExcelApi 1.16 ]

valuesAsJsonLocal

Representación JSON de los valores de las celdas de esta fila de tabla. A diferencia de TableRow.values, TableRow.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 TableRow.valuesAsJson.

valuesAsJsonLocal: CellValue[][];

Valor de propiedad

Excel.CellValue[][]

Comentarios

[ Conjunto de API: ExcelApi 1.16 ]

Detalles del método

delete()

Elimina la fila de la tabla.

delete(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const row = context.workbook.tables.getItem(tableName).rows.getItemAt(2);
    row.delete();
    await context.sync(); 
});

getRange()

Devuelve el objeto de rango asociado a toda la fila.

getRange(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const row = context.workbook.tables.getItem(tableName).rows.getItemAt(0);
    const rowRange = row.getRange();
    rowRange.load('address');
    await context.sync();
    
    console.log(rowRange.address);
});

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.TableRowLoadOptions): Excel.TableRow;

Parámetros

options

Excel.Interfaces.TableRowLoadOptions

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

Devoluciones

Excel.TableRow

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.TableRow;

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.TableRow

Ejemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const row = context.workbook.tables.getItem(tableName).rows.getItemAt(0);
    row.load('index');
    await context.sync();
    
    console.log(row.index);
});

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.TableRow;

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.TableRow

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.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties

Excel.Interfaces.TableRowUpdateData

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.TableRow): void;

Parámetros

properties

Excel.TableRow

Devoluciones

void

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.TableRow es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.TableRowData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.TableRowData;

Devoluciones

Excel.Interfaces.TableRowData