ExcelScript.DataBarConditionalFormat interface

  • Referência
Pacote:
ExcelScript

Representa um tipo de barra de dados condicional do Excel.

Comentários

Exemplos

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

Métodos

getAxisColor()

Código de cor HTML que representa a cor da linha Axis, no formulário #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja"). O valor será "" (uma cadeia de caracteres vazia) se nenhum eixo estiver presente ou definido.
getAxisFormat()

Representação de como o eixo é determinado para uma barra de dados do Excel.
getBarDirection()

Especifica a direção na qual o gráfico da barra de dados deve ser baseado.
getLowerBoundRule()

A regra para o que constitui o limite inferior (e como calculá-lo, se aplicável) para uma barra de dados. O ConditionalDataBarRule objeto deve ser definido como um objeto JSON (use x.lowerBoundRule = {...} em vez de x.lowerBoundRule.formula = ...).
getNegativeFormat()

Representação de todos os valores à esquerda do eixo em uma barra de dados do Excel.
getPositiveFormat()

Representação de todos os valores à direita do eixo em uma barra de dados do Excel.
getShowDataBarOnly()

Se true, ocultar os valores das células em que a barra de dados é aplicada.
getUpperBoundRule()

A regra para o que constitui o limite superior (e como calculá-lo, se aplicável) para uma barra de dados. O ConditionalDataBarRule objeto deve ser definido como um objeto JSON (use x.upperBoundRule = {...} em vez de x.upperBoundRule.formula = ...).
setAxisColor(axisColor)

Código de cor HTML que representa a cor da linha Axis, no formulário #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja"). O valor será "" (uma cadeia de caracteres vazia) se nenhum eixo estiver presente ou definido.
setAxisFormat(axisFormat)

Representação de como o eixo é determinado para uma barra de dados do Excel.
setBarDirection(barDirection)

Especifica a direção na qual o gráfico da barra de dados deve ser baseado.
setLowerBoundRule(lowerBoundRule)

A regra para o que constitui o limite inferior (e como calculá-lo, se aplicável) para uma barra de dados. O ConditionalDataBarRule objeto deve ser definido como um objeto JSON (use x.lowerBoundRule = {...} em vez de x.lowerBoundRule.formula = ...).
setShowDataBarOnly(showDataBarOnly)

Se true, ocultar os valores das células em que a barra de dados é aplicada.
setUpperBoundRule(upperBoundRule)

A regra para o que constitui o limite superior (e como calculá-lo, se aplicável) para uma barra de dados. O ConditionalDataBarRule objeto deve ser definido como um objeto JSON (use x.upperBoundRule = {...} em vez de x.upperBoundRule.formula = ...).

Detalhes do método

getAxisColor()

Código de cor HTML que representa a cor da linha Axis, no formulário #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja"). O valor será "" (uma cadeia de caracteres vazia) se nenhum eixo estiver presente ou definido.

getAxisColor(): string;

Retornos

string

getAxisFormat()

Representação de como o eixo é determinado para uma barra de dados do Excel.

getAxisFormat(): ConditionalDataBarAxisFormat;

Retornos

ExcelScript.ConditionalDataBarAxisFormat

getBarDirection()

Especifica a direção na qual o gráfico da barra de dados deve ser baseado.

getBarDirection(): ConditionalDataBarDirection;

Retornos

ExcelScript.ConditionalDataBarDirection

getLowerBoundRule()

A regra para o que constitui o limite inferior (e como calculá-lo, se aplicável) para uma barra de dados. O ConditionalDataBarRule objeto deve ser definido como um objeto JSON (use x.lowerBoundRule = {...} em vez de x.lowerBoundRule.formula = ...).

getLowerBoundRule(): ConditionalDataBarRule;

Retornos

ExcelScript.ConditionalDataBarRule

getNegativeFormat()

Representação de todos os valores à esquerda do eixo em uma barra de dados do Excel.

getNegativeFormat(): ConditionalDataBarNegativeFormat;

Retornos

ExcelScript.ConditionalDataBarNegativeFormat

getPositiveFormat()

Representação de todos os valores à direita do eixo em uma barra de dados do Excel.

getPositiveFormat(): ConditionalDataBarPositiveFormat;

Retornos

ExcelScript.ConditionalDataBarPositiveFormat

getShowDataBarOnly()

Se true, ocultar os valores das células em que a barra de dados é aplicada.

getShowDataBarOnly(): boolean;

Retornos

boolean

getUpperBoundRule()

A regra para o que constitui o limite superior (e como calculá-lo, se aplicável) para uma barra de dados. O ConditionalDataBarRule objeto deve ser definido como um objeto JSON (use x.upperBoundRule = {...} em vez de x.upperBoundRule.formula = ...).

getUpperBoundRule(): ConditionalDataBarRule;

Retornos

ExcelScript.ConditionalDataBarRule

setAxisColor(axisColor)

Código de cor HTML que representa a cor da linha Axis, no formulário #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja"). O valor será "" (uma cadeia de caracteres vazia) se nenhum eixo estiver presente ou definido.

setAxisColor(axisColor: string): void;

Parâmetros

axisColor

string

Retornos

void

setAxisFormat(axisFormat)

Representação de como o eixo é determinado para uma barra de dados do Excel.

setAxisFormat(axisFormat: ConditionalDataBarAxisFormat): void;

Parâmetros

axisFormat
ExcelScript.ConditionalDataBarAxisFormat

Retornos

void

setBarDirection(barDirection)

Especifica a direção na qual o gráfico da barra de dados deve ser baseado.

setBarDirection(barDirection: ConditionalDataBarDirection): void;

Parâmetros

barDirection
ExcelScript.ConditionalDataBarDirection

Retornos

void

setLowerBoundRule(lowerBoundRule)

A regra para o que constitui o limite inferior (e como calculá-lo, se aplicável) para uma barra de dados. O ConditionalDataBarRule objeto deve ser definido como um objeto JSON (use x.lowerBoundRule = {...} em vez de x.lowerBoundRule.formula = ...).

setLowerBoundRule(lowerBoundRule: ConditionalDataBarRule): void;

Parâmetros

lowerBoundRule
ExcelScript.ConditionalDataBarRule

Retornos

void

setShowDataBarOnly(showDataBarOnly)

Se true, ocultar os valores das células em que a barra de dados é aplicada.

setShowDataBarOnly(showDataBarOnly: boolean): void;

Parâmetros

showDataBarOnly

boolean

Retornos

void

setUpperBoundRule(upperBoundRule)

A regra para o que constitui o limite superior (e como calculá-lo, se aplicável) para uma barra de dados. O ConditionalDataBarRule objeto deve ser definido como um objeto JSON (use x.upperBoundRule = {...} em vez de x.upperBoundRule.formula = ...).

setUpperBoundRule(upperBoundRule: ConditionalDataBarRule): void;

Parâmetros

upperBoundRule
ExcelScript.ConditionalDataBarRule

Retornos

void