ExcelScript.Worksheet interface

Referencia

Paquete:: ExcelScript

Una hoja de cálculo de Excel es una cuadrícula de celdas. Puede contener datos, tablas, gráficos, etc.

Comentarios

Ejemplos

/**
 * This script creates a new worksheet named "Plum" and sets its tab color to purple.
 */
function main(workbook: ExcelScript.Workbook) {
  const newSheet = workbook.addWorksheet("Plum")
  newSheet.setTabColor("purple");
}

Métodos

activate()	Activa la hoja de cálculo en la interfaz de usuario de Excel.
addChart(type, sourceData, seriesBy)	Crea un nuevo gráfico.
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.
addGeometricShape(geometricShapeType)	Agrega una forma geométrica a la hoja de cálculo. Devuelve un `Shape` objeto que representa la nueva forma.
addGroup(values)	Agrupa un subconjunto de formas en la hoja de cálculo de esta colección. Devuelve un `Shape` objeto que representa el nuevo grupo de formas.
addHorizontalPageBreak(pageBreakRange)	Agrega un salto de página antes de la celda superior izquierda del intervalo especificado.
addImage(base64ImageString)	Crea una imagen de una cadena con codificación base64 y la agrega a la hoja de cálculo. Devuelve el `Shape` objeto que representa la nueva imagen.
addLine(startLeft, startTop, endLeft, endTop, connectorType)	Agrega una línea a la hoja de cálculo. Devuelve un `Shape` objeto que representa la nueva línea.
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.
addNamedSheetView(name)	Crea una nueva vista de hoja con el nombre especificado.
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.
addSlicer(slicerSource, sourceField, slicerDestination)	Agrega una nueva segmentación al libro.
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.
addTextBox(text)	Agrega un cuadro de texto a la hoja de cálculo con el texto proporcionado como contenido. Devuelve un `Shape` objeto que representa el nuevo cuadro de texto.
addVerticalPageBreak(pageBreakRange)	Agrega un salto de página antes de la celda superior izquierda del intervalo especificado.
addWorksheetCustomProperty(key, value)	Agrega una nueva propiedad personalizada que se asigna a la clave proporcionada. Esto sobrescribe las propiedades personalizadas existentes con esa clave.
calculate(markAllDirty)	Calcula todas las celdas de una hoja de cálculo.
copy(positionType, relativeTo)	Copia una hoja de cálculo y la coloca en la posición especificada.
delete()	Elimina la hoja de cálculo del libro. Tenga en cuenta que si la visibilidad de la hoja de cálculo está establecida en "VeryHidden", se producirá un error en la operación de eliminación con una `InvalidOperation` excepción. Primero debe cambiar su visibilidad a oculta o visible antes de eliminarla.
enterTemporaryNamedSheetView()	Crea y activa una nueva vista de hoja temporal. Las vistas temporales se quitan al cerrar la aplicación, salir de la vista temporal con el método exit o cambiar a otra vista de hoja. También se puede acceder a la vista de hoja temporal con la cadena vacía (""), si existe la vista temporal.
exitActiveNamedSheetView()	Sale de la vista de hoja actualmente activa.
findAll(text, criteria)	Busca todas las repeticiones de la cadena especificada en función de los criterios especificados y las devuelve como un `RangeAreas` objeto, que comprende uno o varios intervalos rectangulares.
getActiveNamedSheetView()	Obtiene la vista de hoja actualmente activa de la hoja.
getAutoFilter()	Representa el `AutoFilter` objeto de la hoja de cálculo.
getCell(row, column)	Obtiene el `Range` objeto que contiene la celda única en función de los números de fila y columna. La celda puede estar fuera de los límites de su rango primario, siempre y cuando permanezca dentro de la cuadrícula de la hoja de cálculo.
getChart(name)	Obtiene un gráfico mediante su nombre. Si hay varias tablas con el mismo nombre, se devolverá la primera. Si el gráfico no existe, este método devuelve `undefined`.
getCharts()	Devuelve una colección de gráficos que forman parte de la hoja de cálculo.
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()	Devuelve una colección de todos los objetos Comments en la hoja de cálculo.
getCustomProperties()	Obtiene una colección de propiedades personalizadas de nivel de hoja de cálculo.
getEnableCalculation()	Determina si Excel debe recalcular la hoja de cálculo cuando sea necesario. True si Excel vuelve a calcular la hoja de cálculo cuando sea necesario. False si Excel no actualiza la hoja.
getFreezePanes()	Obtiene un objeto que se puede usar para manipular paneles inmovilizados en la hoja de cálculo.
getHorizontalPageBreaks()	Obtiene la colección de saltos de página horizontales de la hoja de cálculo. Esta colección solo contiene saltos de página manuales.
getId()	Devuelve un valor que identifica de forma única la hoja de cálculo de un libro determinado. El valor del identificador permanece igual, incluso cuando se cambia el nombre de la hoja de cálculo o cuando esta se mueve.
getName()	Nombre para mostrar de la hoja de cálculo. El nombre debe tener menos de 32 caracteres.
getNamedItem(name)	Obtiene un `NamedItem` objeto con su nombre. Si el objeto no existe, este método devuelve `undefined`.
getNamedSheetView(key)	Obtiene una vista de hoja con su nombre. Si el objeto de vista de hoja no existe, este método devuelve `undefined`.
getNamedSheetViews()	Devuelve una colección de vistas de hoja que están presentes en la hoja de cálculo.
getNames()	Colección de nombres en el ámbito de la hoja de cálculo actual.
getNext(visibleOnly)	Obtiene la hoja de cálculo que sigue a esta. Si no hay ninguna hoja de cálculo después de esta, este método devuelve `undefined`.
getPageLayout()	Obtiene el `PageLayout` objeto de la hoja de cálculo.
getPivotTable(name)	Obtiene una tabla dinámica por nombre. Si la tabla dinámica no existe, este método devuelve `undefined`.
getPivotTables()	Colección de tablas dinámicas que forman parte de la hoja de cálculo.
getPosition()	Posición de base cero de la hoja de cálculo dentro del libro.
getPrevious(visibleOnly)	Obtiene la hoja de cálculo que precede a esta. Si no hay hojas de cálculo anteriores, este método devuelve `undefined`.
getProtection()	Devuelve el objeto de protección de hoja de una hoja de cálculo.
getRange(address)	Obtiene el `Range` objeto , que representa un único bloque rectangular de celdas, especificado por la dirección o el nombre.
getRangeByIndexes(startRow, startColumn, rowCount, columnCount)	Obtiene el `Range` objeto que comienza en un índice de fila y un índice de columna determinados, y abarca un determinado número de filas y columnas.
getRanges(address)	Obtiene el `RangeAreas` objeto , que representa uno o varios bloques de intervalos rectangulares, especificados por la dirección o el nombre.
getShape(key)	Obtiene una forma con su nombre o identificador. Si el objeto shape no existe, este método devuelve `undefined`.
getShapes()	Devuelve la colección de todos los objetos Shape en la hoja de cálculo.
getShowGridlines()	Especifica si las líneas de cuadrícula son visibles para el usuario.
getShowHeadings()	Especifica si los encabezados son visibles para el usuario.
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()	Devuelve una colección de segmentaciones de datos que forman parte de la hoja de cálculo.
getStandardHeight()	Devuelve el ancho estándar (predeterminado) de todas las filas de la hoja de cálculo, en puntos.
getStandardWidth()	Especifica el ancho estándar (predeterminado) de todas las columnas de la hoja de cálculo. Una unidad de ancho de columna equivale al ancho de un carácter con el estilo Normal. En las fuentes proporcionales se utiliza el ancho del carácter 0 (cero).
getTabColor()	Color de pestaña de la hoja de cálculo. Al recuperar el color de la pestaña, si la hoja de cálculo es invisible, el valor será `null`. Si la hoja de cálculo está visible pero el color de la pestaña se establece en automático, se devolverá una cadena vacía. De lo contrario, la propiedad se establecerá en un color, en el formulario #RRGGBB (por ejemplo, "FFA500"). Al establecer el color, use una cadena vacía para establecer un color "auto" o un color real en caso contrario.
getTabId()	Devuelve un valor que representa esta hoja de cálculo que puede leer Open Office XML. Se trata de un valor entero, que es diferente de `worksheet.id` (que devuelve un identificador único global) y `worksheet.name` (que devuelve un valor como "Sheet1").
getTable(key)	Obtener una tabla por nombre o identificador. Si la tabla no existe, este método devuelve `undefined`.
getTables()	Colección de tablas que forman parte de la hoja de cálculo.
getUsedRange(valuesOnly)
getVerticalPageBreaks()	Obtiene la colección de saltos de página verticales de la hoja de cálculo. Esta colección solo contiene saltos de página manuales.
getVisibility()	Visibilidad de la hoja de cálculo.
getWorksheetCustomProperty(key)	Obtiene un objeto de propiedad personalizada mediante su clave, que no distingue mayúsculas de minúsculas. Si la propiedad personalizada no existe, este método devuelve `undefined`.
refreshAllPivotTables()	Actualiza todas las tablas dinámicas de la colección.
removeAllHorizontalPageBreaks()	Restablece todos los saltos de página manuales de la colección.
removeAllVerticalPageBreaks()	Restablece todos los saltos de página manuales de la colección.
replaceAll(text, replacement, criteria)	Busca y reemplaza la cadena especificada, según los criterios especificados dentro de la hoja de cálculo actual.
setEnableCalculation(enableCalculation)	Determina si Excel debe recalcular la hoja de cálculo cuando sea necesario. True si Excel vuelve a calcular la hoja de cálculo cuando sea necesario. False si Excel no actualiza la hoja.
setName(name)	Nombre para mostrar de la hoja de cálculo. El nombre debe tener menos de 32 caracteres.
setPosition(position)	Posición de base cero de la hoja de cálculo dentro del libro.
setShowGridlines(showGridlines)	Especifica si las líneas de cuadrícula son visibles para el usuario.
setShowHeadings(showHeadings)	Especifica si los encabezados son visibles para el usuario.
setStandardWidth(standardWidth)	Especifica el ancho estándar (predeterminado) de todas las columnas de la hoja de cálculo. Una unidad de ancho de columna equivale al ancho de un carácter con el estilo Normal. En las fuentes proporcionales se utiliza el ancho del carácter 0 (cero).
setTabColor(tabColor)	Color de pestaña de la hoja de cálculo. Al recuperar el color de la pestaña, si la hoja de cálculo es invisible, el valor será `null`. Si la hoja de cálculo está visible pero el color de la pestaña se establece en automático, se devolverá una cadena vacía. De lo contrario, la propiedad se establecerá en un color, en el formulario #RRGGBB (por ejemplo, "FFA500"). Al establecer el color, use una cadena vacía para establecer un color "auto" o un color real en caso contrario.
setVisibility(visibility)	Visibilidad de la hoja de cálculo.
showOutlineLevels(rowLevels, columnLevels)	Muestra los grupos de filas o columnas por sus niveles de esquema. Describe los grupos y resume una lista de datos de la hoja de cálculo. Los `rowLevels` parámetros y `columnLevels` especifican cuántos niveles del esquema se mostrarán. El intervalo de argumentos aceptable está comprendido entre 0 y 8. Un valor de 0 no cambia la presentación actual. Un valor mayor que el número actual de niveles muestra todos los niveles.

