Acceder a la tabla dinámica de la fuente de datos existente y modificarla. Para crear una nueva tabla dinámica de fuente de datos, usa Range.createDataSourcePivotTable(dataSource)
.
Usa esta clase solo con datos que estén conectados a una base de datos.
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
addColumnGroup(columnName) | PivotGroup | Agrega un nuevo grupo de columnas dinámicas en función de la columna de fuente de datos especificada. |
addFilter(columnName, filterCriteria) | PivotFilter | Agrega un filtro nuevo basado en la columna de fuente de datos especificada con los criterios de filtro especificados. |
addPivotValue(columnName, summarizeFunction) | PivotValue | Agrega un nuevo valor dinámico basado en la columna de la fuente de datos especificada con la función de resumen especificada. |
addRowGroup(columnName) | PivotGroup | Agrega un nuevo grupo de filas dinámico basado en la columna de fuente de datos especificada. |
asPivotTable() | PivotTable | Muestra la tabla dinámica de la fuente de datos como un objeto de tabla dinámica normal. |
cancelDataRefresh() | DataSourcePivotTable | Cancela la actualización de datos asociada con este objeto si se está ejecutando actualmente. |
forceRefreshData() | DataSourcePivotTable | Actualiza los datos de este objeto sin importar el estado actual. |
getDataSource() | DataSource | Obtiene la fuente de datos a la que está vinculado el objeto. |
getStatus() | DataExecutionStatus | Obtiene el estado de ejecución de datos del objeto. |
refreshData() | DataSourcePivotTable | Actualiza los datos del objeto. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Espera hasta que se complete la ejecución actual y se agota el tiempo de espera después de la cantidad de segundos proporcionada. |
Documentación detallada
addColumnGroup(columnName)
Agrega un nuevo grupo de columnas dinámicas en función de la columna de fuente de datos especificada.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
columnName | String | El nombre de la columna de fuente de datos en el que se basa el grupo dinámico. |
Devolvedor
PivotGroup
: Es el nuevo grupo de elementos de tabla dinámica.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addFilter(columnName, filterCriteria)
Agrega un filtro nuevo basado en la columna de fuente de datos especificada con los criterios de filtro especificados.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
columnName | String | El nombre de la columna de fuente de datos en el que se basa el filtro. |
filterCriteria | FilterCriteria | Los criterios que utiliza el filtro. |
Devolvedor
PivotFilter
: Es el filtro nuevo.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addPivotValue(columnName, summarizeFunction)
Agrega un nuevo valor dinámico basado en la columna de la fuente de datos especificada con la función de resumen especificada.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
columnName | String | El nombre de la columna de fuente de datos en el que se basa el valor dinámico. |
summarizeFunction | PivotTableSummarizeFunction | La función de resumen que usa el valor dinámico. |
Devolvedor
PivotValue
: Es el nuevo valor de tabla dinámica.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addRowGroup(columnName)
Agrega un nuevo grupo de filas dinámico basado en la columna de fuente de datos especificada.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
columnName | String | El nombre de la columna de fuente de datos en el que se basa el grupo dinámico. |
Devolvedor
PivotGroup
: Es el nuevo grupo de elementos de tabla dinámica.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
asPivotTable()
Muestra la tabla dinámica de la fuente de datos como un objeto de tabla dinámica normal.
Devolvedor
PivotTable
: Es la tabla dinámica.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
cancelDataRefresh()
Cancela la actualización de datos asociada con este objeto si se está ejecutando actualmente.
En este ejemplo, se muestra cómo cancelar la actualización de una fórmula.
const spreadsheet = SpreadsheetApp.getActive(); const formula = spreadsheet.getDataSourceFormulas()[0]; // Cancel the ongoing refresh on the formula. formula.cancelDataRefresh();
Muestra una excepción si el tipo de fuente de datos no está habilitado. Usa métodos
SpreadsheetApp#enable...Execution()
para habilitar la ejecución de datos en un tipo específico de fuente de datos.
Devolvedor
DataSourcePivotTable
: Es el objeto de datos.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
forceRefreshData()
Actualiza los datos de este objeto sin importar el estado actual. Consulta refreshData()
para obtener más información. Si quieres cancelar una actualización en ejecución de este objeto, consulta cancelDataRefresh()
.
Muestra una excepción si el tipo de fuente de datos no está habilitado. Usa métodos SpreadsheetApp#enable...Execution()
para habilitar la ejecución de datos en un tipo específico de fuente de datos.
Devolvedor
DataSourcePivotTable
: Es el objeto de datos.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSource()
Obtiene la fuente de datos a la que está vinculado el objeto.
Devolvedor
DataSource
: Es la fuente de datos.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getStatus()
Obtiene el estado de ejecución de datos del objeto.
Devolvedor
DataExecutionStatus
: Es el estado de ejecución de datos.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
refreshData()
Actualiza los datos del objeto.
Muestra una excepción si está en el estado error
. Usa DataSource#updateSpec()
para actualizar la especificación. Se prefiere el método en lugar de forceRefreshData()
para evitar ediciones inesperadas en la fuente de datos.
Muestra una excepción si el tipo de fuente de datos no está habilitado. Usa métodos SpreadsheetApp#enable...Execution()
para habilitar la ejecución de datos en un tipo específico de fuente de datos.
Devolvedor
DataSourcePivotTable
: Es el objeto de datos.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
waitForCompletion(timeoutInSeconds)
Espera hasta que se complete la ejecución actual y se agota el tiempo de espera después de la cantidad de segundos proporcionada. Muestra una excepción si la ejecución no se completa cuando se agota el tiempo de espera, pero no cancela la ejecución de los datos.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
timeoutInSeconds | Integer | El tiempo de espera, en segundos, para la ejecución de los datos. La cantidad máxima es de 300 segundos. |
Devolvedor
DataExecutionStatus
: Es el estado de ejecución de datos.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets