ExcelScript.Workbook interface

Referencia

Paquete:: ExcelScript

Workbook es el objeto de nivel superior que contiene objetos de libro relacionados, como hojas de cálculo, tablas y rangos.

Comentarios

Ejemplos

/**
 * This script adds a new worksheet to the workbook, then switches to it.
 */
function main(workbook: ExcelScript.Workbook) {
  // Add a new worksheet with the default name.
  let worksheet = workbook.addWorksheet();

  // Switch focus to the new worksheet.
  worksheet.activate();
}

Métodos

addBinding(range, bindingType, id)	Agregar un enlace nuevo a un intervalo determinado.
addBindingFromNamedItem(name, bindingType, id)	Agregar un enlace nuevo basándose en un elemento con nombre del libro. Si el elemento con nombre hace referencia a varias áreas, se devolverá el `InvalidReference` error.
addBindingFromSelection(bindingType, id)	Agregar un enlace nuevo basándose en la selección actual. Si la selección tiene varias áreas, se devolverá el `InvalidReference` error.
addComment(cellAddress, content, contentType)	Crea un nuevo comentario con el contenido específico de la celda. Se produce un `InvalidArgument` error si el intervalo proporcionado es mayor que una celda.
addCustomXmlPart(xml)	Se agrega un nuevo elemento XML personalizado al libro.
addNamedItem(name, reference, comment)	Agrega un nuevo nombre a la colección del ámbito especificado.
addNamedItemFormulaLocal(name, formula, comment)	Agrega un nuevo nombre a la colección del ámbito especificado, empleando la configuración regional del usuario para la fórmula.
addPivotTable(name, source, destination)	Agregue una tabla dinámica basada en los datos de origen especificados e insérela en la celda superior izquierda del intervalo de destino.
addPivotTableStyle(name, makeUniqueName)	Crea un espacio en blanco `PivotTableStyle` con el nombre especificado.
addPredefinedCellStyle(name)	Agrega un nuevo estilo a la colección.
addSlicer(slicerSource, sourceField, slicerDestination)	Agrega una nueva segmentación al libro.
addSlicerStyle(name, makeUniqueName)	Crea un estilo de segmentación en blanco con el nombre especificado.
addTable(address, hasHeaders)	Crear una tabla. El objeto de rango o la dirección de origen determinan la hoja de cálculo a la que se agregará la tabla. Si no se puede agregar la tabla (por ejemplo, porque la dirección no es válida o porque la tabla se superpondría con otra tabla), se producirá un error.
addTableStyle(name, makeUniqueName)	Crea un espacio en blanco `TableStyle` con el nombre especificado.
addTimelineStyle(name, makeUniqueName)	Crea un espacio en blanco `TimelineStyle` con el nombre especificado.
addWorksheet(name)	Agrega una nueva hoja al libro. La hoja de cálculo se agregará al final de las hojas de cálculo existentes. Si desea activar la hoja de cálculo recién agregada, llame a `.activate()` ella.
breakAllLinksToLinkedWorkbooks()	Interrumpe todos los vínculos a los libros vinculados. Una vez rotos los vínculos, las fórmulas que hacen referencia a los vínculos de libro se quitan por completo y se reemplazan por los valores recuperados más recientemente.
getActiveCell()	Obtiene la celda activa del libro.
getActiveChart()	Obtiene el gráfico activo del libro. Si no hay ningún gráfico activo, este método devuelve `undefined`.
getActiveSlicer()	Obtiene la segmentación activa del libro. Si no hay ninguna segmentación de datos activa, este método devuelve `undefined`.
getActiveWorksheet()	Obtiene la hoja de cálculo activa del libro.
getApplication()	Representa la instancia de la aplicación de Excel que contiene este libro.
getAutoSave()	Especifica si el libro está en modo autoguardado.
getBinding(id)	Obtiene un objeto de enlace por identificador. Si el objeto de enlace no existe, este método devuelve `undefined`.
getBindings()	Representa una colección de enlaces que forman parte del libro.
getCalculationEngineVersion()	Devuelve un número acerca de la versión del motor de cálculo de Excel.
getChartDataPointTrack()	True si todos los gráficos en el libro están siguiendo los puntos de datos reales a los que están conectados. False si los gráficos realizan un seguimiento del índice de los puntos de datos.
getComment(commentId)	Obtiene un comentario de la colección en función de su identificador. Si el objeto comment no existe, este método devuelve `undefined`.
getCommentByCell(cellAddress)	Obtiene el comentario de la celda especificada. Si no hay ningún comentario en la celda, se produce un error.
getCommentByReplyId(replyId)	Obtiene el comentario al que está conectada la respuesta especificada.
getComments()	Representa una colección de comentarios asociados al libro.
getCustomXmlPart(id)	Obtiene un elemento XML personalizado a partir de su identificador. `CustomXmlPart` Si no existe, este método devuelve `undefined`.
getCustomXmlPartByNamespace(namespaceUri)	Obtiene una nueva colección de elementos XML personalizados cuyos espacios de nombres coinciden con el espacio de nombres especificado.
getCustomXmlParts()	Representa la colección de elementos XML personalizados contenidos en este libro.
getCustomXmlPartsByNamespace(namespaceUri)	Obtiene una nueva colección de elementos XML personalizados cuyos espacios de nombres coinciden con el espacio de nombres especificado.
getDefaultPivotTableStyle()	Obtiene el estilo de tabla dinámica predeterminado para el ámbito del objeto primario.
getDefaultSlicerStyle()	Obtiene el valor predeterminado `SlicerStyle` para el ámbito del objeto primario.
getDefaultTableStyle()	Obtiene el estilo de tabla predeterminado para el ámbito del objeto primario.
getDefaultTimelineStyle()	Obtiene el estilo de escala de tiempo predeterminado para el ámbito del objeto primario.
getFirstWorksheet(visibleOnly)	Obtiene la primera hoja de cálculo de la colección.
getIsDirty()	Especifica si se han realizado cambios desde la última vez que se guardó el libro. Puede establecer esta propiedad `true` en si desea cerrar un libro modificado sin guardarlo o se le pide que lo guarde.
getLastWorksheet(visibleOnly)	Obtiene la última hoja de cálculo de la colección.
getLinkedWorkbookByUrl(key)	Obtiene información sobre un libro vinculado por su dirección URL. Si el libro no existe, este método devuelve `undefined`.
getLinkedWorkbookRefreshMode()	Representa el modo de actualización de los vínculos del libro. El modo es el mismo para todos los vínculos de libro presentes en el libro.
getLinkedWorkbooks()	Devuelve una colección de libros vinculados. En las fórmulas, los vínculos del libro se pueden usar para hacer referencia a datos (valores y nombres de celda) fuera del libro actual.
getName()	Obtiene el nombre del libro.
getNamedItem(name)	Obtiene un `NamedItem` objeto con su nombre. Si el objeto no existe, este método devuelve `undefined`.
getNames()	Representa una colección de elementos con nombre con ámbito de libro (intervalos y constantes con nombre).
getPivotTable(name)	Obtiene una tabla dinámica por nombre. Si la tabla dinámica no existe, este método devuelve `undefined`.
getPivotTables()	Representa una colección de tablas dinámicas asociadas con el libro.
getPivotTableStyle(name)	Obtiene un valor `PivotTableStyle` por nombre. `PivotTableStyle` Si no existe, este método devuelve `undefined`.
getPivotTableStyles()	Representa una colección de PivotTableStyles asociados con el libro.
getPredefinedCellStyle(name)	Obtiene un estilo por nombre. Si el objeto de estilo no existe, este método devuelve `undefined`.
getPredefinedCellStyles()	Representa una colección de estilos asociada con el libro.
getPreviouslySaved()	Especifica si el libro se ha guardado alguna vez localmente o en línea.
getProperties()	Obtiene las propiedades del libro.
getProtection()	Devuelve el objeto de protección de un libro.
getQueries()	Devuelve una colección de consultas Power Query que forman parte del libro.
getQuery(key)	Obtiene una consulta de la colección en función de su nombre.
getReadOnly()	Devuelve `true` si el libro está abierto en modo de solo lectura.
getSelectedRange()	Obtiene el intervalo único seleccionado actualmente del libro. Si hay varios intervalos seleccionados, este método producirá un error.
getSelectedRanges()	Obtiene los intervalos seleccionados actualmente en el libro. A diferencia de `getSelectedRange()`, este método devuelve un `RangeAreas` objeto que representa todos los intervalos seleccionados.
getSlicer(key)	Obtiene una segmentación de datos con su nombre o identificador. Si la segmentación de datos no existe, este método devuelve `undefined`.
getSlicers()	Representa una colección de segmentaciones de datos asociadas al libro.
getSlicerStyle(name)	Obtiene un valor `SlicerStyle` por nombre. Si el estilo de segmentación de datos no existe, este método devuelve `undefined`.
getSlicerStyles()	Representa una colección de SlicerStyles asociados con el libro.
getTable(key)	Obtener una tabla por nombre o identificador. Si la tabla no existe, este método devuelve `undefined`.
getTables()	Representa una colección de tablas asociadas con el libro.
getTableStyle(name)	Obtiene un valor `TableStyle` por nombre. Si el estilo de tabla no existe, este método devuelve `undefined`.
getTableStyles()	Representa una colección de TableStyles asociados con el libro.
getTimelineStyle(name)	Obtiene un valor `TimelineStyle` por nombre. Si el estilo de escala de tiempo no existe, este método devuelve `undefined`.
getTimelineStyles()	Representa una colección de TimelineStyles asociados con el libro.
getUsePrecisionAsDisplayed()	True si los cálculos de este libro se llevan a cabo con la misma precisión con que se muestran los números. Los datos perderán precisión de forma permanente al cambiar esta propiedad de `false` a `true`.
getWorksheet(key)	Obtiene un objeto de hoja de cálculo mediante su nombre o identificador. Si la hoja de cálculo no existe, este método devuelve `undefined`.
getWorksheets()	Representa una colección de hojas de cálculo asociadas con el libro.
refreshAllDataConnections()	Actualiza todos los Connections de datos.
refreshAllLinksToLinkedWorkbooks()	Realiza una solicitud para actualizar todos los vínculos del libro.
refreshAllPivotTables()	Actualiza todas las tablas dinámicas de la colección.
setChartDataPointTrack(chartDataPointTrack)	True si todos los gráficos en el libro están siguiendo los puntos de datos reales a los que están conectados. False si los gráficos realizan un seguimiento del índice de los puntos de datos.
setDefaultPivotTableStyle(newDefaultStyle)	Establece el estilo de tabla dinámica predeterminado para su uso en el ámbito del objeto primario.
setDefaultSlicerStyle(newDefaultStyle)	Establece el estilo de segmentación predeterminado para su uso en el ámbito del objeto primario.
setDefaultTableStyle(newDefaultStyle)	Establece el estilo de tabla predeterminado para su uso en el ámbito del objeto primario.
setDefaultTimelineStyle(newDefaultStyle)	Establece el estilo de escala de tiempo predeterminado para su uso en el ámbito del objeto primario.
setIsDirty(isDirty)	Especifica si se han realizado cambios desde la última vez que se guardó el libro. Puede establecer esta propiedad `true` en si desea cerrar un libro modificado sin guardarlo o se le pide que lo guarde.
setLinkedWorkbookRefreshMode(linkedWorkbookRefreshMode)	Representa el modo de actualización de los vínculos del libro. El modo es el mismo para todos los vínculos de libro presentes en el libro.
setUsePrecisionAsDisplayed(usePrecisionAsDisplayed)	True si los cálculos de este libro se llevan a cabo con la misma precisión con que se muestran los números. Los datos perderán precisión de forma permanente al cambiar esta propiedad de `false` a `true`.

