Accede a las fórmulas de fuentes de datos existentes y modifícalas. Para crear una nueva fórmula de fuente de datos, usa Range.setFormula(formula)
.
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 |
---|---|---|
cancelDataRefresh() | DataSourceFormula | Cancela la actualización de datos asociada con este objeto si se está ejecutando actualmente. |
forceRefreshData() | DataSourceFormula | Actualiza los datos de este objeto sin importar el estado actual. |
getAnchorCell() | Range | Muestra el elemento Range que representa la celda en la que se ancla esta fórmula de fuente de datos. |
getDataSource() | DataSource | Obtiene la fuente de datos a la que está vinculado el objeto. |
getDisplayValue() | String | Muestra el valor de visualización de la fórmula de fuente de datos. |
getFormula() | String | Muestra la fórmula de esta fórmula de fuente de datos. |
getStatus() | DataExecutionStatus | Obtiene el estado de ejecución de datos del objeto. |
refreshData() | DataSourceFormula | Actualiza los datos del objeto. |
setFormula(formula) | DataSourceFormula | Actualiza la fórmula. |
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
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
DataSourceFormula
: 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
DataSourceFormula
: 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
getAnchorCell()
Muestra el elemento Range
que representa la celda en la que se ancla esta fórmula de fuente de datos.
Devolvedor
Range
: Es la celda de anclaje.
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
getDisplayValue()
Muestra el valor de visualización de la fórmula de fuente de datos.
Devolvedor
String
: Es el valor visible.
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
getFormula()
Muestra la fórmula de esta fórmula de fuente de datos.
Devolvedor
String
: Es la fórmula.
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
DataSourceFormula
: 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
setFormula(formula)
Actualiza la fórmula.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
formula | String | La nueva fórmula. |
Devolvedor
DataSourceFormula
: Es la fórmula de la fuente de datos para el encadenamiento.
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