Share via

Excel.DataBarConditionalFormat class

  • Referência
Pacote:
excel

Representa um tipo de barra de dados condicional do Excel.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

Propriedades

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.
axisFormat

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

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

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
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 = ...).
negativeFormat

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

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

Se true, ocultar os valores das células em que a barra de dados é aplicada.
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 = ...).

Métodos

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(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.DataBarConditionalFormat original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.DataBarConditionalFormatData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

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.

axisColor: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

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

[ Conjunto de API: ExcelApi 1.6 ]

barDirection

Especifica a direção na qual 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 de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

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 = ...).

lowerBoundRule: Excel.ConditionalDataBarRule;

Valor da propriedade

Excel.ConditionalDataBarRule

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

negativeFormat

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

readonly negativeFormat: Excel.ConditionalDataBarNegativeFormat;

Valor da propriedade

Excel.ConditionalDataBarNegativeFormat

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

positiveFormat

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

readonly positiveFormat: Excel.ConditionalDataBarPositiveFormat;

Valor da propriedade

Excel.ConditionalDataBarPositiveFormat

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

showDataBarOnly

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

showDataBarOnly: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

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 = ...).

upperBoundRule: Excel.ConditionalDataBarRule;

Valor da propriedade

Excel.ConditionalDataBarRule

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

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

options
Excel.Interfaces.DataBarConditionalFormatLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Excel.DataBarConditionalFormat

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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

Excel.DataBarConditionalFormat

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 de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Excel.DataBarConditionalFormat

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.DataBarConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties
Excel.Interfaces.DataBarConditionalFormatUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um 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 é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.DataBarConditionalFormat original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.DataBarConditionalFormatData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.DataBarConditionalFormatData;

Retornos

Excel.Interfaces.DataBarConditionalFormatData