Excel.ChartPlotArea class
Este objeto representa os atributos de uma área de desenho de gráfico.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.8 ]
Propriedades
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| format | Especifica a formatação de uma área de desenho de gráfico. |
| height | Especifica o valor de altura de uma área de desenho. |
| inside |
Especifica o valor de altura interior de uma área de desenho. |
| inside |
Especifica o valor interior esquerdo de uma área de desenho. |
| inside |
Especifica o valor superior interno de uma área de desenho. |
| inside |
Especifica o valor de largura interna de uma área de desenho. |
| left | Especifica o valor esquerdo de uma área de desenho. |
| position | Especifica a posição de uma área de desenho. |
| top | Especifica o valor superior de uma área de desenho. |
| width | Especifica o valor de largura de uma área de desenho. |
Métodos
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
context
O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
context: RequestContext;Valor da propriedade
format
Especifica a formatação de uma área de desenho de gráfico.
readonly format: Excel.ChartPlotAreaFormat;Valor da propriedade
Comentários
height
Especifica o valor de altura de uma área de desenho.
height: number;Valor da propriedade
number
Comentários
insideHeight
Especifica o valor de altura interior de uma área de desenho.
insideHeight: number;Valor da propriedade
number
Comentários
insideLeft
Especifica o valor interior esquerdo de uma área de desenho.
insideLeft: number;Valor da propriedade
number
Comentários
insideTop
Especifica o valor superior interno de uma área de desenho.
insideTop: number;Valor da propriedade
number
Comentários
insideWidth
Especifica o valor de largura interna de uma área de desenho.
insideWidth: number;Valor da propriedade
number
Comentários
left
Especifica o valor esquerdo de uma área de desenho.
left: number;Valor da propriedade
number
Comentários
position
Especifica a posição de uma área de desenho.
position: Excel.ChartPlotAreaPosition | "Automatic" | "Custom";Valor da propriedade
Excel.ChartPlotAreaPosition | "Automatic" | "Custom"
Comentários
top
Especifica o valor superior de uma área de desenho.
top: number;Valor da propriedade
number
Comentários
width
Especifica o valor de largura de uma área de desenho.
width: number;Valor da propriedade
number
Comentários
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
Fornece opções para as propriedades do objeto a 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.ChartPlotArea;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
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.ChartPlotArea;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.
Retornos
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas 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 que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base num 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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto excel.ChartPlotArea original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ChartPlotAreaData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.ChartPlotAreaData;