PowerPoint.Table class
Representa una tabla.
- Extends
Comentarios
Conjunto de API: PowerPointApi 1.8
Usada por
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
// Updates a table's values.
await PowerPoint.run(async (context) => {
const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
// Add a table (which is a type of Shape).
const shape = shapes.addTable(4, 3);
let table = shape.getTable();
table.load();
await context.sync();
// Update values in the table.
for (let rowIndex = 0; rowIndex < table.rowCount; rowIndex++) {
for (let columnIndex = 0; columnIndex < table.columnCount; columnIndex++) {
const cell = table.getCellOrNullObject(rowIndex, columnIndex);
cell.text = generateRandomString();
}
}
await context.sync();
});
Propiedades
| column |
Obtiene el número de columnas de la tabla. |
| columns | Obtiene la colección de columnas de la tabla. |
| context | El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office. |
| row |
Obtiene el número de filas de la tabla. |
| rows | Obtiene la colección de filas de la tabla. |
| style |
Obtiene la configuración de estilo de tabla. |
| values | Obtiene todos los valores de la tabla. |
Métodos
| clear(options) | Borra los valores y el formato de la tabla. |
| get |
Obtiene la celda en el valor y |
| get |
Obtiene una colección de celdas que representan las áreas combinadas de la tabla. |
| get |
Obtiene el objeto de forma de la tabla. |
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| merge |
Crea un área combinada a partir de la celda especificada por rowIndex y columnIndex. El área combinada abarca un número especificado de filas y columnas. |
| toJSON() | Reemplaza el método JavaScript |
Detalles de las propiedades
columnCount
Obtiene el número de columnas de la tabla.
readonly columnCount: number;
Valor de propiedad
number
Comentarios
columns
Obtiene la colección de columnas de la tabla.
readonly columns: PowerPoint.TableColumnCollection;
Valor de propiedad
Comentarios
context
El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.
context: RequestContext;
Valor de propiedad
rowCount
Obtiene el número de filas de la tabla.
readonly rowCount: number;
Valor de propiedad
number
Comentarios
rows
Obtiene la colección de filas de la tabla.
readonly rows: PowerPoint.TableRowCollection;
Valor de propiedad
Comentarios
styleSettings
Obtiene la configuración de estilo de tabla.
readonly styleSettings: PowerPoint.TableStyleSettings;
Valor de propiedad
Comentarios
values
Obtiene todos los valores de la tabla.
readonly values: string[][];
Valor de propiedad
string[][]
Comentarios
Detalles del método
clear(options)
Borra los valores y el formato de la tabla.
clear(options?: PowerPoint.TableClearOptions): void;
Parámetros
- options
- PowerPoint.TableClearOptions
Proporciona opciones para limpiar la tabla.
Devoluciones
void
Comentarios
getCellOrNullObject(rowIndex, columnIndex)
Obtiene la celda en el valor y rowIndex . columnIndexespecificado
getCellOrNullObject(rowIndex: number, columnIndex: number): PowerPoint.TableCell;
Parámetros
- rowIndex
-
number
Índice de fila basado en cero de la celda.
- columnIndex
-
number
Índice de columna basado en cero de la celda.
Devoluciones
La celda de la fila y columna especificadas. Si la celda forma parte de un área combinada y no es la celda superior izquierda del área combinada, se devuelve un objeto con la isNullObject propiedad establecida en true . Para obtener más información, vea los métodos y propiedades *OrNullObject.
Comentarios
Conjunto de API: PowerPointApi 1.8
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
// Updates a table's values.
await PowerPoint.run(async (context) => {
const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
// Add a table (which is a type of Shape).
const shape = shapes.addTable(4, 3);
let table = shape.getTable();
table.load();
await context.sync();
// Update values in the table.
for (let rowIndex = 0; rowIndex < table.rowCount; rowIndex++) {
for (let columnIndex = 0; columnIndex < table.columnCount; columnIndex++) {
const cell = table.getCellOrNullObject(rowIndex, columnIndex);
cell.text = generateRandomString();
}
}
await context.sync();
});
getMergedAreas()
Obtiene una colección de celdas que representan las áreas combinadas de la tabla.
getMergedAreas(): PowerPoint.TableCellCollection;
Devoluciones
a TableCellCollection con celdas que representan las áreas combinadas de la tabla.
Comentarios
getShape()
Obtiene el objeto de forma de la tabla.
getShape(): PowerPoint.Shape;
Devoluciones
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?: PowerPoint.Interfaces.TableLoadOptions): PowerPoint.Table;
Parámetros
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
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[]): PowerPoint.Table;
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
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;
}): PowerPoint.Table;
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
mergeCells(rowIndex, columnIndex, rowCount, columnCount)
Crea un área combinada a partir de la celda especificada por rowIndex y columnIndex. El área combinada abarca un número especificado de filas y columnas.
mergeCells(rowIndex: number, columnIndex: number, rowCount: number, columnCount: number): void;
Parámetros
- rowIndex
-
number
Índice de fila basado en cero de la celda para iniciar el área combinada.
- columnIndex
-
number
Índice de columna basado en cero de la celda para iniciar el área combinada.
- rowCount
-
number
El número de filas que se combinarán con la celda inicial. Debe ser mayor que 0.
- columnCount
-
number
El número de columnas que se combinarán con la celda inicial. Debe ser mayor que 0.
Devoluciones
void
Comentarios
toJSON()
Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original PowerPoint.Table es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como PowerPoint.Interfaces.TableData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.
toJSON(): PowerPoint.Interfaces.TableData;