Excel.ChartLegendEntry class

Pacote:

excel

Representa a entrada da legenda em legendEntryCollection.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Propriedades

context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
height	Especifica a altura da entrada da legenda na legenda do gráfico.
index	Especifica o índice da entrada de legenda na legenda do gráfico.
left	Especifica o valor esquerdo de uma entrada de legenda de gráfico.
top	Especifica a parte superior de uma entrada de legenda do gráfico.
visible	Representa a visibilidade de uma entrada de legenda de gráfico.
width	Representa a largura da entrada da legenda na legenda do gráfico.

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

Detalhes da propriedade

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

height

Especifica a altura da entrada da legenda na legenda do gráfico.

readonly height: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

index

Especifica o índice da entrada de legenda na legenda do gráfico.

readonly index: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

left

Especifica o valor esquerdo de uma entrada de legenda de gráfico.

readonly left: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

top

Especifica a parte superior de uma entrada de legenda do gráfico.

readonly top: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

visible

Representa a visibilidade de uma entrada de legenda de gráfico.

visible: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

width

Representa a largura da entrada da legenda na legenda do gráfico.

readonly width: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

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.ChartLegendEntryLoadOptions): Excel.ChartLegendEntry;

Parâmetros

options

Excel.Interfaces.ChartLegendEntryLoadOptions

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

Retornos

Excel.ChartLegendEntry

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

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

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

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

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

Parâmetros

properties

Excel.Interfaces.ChartLegendEntryUpdateData

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

Parâmetros

properties

Excel.ChartLegendEntry

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

toJSON(): Excel.Interfaces.ChartLegendEntryData;

Retornos

Excel.Interfaces.ChartLegendEntryData