ExcelScript.DataBarConditionalFormat interface

Пакет:

ExcelScript

Представляет тип условной панели данных Excel.

Замечания

Примеры

/**
 * This script creates data bar conditional formatting on the selected range.
 * The scale of the data bar goes from 0 to 1000.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the selected range.
  const selected = workbook.getSelectedRange();
  
  // Create new conditional formatting on the range.
  const format = selected.addConditionalFormat(ExcelScript.ConditionalFormatType.dataBar);
  const dataBarFormat: ExcelScript.DataBarConditionalFormat = format.getDataBar();

  // Set the lower bound of the data bar formatting to be 0.
  const lowerBound: ExcelScript.ConditionalDataBarRule = {
    type: ExcelScript.ConditionalFormatRuleType.number,
    formula: "0"
  };
  dataBarFormat.setLowerBoundRule(lowerBound);

  // Set the upper bound of the data bar formatting to be 1000.
  const upperBound: ExcelScript.ConditionalDataBarRule = {
    type: ExcelScript.ConditionalFormatRuleType.number,
    formula: "1000"
  };
  dataBarFormat.setUpperBoundRule(upperBound);
}

Методика

getAxisColor()	Код цвета HTML, представляющий цвет линии оси в виде #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый"). Значение равно "" (пустая строка), если ось отсутствует или не задано.
getAxisFormat()	Представление определения оси для панели данных Excel.
getBarDirection()	Указывает направление, на котором должен основываться рисунок панели данных.
getLowerBoundRule()	Правило для того, что составляет нижнюю границу (и как ее вычислить, если применимо) для панели данных. Объект ConditionalDataBarRule должен быть задан как объект JSON (используйте x.lowerBoundRule = {...} вместо x.lowerBoundRule.formula = ...).
getNegativeFormat()	Представление всех значений слева от оси на панели данных Excel.
getPositiveFormat()	Представление всех значений справа от оси на панели данных Excel.
getShowDataBarOnly()	Если trueзначение , то скрывает значения из ячеек, в которых применяется панель данных.
getUpperBoundRule()	Правило для верхней границы гистограммы (и как ее вычислить). Объект ConditionalDataBarRule должен быть задан как объект JSON (используйте x.upperBoundRule = {...} вместо x.upperBoundRule.formula = ...).
setAxisColor(axisColor)	Код цвета HTML, представляющий цвет линии оси в виде #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый"). Значение равно "" (пустая строка), если ось отсутствует или не задано.
setAxisFormat(axisFormat)	Представление определения оси для панели данных Excel.
setBarDirection(barDirection)	Указывает направление, на котором должен основываться рисунок панели данных.
setLowerBoundRule(lowerBoundRule)	Правило для того, что составляет нижнюю границу (и как ее вычислить, если применимо) для панели данных. Объект ConditionalDataBarRule должен быть задан как объект JSON (используйте x.lowerBoundRule = {...} вместо x.lowerBoundRule.formula = ...).
setShowDataBarOnly(showDataBarOnly)	Если trueзначение , то скрывает значения из ячеек, в которых применяется панель данных.
setUpperBoundRule(upperBoundRule)	Правило для верхней границы гистограммы (и как ее вычислить). Объект ConditionalDataBarRule должен быть задан как объект JSON (используйте x.upperBoundRule = {...} вместо x.upperBoundRule.formula = ...).

Подробнее о методе

getAxisColor()

Код цвета HTML, представляющий цвет линии оси в виде #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый"). Значение равно "" (пустая строка), если ось отсутствует или не задано.

getAxisColor(): string;

Возвращает

string

getAxisFormat()

Представление определения оси для панели данных Excel.

getAxisFormat(): ConditionalDataBarAxisFormat;

Возвращает

ExcelScript.ConditionalDataBarAxisFormat

getBarDirection()

Указывает направление, на котором должен основываться рисунок панели данных.

getBarDirection(): ConditionalDataBarDirection;

Возвращает

ExcelScript.ConditionalDataBarDirection

getLowerBoundRule()

Правило для того, что составляет нижнюю границу (и как ее вычислить, если применимо) для панели данных. Объект ConditionalDataBarRule должен быть задан как объект JSON (используйте x.lowerBoundRule = {...} вместо x.lowerBoundRule.formula = ...).

getLowerBoundRule(): ConditionalDataBarRule;

Возвращает

ExcelScript.ConditionalDataBarRule

getNegativeFormat()

Представление всех значений слева от оси на панели данных Excel.

getNegativeFormat(): ConditionalDataBarNegativeFormat;

Возвращает

ExcelScript.ConditionalDataBarNegativeFormat

getPositiveFormat()

Представление всех значений справа от оси на панели данных Excel.

getPositiveFormat(): ConditionalDataBarPositiveFormat;

Возвращает

ExcelScript.ConditionalDataBarPositiveFormat

getShowDataBarOnly()

Если trueзначение , то скрывает значения из ячеек, в которых применяется панель данных.

getShowDataBarOnly(): boolean;

Возвращает

boolean

getUpperBoundRule()

Правило для верхней границы гистограммы (и как ее вычислить). Объект ConditionalDataBarRule должен быть задан как объект JSON (используйте x.upperBoundRule = {...} вместо x.upperBoundRule.formula = ...).

getUpperBoundRule(): ConditionalDataBarRule;

Возвращает

ExcelScript.ConditionalDataBarRule

setAxisColor(axisColor)

Код цвета HTML, представляющий цвет линии оси в виде #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый"). Значение равно "" (пустая строка), если ось отсутствует или не задано.

setAxisColor(axisColor: string): void;

Параметры

axisColor

string

Возвращает

void

setAxisFormat(axisFormat)

Представление определения оси для панели данных Excel.

setAxisFormat(axisFormat: ConditionalDataBarAxisFormat): void;

Параметры

axisFormat

ExcelScript.ConditionalDataBarAxisFormat

Возвращает

void

setBarDirection(barDirection)

Указывает направление, на котором должен основываться рисунок панели данных.

setBarDirection(barDirection: ConditionalDataBarDirection): void;

Параметры

barDirection

ExcelScript.ConditionalDataBarDirection

Возвращает

void

setLowerBoundRule(lowerBoundRule)

Правило для того, что составляет нижнюю границу (и как ее вычислить, если применимо) для панели данных. Объект ConditionalDataBarRule должен быть задан как объект JSON (используйте x.lowerBoundRule = {...} вместо x.lowerBoundRule.formula = ...).

setLowerBoundRule(lowerBoundRule: ConditionalDataBarRule): void;

Параметры

lowerBoundRule

ExcelScript.ConditionalDataBarRule

Возвращает

void

setShowDataBarOnly(showDataBarOnly)

Если trueзначение , то скрывает значения из ячеек, в которых применяется панель данных.

setShowDataBarOnly(showDataBarOnly: boolean): void;

Параметры

showDataBarOnly

boolean

Возвращает

void

setUpperBoundRule(upperBoundRule)

Правило для верхней границы гистограммы (и как ее вычислить). Объект ConditionalDataBarRule должен быть задан как объект JSON (используйте x.upperBoundRule = {...} вместо x.upperBoundRule.formula = ...).

setUpperBoundRule(upperBoundRule: ConditionalDataBarRule): void;

Параметры

upperBoundRule

ExcelScript.ConditionalDataBarRule

Возвращает

void