ExcelScript.RangeView interface

Paquete:

ExcelScript

RangeView representa un conjunto de celdas visibles del intervalo primario.

Comentarios

Ejemplos

/**
 * This script copies values and formatting from the 
 * visible range of a table in Sheet1 into Sheet2.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the filtered data from Sheet1.
  const currentSheet = workbook.getWorksheet("Sheet1");
  const table = currentSheet.getTables()[0];
  const visibleTableRange: ExcelScript.RangeView = table.getRange().getVisibleView();
  const source = currentSheet.getRanges(visibleTableRange.getCellAddresses().toString());

  // Copy the data into the other sheet.
  const otherSheet = workbook.getWorksheet("Sheet2");
  const otherRangeCorner = otherSheet.getRange("A1");
  otherRangeCorner.copyFrom(source, ExcelScript.RangeCopyType.all);
}

Métodos

getCellAddresses()	Representa las direcciones de celda de RangeView.
getColumnCount()	Número de columnas visibles.
getFormulas()	Representa la fórmula en notación de estilo A1. Si una celda no tiene ninguna fórmula, su valor se devuelve en su lugar.
getFormulasLocal()	Representa la fórmula en notación de estilo A1, en el idioma del usuario y en la configuración regional del formato numérico. Por ejemplo, la fórmula "=SUM(A1, 1.5)" en inglés se convertiría en "=SUMME(A1; 1,5)" en alemán. Si una celda no tiene ninguna fórmula, su valor se devuelve en su lugar.
getFormulasR1C1()	Representa la fórmula en notación de estilo R1C1. Si una celda no tiene ninguna fórmula, su valor se devuelve en su lugar.
getIndex()	Devuelve un valor que representa el índice de RangeView.
getNumberFormat()	Representa el código de formato numérico de Excel para la celda especificada.
getRange()	Obtiene el intervalo primario asociado al actual RangeView.
getRowCount()	Número de filas visibles.
getRows()	Representa una colección de vistas de intervalo asociadas a este.
getText()	Valores de texto del intervalo especificado. El valor Text no dependerá del ancho de la celda. La sustitución del signo # que tiene lugar en la interfaz de usuario de Excel no afectará al valor de texto devuelto por la API.
getValues()	Representa los valores sin formato de la vista del intervalo especificado. Los datos devueltos pueden ser de tipo cadena, número o booleano. Las celdas que contienen un error devolverán la cadena de error.
getValueTypes()	Representa el tipo de datos de cada celda.
setFormulas(formulas)	Representa la fórmula en notación de estilo A1. Si una celda no tiene ninguna fórmula, su valor se devuelve en su lugar.
setFormulasLocal(formulasLocal)	Representa la fórmula en notación de estilo A1, en el idioma del usuario y en la configuración regional del formato numérico. Por ejemplo, la fórmula "=SUM(A1, 1.5)" en inglés se convertiría en "=SUMME(A1; 1,5)" en alemán. Si una celda no tiene ninguna fórmula, su valor se devuelve en su lugar.
setFormulasR1C1(formulasR1C1)	Representa la fórmula en notación de estilo R1C1. Si una celda no tiene ninguna fórmula, su valor se devuelve en su lugar.
setNumberFormat(numberFormat)	Representa el código de formato numérico de Excel para la celda especificada.
setValues(values)	Representa los valores sin formato de la vista del intervalo especificado. Los datos devueltos pueden ser de tipo cadena, número o booleano. Las celdas que contienen un error devolverán la cadena de error.

Detalles del método

getCellAddresses()

Representa las direcciones de celda de RangeView.

getCellAddresses(): string[][];

Devoluciones

string[][]

Ejemplos

/**
 * This script copies values and formatting from the 
 * visible range of a table in Sheet1 into Sheet2.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the filtered data from Sheet1.
  const currentSheet = workbook.getWorksheet("Sheet1");
  const table = currentSheet.getTables()[0];
  const visibleTableRange: ExcelScript.RangeView = table.getRange().getVisibleView();
  const source = currentSheet.getRanges(visibleTableRange.getCellAddresses().toString());

  // Copy the data into the other sheet.
  const otherSheet = workbook.getWorksheet("Sheet2");
  const otherRangeCorner = otherSheet.getRange("A1");
  otherRangeCorner.copyFrom(source, ExcelScript.RangeCopyType.all);
}

getColumnCount()

Número de columnas visibles.

getColumnCount(): number;

Devoluciones

number

getFormulas()

Representa la fórmula en notación de estilo A1. Si una celda no tiene ninguna fórmula, su valor se devuelve en su lugar.

getFormulas(): string[][];

Devoluciones

string[][]

getFormulasLocal()

Representa la fórmula en notación de estilo A1, en el idioma del usuario y en la configuración regional del formato numérico. Por ejemplo, la fórmula "=SUM(A1, 1.5)" en inglés se convertiría en "=SUMME(A1; 1,5)" en alemán. Si una celda no tiene ninguna fórmula, su valor se devuelve en su lugar.

getFormulasLocal(): string[][];

Devoluciones

string[][]

getFormulasR1C1()

Representa la fórmula en notación de estilo R1C1. Si una celda no tiene ninguna fórmula, su valor se devuelve en su lugar.

getFormulasR1C1(): string[][];

Devoluciones

string[][]

getIndex()

Devuelve un valor que representa el índice de RangeView.

getIndex(): number;

Devoluciones

number

getNumberFormat()

Representa el código de formato numérico de Excel para la celda especificada.

getNumberFormat(): string[][];

Devoluciones

string[][]

getRange()

Obtiene el intervalo primario asociado al actual RangeView.

getRange(): Range;

Devoluciones

ExcelScript.Range

getRowCount()

Número de filas visibles.

getRowCount(): number;

Devoluciones

number

getRows()

Representa una colección de vistas de intervalo asociadas a este.

getRows(): RangeView[];

Devoluciones

ExcelScript.RangeView[]

getText()

Valores de texto del intervalo especificado. El valor Text no dependerá del ancho de la celda. La sustitución del signo # que tiene lugar en la interfaz de usuario de Excel no afectará al valor de texto devuelto por la API.

getText(): string[][];

Devoluciones

string[][]

getValues()

Representa los valores sin formato de la vista del intervalo especificado. Los datos devueltos pueden ser de tipo cadena, número o booleano. Las celdas que contienen un error devolverán la cadena de error.

getValues(): (string | number | boolean)[][];

Devoluciones

(string | number | boolean)[][]

getValueTypes()

Representa el tipo de datos de cada celda.

getValueTypes(): RangeValueType[][];

Devoluciones

ExcelScript.RangeValueType[][]

setFormulas(formulas)

Representa la fórmula en notación de estilo A1. Si una celda no tiene ninguna fórmula, su valor se devuelve en su lugar.

setFormulas(formulas: string[][]): void;

Parámetros

formulas

string[][]

Devoluciones

void

setFormulasLocal(formulasLocal)

Representa la fórmula en notación de estilo A1, en el idioma del usuario y en la configuración regional del formato numérico. Por ejemplo, la fórmula "=SUM(A1, 1.5)" en inglés se convertiría en "=SUMME(A1; 1,5)" en alemán. Si una celda no tiene ninguna fórmula, su valor se devuelve en su lugar.

setFormulasLocal(formulasLocal: string[][]): void;

Parámetros

formulasLocal

string[][]

Devoluciones

void

setFormulasR1C1(formulasR1C1)

Representa la fórmula en notación de estilo R1C1. Si una celda no tiene ninguna fórmula, su valor se devuelve en su lugar.

setFormulasR1C1(formulasR1C1: string[][]): void;

Parámetros

formulasR1C1

string[][]

Devoluciones

void

setNumberFormat(numberFormat)

Representa el código de formato numérico de Excel para la celda especificada.

setNumberFormat(numberFormat: string[][]): void;

Parámetros

numberFormat

string[][]

Devoluciones

void

setValues(values)

Representa los valores sin formato de la vista del intervalo especificado. Los datos devueltos pueden ser de tipo cadena, número o booleano. Las celdas que contienen un error devolverán la cadena de error.

setValues(values: (string | number | boolean)[][]): void;

Parámetros

values

(string | number | boolean)[][]

Devoluciones

void