Class DataSourceFormula

Fórmuladefuente de datos

Acceder a fórmulas de fuentes de datos existentes y modificarlas Para crear una nueva fórmula de fuente de datos, usa Range.setFormula(formula).

Usa esta clase solo con datos conectados a una base de datos de BigQuery.

Métodos

MétodoTipo de datos que se muestraDescripción breve
cancelDataRefresh()DataSourceFormulaCancela la actualización de datos asociada con este objeto si se está ejecutando.
forceRefreshData()DataSourceFormulaActualiza los datos de este objeto independientemente del estado actual.
getAnchorCell()RangeMuestra el Range que representa la celda en la que está anclada esta fórmula de fuente de datos.
getDataSource()DataSourceObtiene la fuente de datos a la que está vinculado el objeto.
getDisplayValue()StringMuestra el valor de visualización de la fórmula de la fuente de datos.
getFormula()StringMuestra la fórmula de esta fuente de datos.
getStatus()DataExecutionStatusObtiene el estado de ejecución de datos del objeto.
refreshData()DataSourceFormulaActualiza los datos del objeto.
setFormula(formula)DataSourceFormulaActualiza la fórmula.
waitForCompletion(timeoutInSeconds)DataExecutionStatusEspera hasta que se complete la ejecución actual y se agote 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.

En este ejemplo, se muestra cómo cancelar una actualización de fórmula. 

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

Genera 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 para un tipo de fuente de datos específico.

Volver

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 ámbitos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

forceRefreshData()

Actualiza los datos de este objeto independientemente del estado actual. Consulta refreshData() para obtener más detalles. Si quieres cancelar una actualización de este objeto que se está ejecutando, consulta cancelDataRefresh().

Genera 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 para un tipo de fuente de datos específico.

Volver

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 ámbitos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getAnchorCell()

Muestra el Range que representa la celda en la que está anclada esta fórmula de fuente de datos.

Volver

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 ámbitos:

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

Volver

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 ámbitos:

  • 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 la fuente de datos.

Volver

String: Es el valor de visualización.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFormula()

Muestra la fórmula de esta fuente de datos.

Volver

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 ámbitos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getStatus()

Obtiene el estado de ejecución de datos del objeto.

Volver

DataExecutionStatus: Es el estado de ejecución de los datos.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

refreshData()

Actualiza los datos del objeto.

Lanza una excepción si se encuentra en el estado error. Usa DataSource#updateSpec() para actualizar la especificación. Se prefiere el método a forceRefreshData() para evitar ediciones inesperadas en la fuente de datos.

Genera 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 para un tipo de fuente de datos específico.

Volver

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 ámbitos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFormula(formula)

Actualiza la fórmula.

Parámetros

NombreTipoDescripción
formulaStringLa fórmula nueva

Volver

DataSourceFormula: Es la fórmula de la fuente de datos para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

  • 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 agote el tiempo de espera después de la cantidad de segundos proporcionada. Arroja una excepción si la ejecución no se completa cuando se agota el tiempo de espera, pero no cancela la ejecución de datos.

Parámetros

NombreTipoDescripción
timeoutInSecondsIntegerEs el tiempo que se debe esperar para la ejecución de datos, en segundos. El máximo es de 300 segundos.

Volver

DataExecutionStatus: Es el estado de ejecución de los datos.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets