Excel.ChartTitleFormat class
Fornece acesso às opções de formatação de um título de gráfico.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Propriedades
border | Representa o formato de limite do título do gráfico, que inclui cor, estilo de linha e peso. |
context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
fill | Representa o formato de preenchimento de um objeto, que inclui informações sobre a formatação da tela de fundo. |
font | Representa os atributos do tipo de letra (como o nome do tipo de letra, o tamanho do tipo de letra e a cor) de um objeto. |
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
border
Representa o formato de limite do título do gráfico, que inclui cor, estilo de linha e peso.
readonly border: Excel.ChartBorder;
Valor da propriedade
Comentários
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
fill
Representa o formato de preenchimento de um objeto, que inclui informações sobre a formatação da tela de fundo.
readonly fill: Excel.ChartFill;
Valor da propriedade
Comentários
font
Representa os atributos do tipo de letra (como o nome do tipo de letra, o tamanho do tipo de letra e a cor) de um objeto.
readonly font: Excel.ChartFont;
Valor da propriedade
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.ChartTitleFormatLoadOptions): Excel.ChartTitleFormat;
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.ChartTitleFormat;
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.ChartTitleFormat;
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.ChartTitleFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parâmetros
- properties
- Excel.Interfaces.ChartTitleFormatUpdateData
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.ChartTitleFormat): void;
Parâmetros
- properties
- Excel.ChartTitleFormat
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.stringify
por sua vez, chama o toJSON
método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.ChartTitleFormat é um objeto de API, o toJSON
método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ChartTitleFormatData
) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.ChartTitleFormatData;