Detalles del método

addBinding(range, bindingType, id)

Agregar un enlace nuevo a un intervalo determinado.

addBinding(
            range: Range | string,
            bindingType: BindingType,
            id: string
        ): Binding;

Parámetros

range: ExcelScript.Range | string

Intervalo al que se va a vincular el enlace. Puede ser un Range objeto o una cadena. Si es una cadena, debe incluir la dirección completa, incluido el nombre de la hoja

bindingType: ExcelScript.BindingType

Tipo de enlace. Consulte ExcelScript.BindingType.

id: string

Nombre del enlace.

Devoluciones

ExcelScript.Binding

addBindingFromNamedItem(name, bindingType, id)

Agregar un enlace nuevo basándose en un elemento con nombre del libro. Si el elemento con nombre hace referencia a varias áreas, se devolverá el InvalidReference error.

addBindingFromNamedItem(
            name: string,
            bindingType: BindingType,
            id: string
        ): Binding;

Parámetros

name: string

Nombre desde el que se va a crear el enlace.

bindingType: ExcelScript.BindingType

Tipo de enlace. Consulte ExcelScript.BindingType.

id: string

Nombre del enlace.

Devoluciones

ExcelScript.Binding

addBindingFromSelection(bindingType, id)

Agregar un enlace nuevo basándose en la selección actual. Si la selección tiene varias áreas, se devolverá el InvalidReference error.

