Excel.ChartLegend class

  • Referência
Pacote:
excel

Representa a legenda de um gráfico.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Propriedades

context

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

Representa a formatação de uma legenda de gráfico, que inclui a formatação de fonte e de preenchimento.
height

Especifica a altura, em pontos, da legenda no gráfico. O valor será null se a legenda não estiver visível.
left

Especifica o valor esquerdo, em pontos, da legenda no gráfico. O valor será null se a legenda não estiver visível.
legendEntries

Representa uma coleção de legendEntries na legenda.
overlay

Especifica se a legenda do gráfico deve se sobrepor ao corpo principal do gráfico.
position

Especifica a posição da legenda no gráfico. Confira Excel.ChartLegendPosition detalhes.
showShadow

Especifica se a legenda tem uma sombra no gráfico.
top

Especifica a parte superior de uma legenda de gráfico.
visible

Especifica se a legenda do gráfico está visível.
width

Especifica a largura, em pontos, da legenda no gráfico. O valor será null se a legenda não estiver visível.

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.ChartLegend original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ChartLegendData) 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

format

Representa a formatação de uma legenda de gráfico, que inclui a formatação de fonte e de preenchimento.

readonly format: Excel.ChartLegendFormat;

Valor da propriedade

Excel.ChartLegendFormat

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

height

Especifica a altura, em pontos, da legenda no gráfico. O valor será null se a legenda não estiver visível.

height: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

left

Especifica o valor esquerdo, em pontos, da legenda no gráfico. O valor será null se a legenda não estiver visível.

left: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

legendEntries

Representa uma coleção de legendEntries na legenda.

readonly legendEntries: Excel.ChartLegendEntryCollection;

Valor da propriedade

Excel.ChartLegendEntryCollection

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

overlay

Especifica se a legenda do gráfico deve se sobrepor ao corpo principal do gráfico.

overlay: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

position

Especifica a posição da legenda no gráfico. Confira Excel.ChartLegendPosition detalhes.

position: Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom";

Valor da propriedade

Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom"

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

showShadow

Especifica se a legenda tem uma sombra no gráfico.

showShadow: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

top

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

top: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

visible

Especifica se a legenda do gráfico está visível.

visible: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

width

Especifica a largura, em pontos, da legenda no gráfico. O valor será null se a legenda não estiver visível.

width: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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.ChartLegendLoadOptions): Excel.ChartLegend;

Parâmetros

options
Excel.Interfaces.ChartLegendLoadOptions

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

Retornos

Excel.ChartLegend

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

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

Exemplos

// Get the position of Chart Legend from Chart1.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    const legend = chart.legend;
    legend.load('position');
    await context.sync();

    console.log(legend.position);
});

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

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

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

Parâmetros

properties
Excel.Interfaces.ChartLegendUpdateData

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

Parâmetros

properties
Excel.ChartLegend

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

toJSON(): Excel.Interfaces.ChartLegendData;

Retornos

Excel.Interfaces.ChartLegendData