Compartilhar via


Excel.ChartBinOptions class

Encapsula as opções de bin para gráficos de histograma e gráficos de pareto.

Extends

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Propriedades

allowOverflow

Especifica se o estouro da lixeira está habilitado em um gráfico de histograma ou gráfico de pareto.

allowUnderflow

Especifica se o fluxo de entrada da lixeira está habilitado em um gráfico de histograma ou gráfico de pareto.

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

count

Especifica a contagem de bin de um gráfico de histograma ou gráfico de pareto.

overflowValue

Especifica o valor de estouro da lixeira de um gráfico de histograma ou gráfico de pareto.

type

Especifica o tipo da lixeira para um gráfico de histograma ou gráfico de pareto.

underflowValue

Especifica o valor do fluxo de subfluxo da lixeira de um gráfico de histograma ou gráfico de pareto.

width

Especifica o valor da largura da lixeira de um gráfico de histograma ou gráfico de pareto.

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.ChartBinOptions original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ChartBinOptionsData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

allowOverflow

Especifica se o estouro da lixeira está habilitado em um gráfico de histograma ou gráfico de pareto.

allowOverflow: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

allowUnderflow

Especifica se o fluxo de entrada da lixeira está habilitado em um gráfico de histograma ou gráfico de pareto.

allowUnderflow: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

count

Especifica a contagem de bin de um gráfico de histograma ou gráfico de pareto.

count: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

overflowValue

Especifica o valor de estouro da lixeira de um gráfico de histograma ou gráfico de pareto.

overflowValue: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

type

Especifica o tipo da lixeira para um gráfico de histograma ou gráfico de pareto.

type: Excel.ChartBinType | "Category" | "Auto" | "BinWidth" | "BinCount";

Valor da propriedade

Excel.ChartBinType | "Category" | "Auto" | "BinWidth" | "BinCount"

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

underflowValue

Especifica o valor do fluxo de subfluxo da lixeira de um gráfico de histograma ou gráfico de pareto.

underflowValue: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

width

Especifica o valor da largura da lixeira de um gráfico de histograma ou gráfico de pareto.

width: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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.ChartBinOptionsLoadOptions): Excel.ChartBinOptions;

Parâmetros

options
Excel.Interfaces.ChartBinOptionsLoadOptions

Fornece opções para quais propriedades do objeto 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.ChartBinOptions;

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

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.ChartBinOptions;

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

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.ChartBinOptionsUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties
Excel.Interfaces.ChartBinOptionsUpdateData

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.ChartBinOptions): void;

Parâmetros

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.ChartBinOptions original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ChartBinOptionsData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.ChartBinOptionsData;

Retornos