addBindingFromSelection(bindingType: BindingType, id: string): Binding;

Parámetros

bindingType: ExcelScript.BindingType

Tipo de enlace. Consulte ExcelScript.BindingType.

id: string

Nombre del enlace.

Devoluciones

ExcelScript.Binding

addComment(cellAddress, content, contentType)

Crea un nuevo comentario con el contenido específico de la celda. Se produce un InvalidArgument error si el intervalo proporcionado es mayor que una celda.

addComment(
            cellAddress: Range | string,
            content: CommentRichContent | string,
            contentType?: ContentType
        ): Comment;

Parámetros

cellAddress: ExcelScript.Range | string

Celda a la que se agrega el comentario. Puede ser un Range objeto o una cadena. Si es una cadena, debe contener la dirección completa, incluido el nombre de la hoja. Se produce un InvalidArgument error si el intervalo proporcionado es mayor que una celda.

content: ExcelScript.CommentRichContent | string

Contenido del comentario. Puede ser una cadena o CommentRichContent un objeto. Las cadenas se usan para el texto sin formato. CommentRichContent los objetos permiten otras características de comentario, como menciones.

contentType: ExcelScript.ContentType

Opcional. Tipo de contenido contenido en el comentario. El valor predeterminado es enum ContentType.Plain.

Devoluciones

ExcelScript.Comment

addCustomXmlPart(xml)

Se agrega un nuevo elemento XML personalizado al libro.

addCustomXmlPart(xml: string): CustomXmlPart;

Parámetros

xml: string

Contenido XML. Debe ser un fragmento XML válido.

Devoluciones

ExcelScript.CustomXmlPart

addNamedItem(name, reference, comment)

Agrega un nuevo nombre a la colección del ámbito especificado.

addNamedItem(
            name: string,
            reference: Range | string,
            comment?: string
        ): NamedItem;

Parámetros

name: string

El nombre del elemento con nombre.

reference: ExcelScript.Range | string

Fórmula o rango a los que se refiere el nombre.

comment: string

Opcional. Comentario asociado al elemento con nombre.

Devoluciones

ExcelScript.NamedItem

Ejemplos

/**
 * This script creates a named formula and uses it in another part of the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a named item for a formula.
  // This formula is the sum of the cells F2:F21 on Sheet1.
  const namedItem: ExcelScript.NamedItem = workbook.addNamedItem(
    "GrandTotal", 
    "=SUM(Sheet1!$F$2:$F$21)", 
    "The sum of table sums."
  );

  // Add this named formula to a new sheet in the workbook.
  const otherSheet = workbook.addWorksheet();
  otherSheet.getRange("A1").setFormula(namedItem.getFormula());

  // Switch to the new worksheet.
  otherSheet.activate();
}

addNamedItemFormulaLocal(name, formula, comment)

Agrega un nuevo nombre a la colección del ámbito especificado, empleando la configuración regional del usuario para la fórmula.

addNamedItemFormulaLocal(
            name: string,
            formula: string,
            comment?: string
        ): NamedItem;

Parámetros

name: string

El nombre del elemento con nombre.

formula: string

Fórmula de la configuración regional del usuario a la que se refiere el nombre.

comment: string

Opcional. Comentario asociado al elemento con nombre.

Devoluciones

ExcelScript.NamedItem

addPivotTable(name, source, destination)

Agregue una tabla dinámica basada en los datos de origen especificados e insérela en la celda superior izquierda del intervalo de destino.

addPivotTable(
            name: string,
            source: Range | string | Table,
            destination: Range | string
        ): PivotTable;

Parámetros

name: string

Nombre de la nueva tabla dinámica.

source: ExcelScript.Range | string | ExcelScript.Table

Los datos de origen de la nueva tabla dinámica, pueden ser un rango (o una dirección de cadena, incluido el nombre de la hoja de cálculo) o una tabla.

destination: ExcelScript.Range | string

Celda de la esquina superior izquierda del rango de destino del informe de tabla dinámica (el rango de la hoja de cálculo en el que se colocará el informe de tabla dinámica resultante).

Devoluciones

ExcelScript.PivotTable

Ejemplos

/**
 * This script creates a PivotTable from an existing table and adds it to an existing worksheet.
 * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
 * It also assumes there is a worksheet named "PivotSheet".
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a PivotTable based on a table in the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let table = sheet.getTables()[0];
  let pivotTable = workbook.addPivotTable("My Pivot", table, "PivotSheet!A1");

  // Add fields to the PivotTable to show "Sales" per "Type".
  pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
  pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
}

addPivotTableStyle(name, makeUniqueName)

Crea un espacio en blanco PivotTableStyle con el nombre especificado.

addPivotTableStyle(
            name: string,
            makeUniqueName?: boolean
        ): PivotTableStyle;

Parámetros

name: string

Nombre único del nuevo estilo de tabla dinámica. Producirá un InvalidArgument error si el nombre ya está en uso.

makeUniqueName: boolean

Opcional. El valor predeterminado es false. Si truees , anexará números al nombre para que sea único, si es necesario.

Devoluciones

ExcelScript.PivotTableStyle

addPredefinedCellStyle(name)

Agrega un nuevo estilo a la colección.

addPredefinedCellStyle(name: string): void;

Parámetros

name: string

Nombre del estilo que se va a agregar.

Devoluciones

void

addSlicer(slicerSource, sourceField, slicerDestination)

Agrega una nueva segmentación al libro.

addSlicer(
            slicerSource: string | PivotTable | Table,
            sourceField: string | PivotField | number | TableColumn,
            slicerDestination?: string | Worksheet
        ): Slicer;

Parámetros

slicerSource: string | ExcelScript.PivotTable | ExcelScript.Table

Origen de datos en el que se basará la nueva segmentación de datos. Puede ser un PivotTable objeto, un Table objeto o una cadena. Cuando se pasa un objeto de tabla dinámica, el origen de datos es el origen del PivotTable objeto. Cuando se pasa un Table objeto, el origen de datos es el Table objeto . Cuando se pasa una cadena, se interpreta como el nombre o identificador de una tabla dinámica o tabla.

sourceField: string | ExcelScript.PivotField | number | ExcelScript.TableColumn

Campo del origen de datos por el que se va a filtrar. Puede ser un PivotField objeto, un TableColumn objeto, el identificador de o PivotField el nombre o identificador de un TableColumnobjeto .

slicerDestination: string | ExcelScript.Worksheet

Opcional. Hoja de cálculo en la que se creará la nueva segmentación de datos. Puede ser un Worksheet objeto o el nombre o identificador de una hoja de cálculo. Este parámetro se puede omitir si la colección de segmentación de datos se recupera de una hoja de cálculo.

Devoluciones

ExcelScript.Slicer

Ejemplos

/**
 * This script adds a slicer for an existing PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Pivot".
  const farmPivot = workbook.getPivotTable("Farm Pivot");

  // Create the slicer. 
  // Note that this assumes "Type" is already added as a hierarchy to the PivotTable.
  const fruitSlicer: ExcelScript.Slicer = workbook.addSlicer(
    farmPivot, /* The table or PivotTale to be sliced. */
    farmPivot.getHierarchy("Type").getFields()[0] /* What source field to use as the slicer options. */
  );

  // Select the items to display.
  fruitSlicer.selectItems(["Lemon", "Lime"]);

  // Set the left margin of the slicer.
  fruitSlicer.setLeft(400);
}

