Share via

Excel.ChartPlotArea class

  • Referência
Pacote:
excel

Esse objeto representa os atributos de uma área de plotagem do gráfico.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

Propriedades

context

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

Especifica a formatação de uma área de plotagem de gráfico.
height

Especifica o valor de altura de uma área de plotagem.
insideHeight

Especifica o valor de altura interna de uma área de plotagem.
insideLeft

Especifica o valor interno esquerdo de uma área de plotagem.
insideTop

Especifica o valor superior interno de uma área de plotagem.
insideWidth

Especifica o valor de largura interna de uma área de plotagem.
left

Especifica o valor esquerdo de uma área de plotagem.
position

Especifica a posição de uma área de plotagem.
top

Especifica o valor superior de uma área de plotagem.
width

Especifica o valor de largura de uma área de plotagem.

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

Especifica a formatação de uma área de plotagem de gráfico.

readonly format: Excel.ChartPlotAreaFormat;

Valor da propriedade

Excel.ChartPlotAreaFormat

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

height

Especifica o valor de altura de uma área de plotagem.

height: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

insideHeight

Especifica o valor de altura interna de uma área de plotagem.

insideHeight: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

insideLeft

Especifica o valor interno esquerdo de uma área de plotagem.

insideLeft: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

insideTop

Especifica o valor superior interno de uma área de plotagem.

insideTop: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

insideWidth

Especifica o valor de largura interna de uma área de plotagem.

insideWidth: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

left

Especifica o valor esquerdo de uma área de plotagem.

left: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

position

Especifica a posição de uma área de plotagem.

position: Excel.ChartPlotAreaPosition | "Automatic" | "Custom";

Valor da propriedade

Excel.ChartPlotAreaPosition | "Automatic" | "Custom"

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

top

Especifica o valor superior de uma área de plotagem.

top: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

width

Especifica o valor de largura de uma área de plotagem.

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.ChartPlotAreaLoadOptions): Excel.ChartPlotArea;

Parâmetros

options
Excel.Interfaces.ChartPlotAreaLoadOptions

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

Retornos

Excel.ChartPlotArea

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

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

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

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

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

Parâmetros

properties
Excel.Interfaces.ChartPlotAreaUpdateData

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

Parâmetros

properties
Excel.ChartPlotArea

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

toJSON(): Excel.Interfaces.ChartPlotAreaData;

Retornos

Excel.Interfaces.ChartPlotAreaData