ExcelScript.RangeView interface

Пакет:

ExcelScript

Объект rangeView представляет набор видимых ячеек в родительском диапазоне.

Комментарии

Примеры

/**
 * 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);
}

Методы

getCellAddresses()	Представляет адреса RangeViewячеек объекта .
getColumnCount()	Количество видимых столбцов.
getFormulas()	Представляет формулу в формате A1. Если в ячейке нет формулы, возвращается ее значение.
getFormulasLocal()	Представляет формулу в нотации стиля A1 на языке пользователя и в соответствии с его языковым стандартом. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке. Если в ячейке нет формулы, возвращается ее значение.
getFormulasR1C1()	Представляет формулу в формате R1C1. Если в ячейке нет формулы, возвращается ее значение.
getIndex()	Возвращает значение, представляющее индекс RangeViewобъекта .
getNumberFormat()	Представляет код в числовом формате Excel для данной ячейки.
getRange()	Возвращает родительский диапазон, связанный с текущим RangeView.
getRowCount()	Количество видимых строк.
getRows()	Представляет коллекцию видимых ячеек в диапазоне, сопоставленных с указанным диапазоном.
getText()	Текстовые значения указанного диапазона. Текстовое значение не зависит от ширины ячейки. Замена знака #, которая происходит в пользовательском интерфейсе Excel, не повлияет на текстовое значение, возвращаемое API-интерфейсом.
getValues()	Представляет необработанные значения указанного объекта rangeView. Могут возвращаться строковые и числовые данные, а также логические значения. Ячейки, содержащие ошибку, вернут строку ошибки.
getValueTypes()	Представляет тип данных каждой ячейки.
setFormulas(formulas)	Представляет формулу в формате A1. Если в ячейке нет формулы, возвращается ее значение.
setFormulasLocal(formulasLocal)	Представляет формулу в нотации стиля A1 на языке пользователя и в соответствии с его языковым стандартом. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке. Если в ячейке нет формулы, возвращается ее значение.
setFormulasR1C1(formulasR1C1)	Представляет формулу в формате R1C1. Если в ячейке нет формулы, возвращается ее значение.
setNumberFormat(numberFormat)	Представляет код в числовом формате Excel для данной ячейки.
setValues(values)	Представляет необработанные значения указанного объекта rangeView. Могут возвращаться строковые и числовые данные, а также логические значения. Ячейки, содержащие ошибку, вернут строку ошибки.

Сведения о методе

getCellAddresses()

Представляет адреса RangeViewячеек объекта .

getCellAddresses(): string[][];

Возвращаемое значение

string[][]

Примеры

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

Количество видимых столбцов.

getColumnCount(): number;

Возвращаемое значение

number

getFormulas()

Представляет формулу в формате A1. Если в ячейке нет формулы, возвращается ее значение.

getFormulas(): string[][];

Возвращаемое значение

string[][]

getFormulasLocal()

Представляет формулу в нотации стиля A1 на языке пользователя и в соответствии с его языковым стандартом. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке. Если в ячейке нет формулы, возвращается ее значение.

getFormulasLocal(): string[][];

Возвращаемое значение

string[][]

getFormulasR1C1()

Представляет формулу в формате R1C1. Если в ячейке нет формулы, возвращается ее значение.

getFormulasR1C1(): string[][];

Возвращаемое значение

string[][]

getIndex()

Возвращает значение, представляющее индекс RangeViewобъекта .

getIndex(): number;

Возвращаемое значение

number

getNumberFormat()

Представляет код в числовом формате Excel для данной ячейки.

getNumberFormat(): string[][];

Возвращаемое значение

string[][]

getRange()

Возвращает родительский диапазон, связанный с текущим RangeView.

getRange(): Range;

Возвращаемое значение

ExcelScript.Range

getRowCount()

Количество видимых строк.

getRowCount(): number;

Возвращаемое значение

number

getRows()

Представляет коллекцию видимых ячеек в диапазоне, сопоставленных с указанным диапазоном.

getRows(): RangeView[];

Возвращаемое значение

ExcelScript.RangeView[]

getText()

Текстовые значения указанного диапазона. Текстовое значение не зависит от ширины ячейки. Замена знака #, которая происходит в пользовательском интерфейсе Excel, не повлияет на текстовое значение, возвращаемое API-интерфейсом.

getText(): string[][];

Возвращаемое значение

string[][]

getValues()

Представляет необработанные значения указанного объекта rangeView. Могут возвращаться строковые и числовые данные, а также логические значения. Ячейки, содержащие ошибку, вернут строку ошибки.

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

Возвращаемое значение

(string | number | boolean)[][]

getValueTypes()

Представляет тип данных каждой ячейки.

getValueTypes(): RangeValueType[][];

Возвращаемое значение

ExcelScript.RangeValueType[][]

setFormulas(formulas)

Представляет формулу в формате A1. Если в ячейке нет формулы, возвращается ее значение.

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

Параметры

formulas

string[][]

Возвращаемое значение

void

setFormulasLocal(formulasLocal)

Представляет формулу в нотации стиля A1 на языке пользователя и в соответствии с его языковым стандартом. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке. Если в ячейке нет формулы, возвращается ее значение.

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

Параметры

formulasLocal

string[][]

Возвращаемое значение

void

setFormulasR1C1(formulasR1C1)

Представляет формулу в формате R1C1. Если в ячейке нет формулы, возвращается ее значение.

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

Параметры

formulasR1C1

string[][]

Возвращаемое значение

void

setNumberFormat(numberFormat)

Представляет код в числовом формате Excel для данной ячейки.

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

Параметры

numberFormat

string[][]

Возвращаемое значение

void

setValues(values)

Представляет необработанные значения указанного объекта rangeView. Могут возвращаться строковые и числовые данные, а также логические значения. Ячейки, содержащие ошибку, вернут строку ошибки.

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

Параметры

values

(string | number | boolean)[][]

Возвращаемое значение

void