addSlicerStyle(name, makeUniqueName)

Crea un estilo de segmentación en blanco con el nombre especificado.

addSlicerStyle(name: string, makeUniqueName?: boolean): SlicerStyle;

Parámetros

name: string

Nombre único del nuevo estilo de segmentación de datos. Producirá una InvalidArgument excepción si el nombre ya está en uso.

makeUniqueName: boolean

Opcional. El valor predeterminado es false. Si truees , anexará números al nombre para que sea único, si es necesario.

Devoluciones

ExcelScript.SlicerStyle

addTable(address, hasHeaders)

Crear una tabla. El objeto de rango o la dirección de origen determinan la hoja de cálculo a la que se agregará la tabla. Si no se puede agregar la tabla (por ejemplo, porque la dirección no es válida o porque la tabla se superpondría con otra tabla), se producirá un error.

addTable(address: Range | string, hasHeaders: boolean): Table;

Parámetros

address: ExcelScript.Range | string

Un Range objeto, una dirección de cadena o un nombre del intervalo que representa el origen de datos. Si la dirección no contiene un nombre de hoja, se usa la hoja activa en ese momento.

hasHeaders: boolean

Valor booleano que indica si los datos que se importan tienen etiquetas de columna. Si el origen no contiene encabezados (es decir, cuando esta propiedad se establece en false), Excel generará automáticamente un encabezado y desplazará los datos hacia abajo por una fila.

Devoluciones

ExcelScript.Table

Ejemplos

/**
 * This sample converts the information in the first worksheet
 * into a table with headers.
*/
function main(workbook: ExcelScript.Workbook) {
  // This assumes there is one contiguous range in the first worksheet.
  const dataRange = workbook.getFirstWorksheet().getUsedRange();
  
  // Add a table at the workbook level.
  workbook.addTable(dataRange.getAddress(), true);
}

addTableStyle(name, makeUniqueName)

Crea un espacio en blanco TableStyle con el nombre especificado.

addTableStyle(name: string, makeUniqueName?: boolean): TableStyle;

Parámetros

name: string

Nombre único del nuevo estilo de tabla. Producirá un InvalidArgument error si el nombre ya está en uso.

makeUniqueName: boolean

Opcional. El valor predeterminado es false. Si truees , anexará números al nombre para que sea único, si es necesario.

Devoluciones

ExcelScript.TableStyle

addTimelineStyle(name, makeUniqueName)

Crea un espacio en blanco TimelineStyle con el nombre especificado.

addTimelineStyle(name: string, makeUniqueName?: boolean): TimelineStyle;

Parámetros

name: string

Nombre único del nuevo estilo de escala de tiempo. Producirá un InvalidArgument error si el nombre ya está en uso.

makeUniqueName: boolean

Opcional. El valor predeterminado es false. Si truees , anexará números al nombre para que sea único, si es necesario.

Devoluciones

ExcelScript.TimelineStyle

addWorksheet(name)

Agrega una nueva hoja al libro. La hoja de cálculo se agregará al final de las hojas de cálculo existentes. Si desea activar la hoja de cálculo recién agregada, llame a .activate() ella.

addWorksheet(name?: string): Worksheet;

Parámetros

name: string

Opcional. Nombre de la hoja de cálculo que se va a agregar. Si se especifica, el nombre debe ser único. Si no se especifica, Excel determina el nombre de la nueva hoja de cálculo.

Devoluciones

ExcelScript.Worksheet

Ejemplos

/**
 * This script adds a new worksheet named "Data" to the workbook.
 * If a worksheet with that name already exists, the script logs a note.
 */
function main(workbook: ExcelScript.Workbook) {
  // Check if the "Data" worksheet already exists.
  if (workbook.getWorksheet("Data")) {
    console.log("The Data worksheet is already in the workbook.");
  } else {
    // Add a new worksheet.
    let worksheet = workbook.addWorksheet("Data");
  }
}