Detalles del método

activate()

Activa la hoja de cálculo en la interfaz de usuario de Excel.

activate(): void;

Devoluciones

void

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.`);
  }
}

addChart(type, sourceData, seriesBy)

Crea un nuevo gráfico.

addChart(
            type: ChartType,
            sourceData: Range,
            seriesBy?: ChartSeriesBy
        ): Chart;

Parámetros

type: ExcelScript.ChartType

Representa el tipo de un gráfico. Vea ExcelScript.ChartType para más información.

sourceData: ExcelScript.Range

Objeto Range correspondiente a los datos de origen.

seriesBy: ExcelScript.ChartSeriesBy

Opcional. Especifica la manera en que las columnas o las filas se usan como series de datos en el gráfico. Vea ExcelScript.ChartSeriesBy para más información.

Devoluciones

ExcelScript.Chart

Ejemplos

/**
 * This sample creates a column-clustered chart based on the current worksheet's data.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the data range.
  let range = selectedSheet.getUsedRange();

  // Insert a chart using the data on the current worksheet.
  let chart = selectedSheet.addChart(ExcelScript.ChartType.columnClustered, range);

  // Name the chart for easy access in other scripts.
  chart.setName("ColumnChart");
}

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

addGeometricShape(geometricShapeType)

Agrega una forma geométrica a la hoja de cálculo. Devuelve un Shape objeto que representa la nueva forma.

addGeometricShape(geometricShapeType: GeometricShapeType): Shape;

Parámetros

geometricShapeType: ExcelScript.GeometricShapeType

Representa el tipo de la forma geométrica. Vea ExcelScript.GeometricShapeType para más información.

Devoluciones

ExcelScript.Shape

Ejemplos

/**
 * This script creates a hexagon shape on the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();
  const hexagon: ExcelScript.Shape = 
    currentSheet.addGeometricShape(ExcelScript.GeometricShapeType.hexagon);
  
  // Set the hexagon size to 40x40 pixels.
  hexagon.setHeight(40);
  hexagon.setWidth(40);

  // Position the hexagon at [100,100] pixels.
  hexagon.setLeft(100);
  hexagon.setTop(100);
}

addGroup(values)

Agrupa un subconjunto de formas en la hoja de cálculo de esta colección. Devuelve un Shape objeto que representa el nuevo grupo de formas.

addGroup(values: Array<string | Shape>): Shape;

Parámetros

values: Array<string | ExcelScript.Shape>

Matriz de identificadores de forma u objetos de forma.

Devoluciones

ExcelScript.Shape

addHorizontalPageBreak(pageBreakRange)

Agrega un salto de página antes de la celda superior izquierda del intervalo especificado.

addHorizontalPageBreak(pageBreakRange: Range | string): PageBreak;

Parámetros

pageBreakRange: ExcelScript.Range | string

Intervalo inmediatamente después del salto de página que se va a agregar.

Devoluciones

ExcelScript.PageBreak

addImage(base64ImageString)

Crea una imagen de una cadena con codificación base64 y la agrega a la hoja de cálculo. Devuelve el Shape objeto que representa la nueva imagen.

addImage(base64ImageString: string): Shape;

Parámetros

base64ImageString: string

Cadena codificada en base64 que representa una imagen en formato JPEG o PNG.

Devoluciones

ExcelScript.Shape

Ejemplos

/**
 * This sample copies an image from a URL. 
 * This could be used to copy photos that a colleague stored in a shared folder to a related workbook.
 */
async function main(workbook: ExcelScript.Workbook) {
  // Fetch the image from a URL.
  const link = "https://raw.githubusercontent.com/OfficeDev/office-scripts-docs/master/docs/images/git-octocat.png";
  const response = await fetch(link);

  // Store the response as an ArrayBuffer, since it is a raw image file.
  const data = await response.arrayBuffer();

  // Convert the image data into a base64-encoded string.
  const image = convertToBase64(data);

  // Add the image to the current worksheet.
  workbook.getActiveWorksheet().addImage(image);
}

/**
 * Converts an ArrayBuffer containing a .png image into a base64-encoded string.
 */
function convertToBase64(input: ArrayBuffer) {
  const uInt8Array = new Uint8Array(input);
  const count = uInt8Array.length;

  // Allocate the necessary space up front.
  const charCodeArray = new Array<string>(count) 
  
  // Convert every entry in the array to a character.
  for (let i = count; i >= 0; i--) { 
    charCodeArray[i] = String.fromCharCode(uInt8Array[i]);
  }

  // Convert the characters to base64.
  const base64 = btoa(charCodeArray.join(''));
  return base64;
}

addLine(startLeft, startTop, endLeft, endTop, connectorType)

Agrega una línea a la hoja de cálculo. Devuelve un Shape objeto que representa la nueva línea.

addLine(
            startLeft: number,
            startTop: number,
            endLeft: number,
            endTop: number,
            connectorType?: ConnectorType
        ): Shape;

Parámetros

startLeft: number

Distancia, en puntos, desde el principio de la línea hasta el lado izquierdo de la hoja de cálculo.

startTop: number

Distancia, en puntos, desde el principio de la línea hasta la parte superior de la hoja de cálculo.

endLeft: number

Distancia, en puntos, desde el final de la línea a la izquierda de la hoja de cálculo.

endTop: number

Distancia, en puntos, desde el final de la línea hasta la parte superior de la hoja de cálculo.

connectorType: ExcelScript.ConnectorType

Representa el tipo de conector. Vea ExcelScript.ConnectorType para más información.

Devoluciones

ExcelScript.Shape

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

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

addNamedSheetView(name)

Crea una nueva vista de hoja con el nombre especificado.

addNamedSheetView(name: string): NamedSheetView;

Parámetros

name: string

Nombre de la vista de hoja que se va a crear. Produce un error cuando el nombre proporcionado ya existe, está vacío o es un nombre reservado por la hoja de cálculo.

Devoluciones

ExcelScript.NamedSheetView

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 a new worksheet.
 * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
 */
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];

  // Add the PivotTable to a new worksheet.
  let newSheet = workbook.addWorksheet("Pivot");
  let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");

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

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

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 on the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first PivotTable from the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const pivot = currentSheet.getPivotTables()[0];

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

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

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

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 creates a table from the current worksheet's used range, then sorts it based on the first column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Create a table with the used cells.
  let usedRange = selectedSheet.getUsedRange();
  let newTable = selectedSheet.addTable(usedRange, true);

  // Sort the table using the first column.
  newTable.getSort().apply([{ key: 0, ascending: true }]);
}

addTextBox(text)

Agrega un cuadro de texto a la hoja de cálculo con el texto proporcionado como contenido. Devuelve un Shape objeto que representa el nuevo cuadro de texto.

addTextBox(text?: string): Shape;

Parámetros

text: string

Representa el texto que se mostrará en el cuadro de texto creado.

Devoluciones

ExcelScript.Shape

addVerticalPageBreak(pageBreakRange)

Agrega un salto de página antes de la celda superior izquierda del intervalo especificado.

addVerticalPageBreak(pageBreakRange: Range | string): PageBreak;

Parámetros

pageBreakRange: ExcelScript.Range | string

Intervalo inmediatamente después del salto de página que se va a agregar.

Devoluciones

ExcelScript.PageBreak

addWorksheetCustomProperty(key, value)

Agrega una nueva propiedad personalizada que se asigna a la clave proporcionada. Esto sobrescribe las propiedades personalizadas existentes con esa clave.

addWorksheetCustomProperty(
            key: string,
            value: string
        ): WorksheetCustomProperty;

Parámetros

key: string

Clave que identifica el objeto de propiedad personalizada. No distingue mayúsculas de minúsculas. La clave está limitada a 255 caracteres (los valores más grandes provocarán un InvalidArgument error).

value: string

Valor de esta propiedad personalizada.

Devoluciones

ExcelScript.WorksheetCustomProperty

calculate(markAllDirty)

Calcula todas las celdas de una hoja de cálculo.

calculate(markAllDirty: boolean): void;

Parámetros

markAllDirty: boolean

True, para marcar todo como sucio.

Devoluciones

void

copy(positionType, relativeTo)

Copia una hoja de cálculo y la coloca en la posición especificada.

copy(
            positionType?: WorksheetPositionType,
            relativeTo?: Worksheet
        ): Worksheet;

Parámetros

positionType: ExcelScript.WorksheetPositionType

Ubicación del libro para colocar la hoja de cálculo recién creada. El valor predeterminado es "None", que inserta la hoja de cálculo al principio de la hoja de cálculo.

relativeTo: ExcelScript.Worksheet

Hoja de cálculo existente que determina la posición de la hoja de cálculo recién creada. Esto solo es necesario si positionType es "Antes" o "Después".

Devoluciones

ExcelScript.Worksheet

Ejemplos

/**
 * This script duplicates a worksheet named "Template". 
 * The new worksheet is added after the template.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the worksheet named "Template".
  let template = workbook.getWorksheet("Template");

  // Copy the worksheet.
  let newSheet = template.copy(
    ExcelScript.WorksheetPositionType.after,
    template
  );

  // Name the worksheet using the current date.
  let date = new Date(Date.now());
  newSheet.setName(`${date.toDateString()}`);
}

delete()

Elimina la hoja de cálculo del libro. Tenga en cuenta que si la visibilidad de la hoja de cálculo está establecida en "VeryHidden", se producirá un error en la operación de eliminación con una InvalidOperation excepción. Primero debe cambiar su visibilidad a oculta o visible antes de eliminarla.

delete(): void;

Devoluciones

void

Ejemplos

/**
 * The following scripts removes the first worksheet in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first worksheet.
  let sheet = workbook.getWorksheets()[0];

  // Remove that worksheet from the workbook.
  sheet.delete();
}

enterTemporaryNamedSheetView()

Crea y activa una nueva vista de hoja temporal. Las vistas temporales se quitan al cerrar la aplicación, salir de la vista temporal con el método exit o cambiar a otra vista de hoja. También se puede acceder a la vista de hoja temporal con la cadena vacía (""), si existe la vista temporal.

enterTemporaryNamedSheetView(): NamedSheetView;

Devoluciones

ExcelScript.NamedSheetView

exitActiveNamedSheetView()

Sale de la vista de hoja actualmente activa.

exitActiveNamedSheetView(): void;

Devoluciones

void

findAll(text, criteria)

Busca todas las repeticiones de la cadena especificada en función de los criterios especificados y las devuelve como un RangeAreas objeto, que comprende uno o varios intervalos rectangulares.

findAll(text: string, criteria: WorksheetSearchCriteria): RangeAreas;

Parámetros

text: string

Cadena que se va a buscar.

criteria: ExcelScript.WorksheetSearchCriteria

Criterios de búsqueda adicionales, incluido si la búsqueda debe coincidir con toda la celda o distinguir entre mayúsculas y minúsculas.

Devoluciones

ExcelScript.RangeAreas

Ejemplos

/**
 * This script searches through a worksheet and finds cells containing "No". 
 * Those cells are filled with the color red.
 * Use Range.find instead of Worksheet.findAll when you want to limit the search to a specific range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current, active worksheet.
  let worksheet = workbook.getActiveWorksheet();
  let noCells = worksheet.findAll("No", { completeMatch: true });

  // Set the fill color to red.
  noCells.getFormat().getFill().setColor("red");
}

getActiveNamedSheetView()

Obtiene la vista de hoja actualmente activa de la hoja.

getActiveNamedSheetView(): NamedSheetView;

Devoluciones

ExcelScript.NamedSheetView

getAutoFilter()

Representa el AutoFilter objeto de la hoja de cálculo.

getAutoFilter(): AutoFilter;

Devoluciones

ExcelScript.AutoFilter

Ejemplos

/**
 * This script creates an autoFilter on the worksheet that filters out rows based on column values. 
 * The autoFilter filters to only include rows that have a value in column D in the top 10 percentile 
 * (of column D values).
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();
  const dataRange = currentSheet.getUsedRange();

  // Add a filter that will only show the rows with the top 10% of values in column D
  // (index 3, assuming the used range spans from at least A:D).
  currentSheet.getAutoFilter().apply(dataRange, 3, {
    criterion1: "10",
    filterOn: ExcelScript.FilterOn.topPercent
  });
}

getCell(row, column)

Obtiene el Range objeto que contiene la celda única en función de los números de fila y columna. La celda puede estar fuera de los límites de su rango primario, siempre y cuando permanezca dentro de la cuadrícula de la hoja de cálculo.

getCell(row: number, column: number): Range;

Parámetros

row: number

Número de fila de la celda que se va a recuperar. Indizado con cero.

column: number

Número de columna de la celda que se va a recuperar. Indizado con cero.

Devoluciones

ExcelScript.Range

getChart(name)

Obtiene un gráfico mediante su nombre. Si hay varias tablas con el mismo nombre, se devolverá la primera. Si el gráfico no existe, este método devuelve undefined.

getChart(name: string): Chart | undefined;

Parámetros

name: string

Nombre del gráfico que se va a recuperar.

Devoluciones

ExcelScript.Chart | undefined

Ejemplos

/**
 * This sample moves an existing chart to a specific place on the worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();
  
  // Get an existing chart named "ColumnChart".
  let chart = selectedSheet.getChart("ColumnChart");

  // Place the chart over the range "F1:L13".
  chart.setPosition("F1", "L13");
}

getCharts()

Devuelve una colección de gráficos que forman parte de la hoja de cálculo.

getCharts(): Chart[];

Devoluciones

ExcelScript.Chart[]

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()

Devuelve una colección de todos los objetos Comments en la hoja de cálculo.

getComments(): Comment[];

Devoluciones

ExcelScript.Comment[]

getCustomProperties()

Obtiene una colección de propiedades personalizadas de nivel de hoja de cálculo.

getCustomProperties(): WorksheetCustomProperty[];

Devoluciones

ExcelScript.WorksheetCustomProperty[]

getEnableCalculation()

Determina si Excel debe recalcular la hoja de cálculo cuando sea necesario. True si Excel vuelve a calcular la hoja de cálculo cuando sea necesario. False si Excel no actualiza la hoja.

getEnableCalculation(): boolean;

Devoluciones

boolean

getFreezePanes()

Obtiene un objeto que se puede usar para manipular paneles inmovilizados en la hoja de cálculo.

getFreezePanes(): WorksheetFreezePanes;

Devoluciones

ExcelScript.WorksheetFreezePanes

getHorizontalPageBreaks()

Obtiene la colección de saltos de página horizontales de la hoja de cálculo. Esta colección solo contiene saltos de página manuales.

getHorizontalPageBreaks(): PageBreak[];

Devoluciones

ExcelScript.PageBreak[]

getId()

Devuelve un valor que identifica de forma única la hoja de cálculo de un libro determinado. El valor del identificador permanece igual, incluso cuando se cambia el nombre de la hoja de cálculo o cuando esta se mueve.

getId(): string;

Devoluciones

string

getName()

Nombre para mostrar de la hoja de cálculo. El nombre debe tener menos de 32 caracteres.

getName(): string;

Devoluciones

string

Ejemplos

/**
 * This sample gets all the worksheet names in the workbook.
 * It then logs those names to the console.
 */
function main(workbook: ExcelScript.Workbook) {
    // Create an array to hold the worksheet names.
    let worksheetNames = [];

    // Iterate over the worksheet collection in the workbook.
    for (let worksheet of workbook.getWorksheets()) {
        worksheetNames.push(worksheet.getName());
    }

    // Log the array of worksheet names.
    console.log(worksheetNames);
}

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

getNamedSheetView(key)

Obtiene una vista de hoja con su nombre. Si el objeto de vista de hoja no existe, este método devuelve undefined.

getNamedSheetView(key: string): NamedSheetView | undefined;

Parámetros

key: string

Nombre que distingue mayúsculas de minúsculas de la vista de hoja. Use la cadena vacía ("") para obtener la vista de hoja temporal, si existe la vista temporal.

Devoluciones

ExcelScript.NamedSheetView | undefined

getNamedSheetViews()

Devuelve una colección de vistas de hoja que están presentes en la hoja de cálculo.

getNamedSheetViews(): NamedSheetView[];

Devoluciones

ExcelScript.NamedSheetView[]

getNames()

Colección de nombres en el ámbito de la hoja de cálculo actual.

getNames(): NamedItem[];

Devoluciones

ExcelScript.NamedItem[]

getNext(visibleOnly)

Obtiene la hoja de cálculo que sigue a esta. Si no hay ninguna hoja de cálculo después de esta, este método devuelve undefined.

getNext(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

getPageLayout()

Obtiene el PageLayout objeto de la hoja de cálculo.

getPageLayout(): PageLayout;

Devoluciones

ExcelScript.PageLayout

Ejemplos

/**
 * This script sets the printing orientation for the entire workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Go to each worksheet so the print settings are consistent.
  workbook.getWorksheets().forEach((sheet) => {
    const pageLayout = sheet.getPageLayout();

    // Print every page with a landscape orientation.
    pageLayout.setOrientation(ExcelScript.PageOrientation.landscape);
  });
}

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()

Colección de tablas dinámicas que forman parte de la hoja de cálculo.

getPivotTables(): PivotTable[];

Devoluciones

ExcelScript.PivotTable[]

getPosition()

Posición de base cero de la hoja de cálculo dentro del libro.

getPosition(): number;

Devoluciones

number

getPrevious(visibleOnly)

Obtiene la hoja de cálculo que precede a esta. Si no hay hojas de cálculo anteriores, este método devuelve undefined.

getPrevious(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

getProtection()

Devuelve el objeto de protección de hoja de una hoja de cálculo.

getProtection(): WorksheetProtection;

Devoluciones

ExcelScript.WorksheetProtection

Ejemplos

/**
 * This script protects cells from being selected on the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the protection settings for the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const sheetProtection = currentSheet.getProtection();

  // Create a new WorksheetProtectionOptions object with the selectionMode property set to `none`.
  let protectionOptions : ExcelScript.WorksheetProtectionOptions = {
    selectionMode: ExcelScript.ProtectionSelectionMode.none
  }

  // Apply the given protection options.
  sheetProtection.protect(protectionOptions);
}

getRange(address)

Obtiene el Range objeto , que representa un único bloque rectangular de celdas, especificado por la dirección o el nombre.

getRange(address?: string): Range;

Parámetros

address: string

Opcional. Cadena que representa la dirección o el nombre del intervalo. Por ejemplo, "A1:B2". Si no se especifica, se devuelve todo el intervalo de la hoja de cálculo.

Devoluciones

ExcelScript.Range

Ejemplos

/**
 * This sample reads the value of A1 and prints it to the console.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the value of cell A1.
  let range = selectedSheet.getRange("A1");
  
  // Print the value of A1.
  console.log(range.getValue());
}

getRangeByIndexes(startRow, startColumn, rowCount, columnCount)

Obtiene el Range objeto que comienza en un índice de fila y un índice de columna determinados, y abarca un determinado número de filas y columnas.

getRangeByIndexes(
            startRow: number,
            startColumn: number,
            rowCount: number,
            columnCount: number
        ): Range;

Parámetros

startRow: number

Fila de inicio (indizada en cero).

startColumn: number

Columna De inicio (indizada en cero).

rowCount: number

Número de filas que se van a incluir en el intervalo.

columnCount: number

Número de columnas que se van a incluir en el intervalo.

Devoluciones

ExcelScript.Range

getRanges(address)

Obtiene el RangeAreas objeto , que representa uno o varios bloques de intervalos rectangulares, especificados por la dirección o el nombre.

getRanges(address?: string): RangeAreas;

Parámetros

address: string

Opcional. Cadena que contiene las direcciones o nombres separados por comas o punto y coma de los intervalos individuales. Por ejemplo, "A1:B2, A5:B5" o "A1:B2; A5:B5". Si no se especifica, se devuelve un RangeAreas objeto para toda la hoja de cálculo.

Devoluciones

ExcelScript.RangeAreas

getShape(key)

Obtiene una forma con su nombre o identificador. Si el objeto shape no existe, este método devuelve undefined.

getShape(key: string): Shape | undefined;

Parámetros

key: string

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

Devoluciones

ExcelScript.Shape | undefined

getShapes()

Devuelve la colección de todos los objetos Shape en la hoja de cálculo.

getShapes(): Shape[];

Devoluciones

ExcelScript.Shape[]

getShowGridlines()

Especifica si las líneas de cuadrícula son visibles para el usuario.

getShowGridlines(): boolean;

Devoluciones

boolean

getShowHeadings()

Especifica si los encabezados son visibles para el usuario.

getShowHeadings(): boolean;

Devoluciones

boolean

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()

Devuelve una colección de segmentaciones de datos que forman parte de la hoja de cálculo.

getSlicers(): Slicer[];

Devoluciones

ExcelScript.Slicer[]

getStandardHeight()

Devuelve el ancho estándar (predeterminado) de todas las filas de la hoja de cálculo, en puntos.

getStandardHeight(): number;

Devoluciones

number

getStandardWidth()

Especifica el ancho estándar (predeterminado) de todas las columnas de la hoja de cálculo. Una unidad de ancho de columna equivale al ancho de un carácter con el estilo Normal. En las fuentes proporcionales se utiliza el ancho del carácter 0 (cero).

getStandardWidth(): number;

Devoluciones

number

getTabColor()

Color de pestaña de la hoja de cálculo. Al recuperar el color de la pestaña, si la hoja de cálculo es invisible, el valor será null. Si la hoja de cálculo está visible pero el color de la pestaña se establece en automático, se devolverá una cadena vacía. De lo contrario, la propiedad se establecerá en un color, en el formulario #RRGGBB (por ejemplo, "FFA500"). Al establecer el color, use una cadena vacía para establecer un color "auto" o un color real en caso contrario.

getTabColor(): string;

Devoluciones

string

getTabId()

Devuelve un valor que representa esta hoja de cálculo que puede leer Open Office XML. Se trata de un valor entero, que es diferente de worksheet.id (que devuelve un identificador único global) y worksheet.name (que devuelve un valor como "Sheet1").

getTabId(): number;

Devoluciones

number

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()

Colección de tablas que forman parte de la hoja de cálculo.

getTables(): Table[];

Devoluciones

ExcelScript.Table[]

getUsedRange(valuesOnly)

getUsedRange(valuesOnly?: boolean): Range;

Parámetros

valuesOnly: boolean

Opcional. Solo tiene en cuenta las celdas con valores como celdas usadas.

Devoluciones

ExcelScript.Range

getVerticalPageBreaks()

Obtiene la colección de saltos de página verticales de la hoja de cálculo. Esta colección solo contiene saltos de página manuales.

getVerticalPageBreaks(): PageBreak[];

Devoluciones

ExcelScript.PageBreak[]

getVisibility()

Visibilidad de la hoja de cálculo.

getVisibility(): SheetVisibility;

Devoluciones

ExcelScript.SheetVisibility

getWorksheetCustomProperty(key)

Obtiene un objeto de propiedad personalizada mediante su clave, que no distingue mayúsculas de minúsculas. Si la propiedad personalizada no existe, este método devuelve undefined.

getWorksheetCustomProperty(
            key: string
        ): WorksheetCustomProperty | undefined;

Parámetros

key: string

Clave que identifica el objeto de propiedad personalizada. No distingue mayúsculas de minúsculas.

Devoluciones

ExcelScript.WorksheetCustomProperty | undefined

refreshAllPivotTables()

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

refreshAllPivotTables(): void;

Devoluciones

void

removeAllHorizontalPageBreaks()

Restablece todos los saltos de página manuales de la colección.

removeAllHorizontalPageBreaks(): void;

Devoluciones

void

removeAllVerticalPageBreaks()

Restablece todos los saltos de página manuales de la colección.

removeAllVerticalPageBreaks(): void;

Devoluciones

void

replaceAll(text, replacement, criteria)

Busca y reemplaza la cadena especificada, según los criterios especificados dentro de la hoja de cálculo actual.

replaceAll(
            text: string,
            replacement: string,
            criteria: ReplaceCriteria
        ): number;

Parámetros

text: string

Cadena que se va a buscar.

replacement: string

Cadena que reemplaza a la cadena original.

criteria: ExcelScript.ReplaceCriteria

Criterios de reemplazo adicionales.

Devoluciones

number

setEnableCalculation(enableCalculation)

Determina si Excel debe recalcular la hoja de cálculo cuando sea necesario. True si Excel vuelve a calcular la hoja de cálculo cuando sea necesario. False si Excel no actualiza la hoja.

setEnableCalculation(enableCalculation: boolean): void;

Parámetros

enableCalculation: boolean

Devoluciones

void

setName(name)

Nombre para mostrar de la hoja de cálculo. El nombre debe tener menos de 32 caracteres.

setName(name: string): void;

Parámetros

name: string

Devoluciones

void

Ejemplos

/**
 * This sample renames a worksheet from "Sheet1" to "SALES".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get a worksheet named "Sheet1".
  const sheet = workbook.getWorksheet('Sheet1'); 

  // Set its name to SALES.
  sheet.setName('SALES');
}

setPosition(position)

Posición de base cero de la hoja de cálculo dentro del libro.

setPosition(position: number): void;

Parámetros

position: number

Devoluciones

void

Ejemplos

/**
 * This sample sets the worksheet named "SALES" as the first sheet in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get a worksheet named "SALES".
  const sheet = workbook.getWorksheet('SALES'); 
  // Position the worksheet at the beginning of the workbook.
  sheet.setPosition(0);
}

setShowGridlines(showGridlines)

Especifica si las líneas de cuadrícula son visibles para el usuario.

setShowGridlines(showGridlines: boolean): void;

Parámetros

showGridlines: boolean

Devoluciones

void

setShowHeadings(showHeadings)

Especifica si los encabezados son visibles para el usuario.

setShowHeadings(showHeadings: boolean): void;

Parámetros

showHeadings: boolean

Devoluciones

void

setStandardWidth(standardWidth)

setStandardWidth(standardWidth: number): void;

Parámetros

standardWidth: number

Devoluciones

void

setTabColor(tabColor)

setTabColor(tabColor: string): void;

Parámetros

tabColor: string

Devoluciones

void

Ejemplos

/**
 * This script sets the tab color of every worksheet in the workbook to red.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get all the worksheets in the workbook. 
  let sheets = workbook.getWorksheets();
  
  // Set the tab color of each worksheet to a random color.
  for (let sheet of sheets) {    
    // Set the color of the current worksheet's tab to red.
    sheet.setTabColor("red");
  }
}

setVisibility(visibility)

Visibilidad de la hoja de cálculo.

setVisibility(visibility: SheetVisibility): void;

Parámetros

visibility: ExcelScript.SheetVisibility

Devoluciones

void

Ejemplos

/**
 * This script unhides all the worksheets in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Iterate over each worksheet.
  workbook.getWorksheets().forEach((worksheet) => {
    // Set the worksheet visibility to visible.
    worksheet.setVisibility(ExcelScript.SheetVisibility.visible);
  });
}

showOutlineLevels(rowLevels, columnLevels)

Muestra los grupos de filas o columnas por sus niveles de esquema. Describe los grupos y resume una lista de datos de la hoja de cálculo. Los rowLevels parámetros y columnLevels especifican cuántos niveles del esquema se mostrarán. El intervalo de argumentos aceptable está comprendido entre 0 y 8. Un valor de 0 no cambia la presentación actual. Un valor mayor que el número actual de niveles muestra todos los niveles.

showOutlineLevels(rowLevels: number, columnLevels: number): void;

Parámetros

rowLevels: number

Número de niveles de fila de un esquema que se van a mostrar.

columnLevels: number

Número de niveles de columna de un esquema que se va a mostrar.

Devoluciones

void

Compartir a través de

ExcelScript.Worksheet interface

Comentarios

Ejemplos

Métodos

Detalles del método

activate()

Devoluciones

Ejemplos

addChart(type, sourceData, seriesBy)

Parámetros

Devoluciones

Ejemplos

addComment(cellAddress, content, contentType)

Parámetros

Devoluciones

addGeometricShape(geometricShapeType)

Parámetros

Devoluciones

Ejemplos

addGroup(values)

Parámetros

Devoluciones

addHorizontalPageBreak(pageBreakRange)

Parámetros

Devoluciones

addImage(base64ImageString)

Parámetros

Devoluciones

Ejemplos

addLine(startLeft, startTop, endLeft, endTop, connectorType)

Parámetros

Devoluciones

addNamedItem(name, reference, comment)

Parámetros

Devoluciones

addNamedItemFormulaLocal(name, formula, comment)

Parámetros

Devoluciones

addNamedSheetView(name)

Parámetros

Devoluciones

addPivotTable(name, source, destination)

Parámetros

Devoluciones

Ejemplos

addSlicer(slicerSource, sourceField, slicerDestination)

Parámetros

Devoluciones

Ejemplos

addTable(address, hasHeaders)

Parámetros

Devoluciones

Ejemplos

addTextBox(text)

Parámetros

Devoluciones

addVerticalPageBreak(pageBreakRange)

Parámetros

Devoluciones

addWorksheetCustomProperty(key, value)

Parámetros

Devoluciones

calculate(markAllDirty)

Parámetros

Devoluciones

copy(positionType, relativeTo)

Parámetros

Devoluciones

Ejemplos

delete()

Devoluciones

Ejemplos

enterTemporaryNamedSheetView()

Devoluciones

exitActiveNamedSheetView()

Devoluciones

findAll(text, criteria)

Parámetros

Devoluciones