ExcelScript.DataBarConditionalFormat interface
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
get |
Código de cores HTML que representa a cor da linha eixo, na forma #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja"). O valor é "" (uma cadeia vazia) se não existir nenhum eixo ou estiver definido. |
get |
Representação de como o eixo é determinado para uma barra de dados do Excel. |
get |
Especifica a direção em que o gráfico da barra de dados deve ser baseado. |
get |
A regra para o que constitui o limite inferior (e como calculá-lo, se aplicável) para uma barra de dados. O |
get |
Representação de todos os valores à esquerda do eixo numa barra de dados do Excel. |
get |
Representação de todos os valores à direita do eixo numa barra de dados do Excel. |
get |
Se |
get |
A regra para o que constitui o limite superior (e como calculá-lo, se aplicável) para uma barra de dados. O |
set |
Código de cores HTML que representa a cor da linha eixo, na forma #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja"). O valor é "" (uma cadeia vazia) se não existir nenhum eixo ou estiver definido. |
set |
Representação de como o eixo é determinado para uma barra de dados do Excel. |
set |
Especifica a direção em que o gráfico da barra de dados deve ser baseado. |
set |
A regra para o que constitui o limite inferior (e como calculá-lo, se aplicável) para uma barra de dados. O |
set |
Se |
set |
A regra para o que constitui o limite superior (e como calculá-lo, se aplicável) para uma barra de dados. O |
Detalhes do método
getAxisColor()
Código de cores HTML que representa a cor da linha eixo, na forma #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja"). O valor é "" (uma cadeia vazia) se não existir nenhum eixo ou estiver definido.
getAxisColor(): string;
Retornos
string
getAxisFormat()
Representação de como o eixo é determinado para uma barra de dados do Excel.
getAxisFormat(): ConditionalDataBarAxisFormat;
Retornos
getBarDirection()
Especifica a direção em que o gráfico da barra de dados deve ser baseado.
getBarDirection(): ConditionalDataBarDirection;
Retornos
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 tem de ser definido como um objeto JSON (utilize x.lowerBoundRule = {...}
em vez de x.lowerBoundRule.formula = ...
).
getLowerBoundRule(): ConditionalDataBarRule;
Retornos
getNegativeFormat()
Representação de todos os valores à esquerda do eixo numa barra de dados do Excel.
getNegativeFormat(): ConditionalDataBarNegativeFormat;
Retornos
getPositiveFormat()
Representação de todos os valores à direita do eixo numa barra de dados do Excel.
getPositiveFormat(): ConditionalDataBarPositiveFormat;
Retornos
getShowDataBarOnly()
Se true
, oculta os valores das células onde 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 tem de ser definido como um objeto JSON (utilize x.upperBoundRule = {...}
em vez de x.upperBoundRule.formula = ...
).
getUpperBoundRule(): ConditionalDataBarRule;
Retornos
setAxisColor(axisColor)
Código de cores HTML que representa a cor da linha eixo, na forma #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja"). O valor é "" (uma cadeia vazia) se não existir nenhum eixo ou estiver 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 em que 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 tem de ser definido como um objeto JSON (utilize x.lowerBoundRule = {...}
em vez de x.lowerBoundRule.formula = ...
).
setLowerBoundRule(lowerBoundRule: ConditionalDataBarRule): void;
Parâmetros
- lowerBoundRule
- ExcelScript.ConditionalDataBarRule
Retornos
void
setShowDataBarOnly(showDataBarOnly)
Se true
, oculta os valores das células onde 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 tem de ser definido como um objeto JSON (utilize x.upperBoundRule = {...}
em vez de x.upperBoundRule.formula = ...
).
setUpperBoundRule(upperBoundRule: ConditionalDataBarRule): void;
Parâmetros
- upperBoundRule
- ExcelScript.ConditionalDataBarRule
Retornos
void