breakAllLinksToLinkedWorkbooks()

Interrumpe todos los vínculos a los libros vinculados. Una vez rotos los vínculos, las fórmulas que hacen referencia a los vínculos de libro se quitan por completo y se reemplazan por los valores recuperados más recientemente.

breakAllLinksToLinkedWorkbooks(): void;

Devoluciones

void

getActiveCell()

Obtiene la celda activa del libro.

getActiveCell(): Range;

Devoluciones

ExcelScript.Range

Ejemplos

/**
 * This script logs the value of the current active cell. 
 * If multiple cells are selected, the top-leftmost cell will be logged.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current active cell in the workbook.
  let cell = workbook.getActiveCell();
  console.log(`The current cell's value is ${cell.getValue()}`);
}

getActiveChart()

Obtiene el gráfico activo del libro. Si no hay ningún gráfico activo, este método devuelve undefined.

getActiveChart(): Chart;

Devoluciones

ExcelScript.Chart

getActiveSlicer()

Obtiene la segmentación activa del libro. Si no hay ninguna segmentación de datos activa, este método devuelve undefined.

getActiveSlicer(): Slicer;

Devoluciones

ExcelScript.Slicer

getActiveWorksheet()

Obtiene la hoja de cálculo activa del libro.

getActiveWorksheet(): Worksheet;

Devoluciones

ExcelScript.Worksheet

getApplication()

Representa la instancia de la aplicación de Excel que contiene este libro.

getApplication(): Application;

Devoluciones

ExcelScript.Application

getAutoSave()

Especifica si el libro está en modo autoguardado.

getAutoSave(): boolean;

Devoluciones

boolean

getBinding(id)

Obtiene un objeto de enlace por identificador. Si el objeto de enlace no existe, este método devuelve undefined.

getBinding(id: string): Binding | undefined;

Parámetros

id: string

Identificador del objeto de contenido que se va a recuperar.

Devoluciones

ExcelScript.Binding | undefined

getBindings()

Representa una colección de enlaces que forman parte del libro.

getBindings(): Binding[];

Devoluciones

ExcelScript.Binding[]

getCalculationEngineVersion()

Devuelve un número acerca de la versión del motor de cálculo de Excel.

getCalculationEngineVersion(): number;

Devoluciones

number

getChartDataPointTrack()

True si todos los gráficos en el libro están siguiendo los puntos de datos reales a los que están conectados. False si los gráficos realizan un seguimiento del índice de los puntos de datos.

getChartDataPointTrack(): boolean;

Devoluciones

boolean

getComment(commentId)

Obtiene un comentario de la colección en función de su identificador. Si el objeto comment no existe, este método devuelve undefined.

getComment(commentId: string): Comment | undefined;

Parámetros

commentId: string

Identificador del comentario.

Devoluciones

ExcelScript.Comment | undefined

getCommentByCell(cellAddress)

Obtiene el comentario de la celda especificada. Si no hay ningún comentario en la celda, se produce un error.

getCommentByCell(cellAddress: Range | string): Comment;

Parámetros

cellAddress: ExcelScript.Range | string

Celda en la que se encuentra el comentario. Puede ser un Range objeto o una cadena. Si es una cadena, debe contener la dirección completa, incluido el nombre de la hoja. Se produce un InvalidArgument error si el intervalo proporcionado es mayor que una celda.

Devoluciones

ExcelScript.Comment

getCommentByReplyId(replyId)

Obtiene el comentario al que está conectada la respuesta especificada.

getCommentByReplyId(replyId: string): Comment;

Parámetros

replyId: string

Identificador de la respuesta de comentario.

Devoluciones

ExcelScript.Comment

getComments()

Representa una colección de comentarios asociados al libro.

getComments(): Comment[];

Devoluciones

ExcelScript.Comment[]

getCustomXmlPart(id)

Obtiene un elemento XML personalizado a partir de su identificador. CustomXmlPart Si no existe, este método devuelve undefined.

getCustomXmlPart(id: string): CustomXmlPart | undefined;

Parámetros

id: string

Identificador del objeto que se va a recuperar.

Devoluciones

ExcelScript.CustomXmlPart | undefined

getCustomXmlPartByNamespace(namespaceUri)

Advertencia

Esta API ya está en desuso.

Use getCustomXmlPartsByNamespace instead.

Obtiene una nueva colección de elementos XML personalizados cuyos espacios de nombres coinciden con el espacio de nombres especificado.

getCustomXmlPartByNamespace(namespaceUri: string): CustomXmlPart[];

Parámetros

namespaceUri: string

Debe ser un URI de esquema completo; por ejemplo, "http://schemas.contoso.com/review/1.0".

Devoluciones

ExcelScript.CustomXmlPart[]

getCustomXmlParts()

Representa la colección de elementos XML personalizados contenidos en este libro.

getCustomXmlParts(): CustomXmlPart[];

Devoluciones

ExcelScript.CustomXmlPart[]

getCustomXmlPartsByNamespace(namespaceUri)

Obtiene una nueva colección de elementos XML personalizados cuyos espacios de nombres coinciden con el espacio de nombres especificado.

getCustomXmlPartsByNamespace(namespaceUri: string): CustomXmlPart[];

Parámetros

namespaceUri: string

Debe ser un URI de esquema completo; por ejemplo, "http://schemas.contoso.com/review/1.0".

Devoluciones

ExcelScript.CustomXmlPart[]

getDefaultPivotTableStyle()

Obtiene el estilo de tabla dinámica predeterminado para el ámbito del objeto primario.

getDefaultPivotTableStyle(): PivotTableStyle;

Devoluciones

ExcelScript.PivotTableStyle

getDefaultSlicerStyle()

Obtiene el valor predeterminado SlicerStyle para el ámbito del objeto primario.

getDefaultSlicerStyle(): SlicerStyle;

Devoluciones

ExcelScript.SlicerStyle

getDefaultTableStyle()

Obtiene el estilo de tabla predeterminado para el ámbito del objeto primario.

getDefaultTableStyle(): TableStyle;

Devoluciones

ExcelScript.TableStyle

getDefaultTimelineStyle()

Obtiene el estilo de escala de tiempo predeterminado para el ámbito del objeto primario.

getDefaultTimelineStyle(): TimelineStyle;

Devoluciones

ExcelScript.TimelineStyle

getFirstWorksheet(visibleOnly)

Obtiene la primera hoja de cálculo de la colección.

getFirstWorksheet(visibleOnly?: boolean): Worksheet;

Parámetros

visibleOnly: boolean

Opcional. Si truees , solo tiene en cuenta las hojas de cálculo visibles, omitiendo las ocultas.

Devoluciones

ExcelScript.Worksheet

getIsDirty()

Especifica si se han realizado cambios desde la última vez que se guardó el libro. Puede establecer esta propiedad true en si desea cerrar un libro modificado sin guardarlo o se le pide que lo guarde.

getIsDirty(): boolean;

Devoluciones

boolean

getLastWorksheet(visibleOnly)

Obtiene la última hoja de cálculo de la colección.

getLastWorksheet(visibleOnly?: boolean): Worksheet;

Parámetros

visibleOnly: boolean

Opcional. Si truees , solo tiene en cuenta las hojas de cálculo visibles, omitiendo las ocultas.

Devoluciones

ExcelScript.Worksheet

getLinkedWorkbookByUrl(key)

Obtiene información sobre un libro vinculado por su dirección URL. Si el libro no existe, este método devuelve undefined.

getLinkedWorkbookByUrl(key: string): LinkedWorkbook | undefined;

Parámetros

key: string

Dirección URL del libro vinculado.

Devoluciones

ExcelScript.LinkedWorkbook | undefined

getLinkedWorkbookRefreshMode()

Representa el modo de actualización de los vínculos del libro. El modo es el mismo para todos los vínculos de libro presentes en el libro.

getLinkedWorkbookRefreshMode(): WorkbookLinksRefreshMode;

Devoluciones

ExcelScript.WorkbookLinksRefreshMode

Ejemplos

/**
 * This script refreshes all the links to external workbooks, 
 * if the linked workbook refresh mode is set to manual.
 * To learn about linked workbooks, see https://support.microsoft.com/office/c98d1803-dd75-4668-ac6a-d7cca2a9b95f.
 */
