Excel.DataBarConditionalFormat class
Representa um tipo de barra de dados condicional do Excel.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.6 ]
Propriedades
| axis |
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. |
| axis |
Representação de como o eixo é determinado para uma barra de dados do Excel. |
| bar |
Especifica a direção em que o gráfico da barra de dados deve ser baseado. |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| lower |
A regra para o que constitui o limite inferior (e como calculá-lo, se aplicável) para uma barra de dados. O |
| negative |
Representação de todos os valores à esquerda do eixo numa barra de dados do Excel. |
| positive |
Representação de todos os valores à direita do eixo numa barra de dados do Excel. |
| show |
Se |
| upper |
A regra para o que constitui o limite superior (e como calculá-lo, se aplicável) para uma barra de dados. O |
Métodos
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
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.
axisColor: string;Valor da propriedade
string
Comentários
axisFormat
Representação de como o eixo é determinado para uma barra de dados do Excel.
axisFormat: Excel.ConditionalDataBarAxisFormat | "Automatic" | "None" | "CellMidPoint";Valor da propriedade
Excel.ConditionalDataBarAxisFormat | "Automatic" | "None" | "CellMidPoint"
Comentários
barDirection
Especifica a direção em que o gráfico da barra de dados deve ser baseado.
barDirection: Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft";Valor da propriedade
Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft"
Comentários
[ Conjunto de API: ExcelApi 1.6 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const range = sheet.getRange("B8:E13");
const conditionalFormat = range.conditionalFormats
.add(Excel.ConditionalFormatType.dataBar);
conditionalFormat.dataBar.barDirection = Excel.ConditionalDataBarDirection.leftToRight;
await context.sync();
});
context
O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
context: RequestContext;Valor da propriedade
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 = ...).
lowerBoundRule: Excel.ConditionalDataBarRule;Valor da propriedade
Comentários
negativeFormat
Representação de todos os valores à esquerda do eixo numa barra de dados do Excel.
readonly negativeFormat: Excel.ConditionalDataBarNegativeFormat;Valor da propriedade
Comentários
positiveFormat
Representação de todos os valores à direita do eixo numa barra de dados do Excel.
readonly positiveFormat: Excel.ConditionalDataBarPositiveFormat;Valor da propriedade
Comentários
showDataBarOnly
Se true, oculta os valores das células onde a barra de dados é aplicada.
showDataBarOnly: boolean;Valor da propriedade
boolean
Comentários
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 = ...).
upperBoundRule: Excel.ConditionalDataBarRule;Valor da propriedade
Comentários
Detalhes do método
load(options)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(options?: Excel.Interfaces.DataBarConditionalFormatLoadOptions): Excel.DataBarConditionalFormat;Parâmetros
Fornece opções para as propriedades do objeto a carregar.
Retornos
load(propertyNames)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames?: string | string[]): Excel.DataBarConditionalFormat;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
load(propertyNamesAndPaths)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.DataBarConditionalFormat;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.
Retornos
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties: Interfaces.DataBarConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
set(properties: Excel.DataBarConditionalFormat): void;Parâmetros
- properties
- Excel.DataBarConditionalFormat
Retornos
void
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.DataBarConditionalFormat é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.DataBarConditionalFormatData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.DataBarConditionalFormatData;