function main(workbook: ExcelScript.Workbook) {
  // Check the refresh mode.
  if (workbook.getLinkedWorkbookRefreshMode() === ExcelScript.WorkbookLinksRefreshMode.manual) {
    console.log("Refreshing workbook links");

    // Trigger a refresh of linked workbook content.
    workbook.refreshAllLinksToLinkedWorkbooks();
  }

getLinkedWorkbooks()

Devuelve una colección de libros vinculados. En las fórmulas, los vínculos del libro se pueden usar para hacer referencia a datos (valores y nombres de celda) fuera del libro actual.

getLinkedWorkbooks(): LinkedWorkbook[];

Devoluciones

ExcelScript.LinkedWorkbook[]

Ejemplos

/**
 * This script removes all links to other workbooks.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get all the linked workbook references.
    const externalWorkbooks: ExcelScript.LinkedWorkbook[] = workbook.getLinkedWorkbooks();
    console.log(`There are ${externalWorkbooks.length} other workbooks linked to from this workbook.`);

    // Remove all the links to those workbooks.
    // This changes the value of cells with workbook links to "#CONNECT!".
    externalWorkbooks.forEach((workbookLink) => {
        workbookLink.breakLinks();
    });
}

getName()

Obtiene el nombre del libro.

getName(): string;

Devoluciones

string

Ejemplos

/**
 * This script logs the name of the workbook without the ".xlsx" extension.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the workbook's name.
  let name = workbook.getName();

  // Remove the file extension.
  name = name.substring(0, name.lastIndexOf(".xlsx"));

  // Display the name in the console.
  console.log(name);
}

getNamedItem(name)

Obtiene un NamedItem objeto con su nombre. Si el objeto no existe, este método devuelve undefined.

getNamedItem(name: string): NamedItem | undefined;

Parámetros

name: string

Nombre del elemento con nombre.

Devoluciones

ExcelScript.NamedItem | undefined

getNames()

Representa una colección de elementos con nombre con ámbito de libro (intervalos y constantes con nombre).

getNames(): NamedItem[];

Devoluciones

ExcelScript.NamedItem[]

Ejemplos

/**
 * This script looks for every named range with "Review" in the name 
 * and marks the range with a yellow fill.
 */
function main(workbook: ExcelScript.Workbook) {
  // Look at every named item in the workbook.
  workbook.getNames().forEach((namedItem) => {
    // Find names containing "Review".
    if (namedItem.getName().includes("Review")) {
      // Only change the fill color if the named item is a range (not a formula).
      let itemType: ExcelScript.NamedItemType = namedItem.getType();
      if (itemType === ExcelScript.NamedItemType.range) {
        // Set the range's fill color to yellow.
        namedItem.getRange().getFormat().getFill().setColor("yellow");
      }
    }
  });
}

getPivotTable(name)

Obtiene una tabla dinámica por nombre. Si la tabla dinámica no existe, este método devuelve undefined.

getPivotTable(name: string): PivotTable | undefined;

Parámetros

name: string

Nombre de la tabla dinámica que se va a recuperar.

Devoluciones

ExcelScript.PivotTable | undefined

getPivotTables()

Representa una colección de tablas dinámicas asociadas con el libro.

getPivotTables(): PivotTable[];

Devoluciones

ExcelScript.PivotTable[]

getPivotTableStyle(name)

Obtiene un valor PivotTableStyle por nombre. PivotTableStyle Si no existe, este método devuelve undefined.

getPivotTableStyle(name: string): PivotTableStyle | undefined;

Parámetros

name: string

Nombre del estilo de tabla dinámica que se va a recuperar.

Devoluciones

ExcelScript.PivotTableStyle | undefined

getPivotTableStyles()

Representa una colección de PivotTableStyles asociados con el libro.

getPivotTableStyles(): PivotTableStyle[];

Devoluciones

ExcelScript.PivotTableStyle[]

getPredefinedCellStyle(name)

Obtiene un estilo por nombre. Si el objeto de estilo no existe, este método devuelve undefined.

getPredefinedCellStyle(name: string): PredefinedCellStyle | undefined;

Parámetros

name: string

Nombre del estilo que se va a recuperar.

Devoluciones

ExcelScript.PredefinedCellStyle | undefined

getPredefinedCellStyles()

Representa una colección de estilos asociada con el libro.

getPredefinedCellStyles(): PredefinedCellStyle[];

Devoluciones

ExcelScript.PredefinedCellStyle[]

getPreviouslySaved()

Especifica si el libro se ha guardado alguna vez localmente o en línea.

getPreviouslySaved(): boolean;

Devoluciones

boolean

getProperties()

Obtiene las propiedades del libro.

getProperties(): DocumentProperties;

Devoluciones

ExcelScript.DocumentProperties

getProtection()

Devuelve el objeto de protección de un libro.

getProtection(): WorkbookProtection;

Devoluciones

ExcelScript.WorkbookProtection

Ejemplos

/**
 * This script protects the workbook with a password, if it isn't already protected.
 * The password is provided by the user through a prompt.
 */
function main(workbook: ExcelScript.Workbook, password?: string) {
  // Get the workbook-level protection object.
  const protection = workbook.getProtection();

  // Check if the workbook is already protected.
  if (!protection.getProtected()) {
      // Protect the workbook with the given password.
      // If the optional password was omitted, 
      // no password will be needed to unprotect the workbook.
    protection.protect(password);
  }
}

getQueries()

Devuelve una colección de consultas Power Query que forman parte del libro.

getQueries(): Query[];

Devoluciones

ExcelScript.Query[]

getQuery(key)

Obtiene una consulta de la colección en función de su nombre.

getQuery(key: string): Query;

Parámetros

key: string

Nombre de la consulta que no distingue mayúsculas de minúsculas.

Devoluciones

ExcelScript.Query

getReadOnly()

Devuelve true si el libro está abierto en modo de solo lectura.

getReadOnly(): boolean;

Devoluciones

boolean

getSelectedRange()

Obtiene el intervalo único seleccionado actualmente del libro. Si hay varios intervalos seleccionados, este método producirá un error.

getSelectedRange(): Range;

Devoluciones

ExcelScript.Range

getSelectedRanges()

Obtiene los intervalos seleccionados actualmente en el libro. A diferencia de getSelectedRange(), este método devuelve un RangeAreas objeto que representa todos los intervalos seleccionados.

getSelectedRanges(): RangeAreas;

Devoluciones

ExcelScript.RangeAreas

getSlicer(key)

Obtiene una segmentación de datos con su nombre o identificador. Si la segmentación de datos no existe, este método devuelve undefined.

getSlicer(key: string): Slicer | undefined;

Parámetros

key: string

Nombre o identificador de la segmentación de datos que se va a recuperar.

Devoluciones

ExcelScript.Slicer | undefined

getSlicers()

Representa una colección de segmentaciones de datos asociadas al libro.

getSlicers(): Slicer[];

Devoluciones

ExcelScript.Slicer[]

getSlicerStyle(name)

Obtiene un valor SlicerStyle por nombre. Si el estilo de segmentación de datos no existe, este método devuelve undefined.

getSlicerStyle(name: string): SlicerStyle | undefined;

Parámetros

name: string

Nombre del estilo de segmentación de datos que se va a recuperar.

Devoluciones

ExcelScript.SlicerStyle | undefined

getSlicerStyles()

Representa una colección de SlicerStyles asociados con el libro.

getSlicerStyles(): SlicerStyle[];

Devoluciones

ExcelScript.SlicerStyle[]

getTable(key)

Obtener una tabla por nombre o identificador. Si la tabla no existe, este método devuelve undefined.

getTable(key: string): Table | undefined;

Parámetros

key: string

Nombre o identificador de la tabla que se va a recuperar.

Devoluciones

ExcelScript.Table | undefined

getTables()

Representa una colección de tablas asociadas con el libro.

getTables(): Table[];

Devoluciones

ExcelScript.Table[]

getTableStyle(name)

Obtiene un valor TableStyle por nombre. Si el estilo de tabla no existe, este método devuelve undefined.

getTableStyle(name: string): TableStyle | undefined;

Parámetros

name: string

Nombre del estilo de tabla que se va a recuperar.

Devoluciones

ExcelScript.TableStyle | undefined

getTableStyles()

Representa una colección de TableStyles asociados con el libro.

getTableStyles(): TableStyle[];

Devoluciones

ExcelScript.TableStyle[]

getTimelineStyle(name)

Obtiene un valor TimelineStyle por nombre. Si el estilo de escala de tiempo no existe, este método devuelve undefined.

getTimelineStyle(name: string): TimelineStyle | undefined;

Parámetros

name: string

Nombre del estilo de escala de tiempo que se va a recuperar.

Devoluciones

ExcelScript.TimelineStyle | undefined

getTimelineStyles()

Representa una colección de TimelineStyles asociados con el libro.

getTimelineStyles(): TimelineStyle[];

Devoluciones

ExcelScript.TimelineStyle[]

getUsePrecisionAsDisplayed()

True si los cálculos de este libro se llevan a cabo con la misma precisión con que se muestran los números. Los datos perderán precisión de forma permanente al cambiar esta propiedad de false a true.

getUsePrecisionAsDisplayed(): boolean;

Devoluciones

boolean

getWorksheet(key)

Obtiene un objeto de hoja de cálculo mediante su nombre o identificador. Si la hoja de cálculo no existe, este método devuelve undefined.

getWorksheet(key: string): Worksheet | undefined;

Parámetros

key: string

Nombre o identificador de la hoja de cálculo.

Devoluciones

ExcelScript.Worksheet | undefined

Ejemplos

/**
 * This script switches the active view to a worksheet named "Data", if it exists.
 */
function main(workbook: ExcelScript.Workbook) {
  // Check if the "Data" worksheet exists.
  let dataWorksheet = workbook.getWorksheet("Data");
  if (dataWorksheet) {
    // Switch to the "Data" worksheet.
    dataWorksheet.activate();
  } else {
    console.log(`No worksheet named "Data" in this workbook.`);
  }
}

getWorksheets()

Representa una colección de hojas de cálculo asociadas con el libro.

getWorksheets(): Worksheet[];

Devoluciones

ExcelScript.Worksheet[]

Ejemplos

/**
 * This script logs the names of all the worksheets in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get all the worksheets in the workbook. 
  let sheets = workbook.getWorksheets();

  // Get a list of all the worksheet names.
  let names = sheets.map ((sheet) => sheet.getName());

  // Write in the console all the worksheet names and the total count.
  console.log(names);
  console.log(`Total worksheets inside of this workbook: ${sheets.length}`);
}

refreshAllDataConnections()

Actualiza todos los Connections de datos.

refreshAllDataConnections(): void;

Devoluciones

void

refreshAllLinksToLinkedWorkbooks()

Realiza una solicitud para actualizar todos los vínculos del libro.

refreshAllLinksToLinkedWorkbooks(): void;

Devoluciones

void

refreshAllPivotTables()

Actualiza todas las tablas dinámicas de la colección.

refreshAllPivotTables(): void;

Devoluciones

void

setChartDataPointTrack(chartDataPointTrack)

True si todos los gráficos en el libro están siguiendo los puntos de datos reales a los que están conectados. False si los gráficos realizan un seguimiento del índice de los puntos de datos.

setChartDataPointTrack(chartDataPointTrack: boolean): void;

Parámetros

chartDataPointTrack: boolean

Devoluciones

void

setDefaultPivotTableStyle(newDefaultStyle)

Establece el estilo de tabla dinámica predeterminado para su uso en el ámbito del objeto primario.

setDefaultPivotTableStyle(
            newDefaultStyle: PivotTableStyle | string
        ): void;

Parámetros

newDefaultStyle: ExcelScript.PivotTableStyle | string

Objeto PivotTableStyle , o nombre del PivotTableStyle objeto, que debe ser el nuevo valor predeterminado.

Devoluciones

void

setDefaultSlicerStyle(newDefaultStyle)

Establece el estilo de segmentación predeterminado para su uso en el ámbito del objeto primario.

setDefaultSlicerStyle(newDefaultStyle: SlicerStyle | string): void;

Parámetros

newDefaultStyle: ExcelScript.SlicerStyle | string

Objeto SlicerStyle , o nombre del SlicerStyle objeto, que debe ser el nuevo valor predeterminado.

Devoluciones

void

setDefaultTableStyle(newDefaultStyle)

Establece el estilo de tabla predeterminado para su uso en el ámbito del objeto primario.

setDefaultTableStyle(newDefaultStyle: TableStyle | string): void;

Parámetros

newDefaultStyle: ExcelScript.TableStyle | string

Objeto TableStyle , o nombre del TableStyle objeto, que debe ser el nuevo valor predeterminado.

Devoluciones

void

setDefaultTimelineStyle(newDefaultStyle)

Establece el estilo de escala de tiempo predeterminado para su uso en el ámbito del objeto primario.

setDefaultTimelineStyle(newDefaultStyle: TimelineStyle | string): void;

Parámetros

newDefaultStyle: ExcelScript.TimelineStyle | string

Objeto TimelineStyle , o nombre del TimelineStyle objeto, que debe ser el nuevo valor predeterminado.

Devoluciones

void

setIsDirty(isDirty)

setIsDirty(isDirty: boolean): void;

Parámetros

isDirty: boolean

Devoluciones

void

setLinkedWorkbookRefreshMode(linkedWorkbookRefreshMode)

Representa el modo de actualización de los vínculos del libro. El modo es el mismo para todos los vínculos de libro presentes en el libro.

setLinkedWorkbookRefreshMode(
            linkedWorkbookRefreshMode: WorkbookLinksRefreshMode
        ): void;

Parámetros

linkedWorkbookRefreshMode: ExcelScript.WorkbookLinksRefreshMode

Devoluciones

void

setUsePrecisionAsDisplayed(usePrecisionAsDisplayed)

setUsePrecisionAsDisplayed(usePrecisionAsDisplayed: boolean): void;

Parámetros

usePrecisionAsDisplayed: boolean

Devoluciones

void

Compartir a través de

ExcelScript.Workbook interface

Comentarios

Ejemplos

Métodos

Detalles del método

addBinding(range, bindingType, id)

Parámetros

Devoluciones

addBindingFromNamedItem(name, bindingType, id)

Parámetros

Devoluciones

addBindingFromSelection(bindingType, id)

Parámetros

Devoluciones

addComment(cellAddress, content, contentType)

Parámetros

Devoluciones

addCustomXmlPart(xml)

Parámetros

Devoluciones

addNamedItem(name, reference, comment)

Parámetros

Devoluciones

Ejemplos

addNamedItemFormulaLocal(name, formula, comment)

Parámetros

Devoluciones

addPivotTable(name, source, destination)

Parámetros

Devoluciones

Ejemplos

addPivotTableStyle(name, makeUniqueName)

Parámetros

Devoluciones

addPredefinedCellStyle(name)

Parámetros

Devoluciones

addSlicer(slicerSource, sourceField, slicerDestination)

Parámetros

Devoluciones

Ejemplos

addSlicerStyle(name, makeUniqueName)

Parámetros

Devoluciones

addTable(address, hasHeaders)

Parámetros

Devoluciones

Ejemplos

addTableStyle(name, makeUniqueName)

Parámetros

Devoluciones

addTimelineStyle(name, makeUniqueName)

Parámetros

Devoluciones

addWorksheet(name)

Parámetros

Devoluciones

Ejemplos

breakAllLinksToLinkedWorkbooks()

Devoluciones

getActiveCell()

Devoluciones

Ejemplos

getActiveChart()

Devoluciones

getActiveSlicer()

Devoluciones

getActiveWorksheet()

Devoluciones

getApplication()

Devoluciones

getAutoSave()

Devoluciones

getBinding(id)

Parámetros

Devoluciones

getBindings()

Devoluciones

getCalculationEngineVersion()