Excel.ChartFont class
Este objeto 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 de gráfico.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Exemplos
// Set the chart title font to Calibri, size 10, bold, and the color red.
await Excel.run(async (context) => {
const title = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").title;
title.format.font.name = "Calibri";
title.format.font.size = 12;
title.format.font.color = "#FF0000";
title.format.font.italic = false;
title.format.font.bold = true;
title.format.font.underline = "None";
await context.sync();
});
Propriedades
bold | Representa o status da fonte em negrito. |
color | Representação do código de cores HTML da cor do texto (por exemplo, #FF0000 representa Vermelho). |
context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
italic | Representa o status da fonte em itálico. |
name | Nome do tipo de letra (por exemplo, "Calibri") |
size | Tamanho do tipo de letra (por exemplo, 11) |
underline | Tipo de sublinhado aplicado à fonte. Veja |
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
bold
Representa o status da fonte em negrito.
bold: boolean;
Valor da propriedade
boolean
Comentários
color
Representação do código de cores HTML da cor do texto (por exemplo, #FF0000 representa Vermelho).
color: string;
Valor da propriedade
string
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
italic
Representa o status da fonte em itálico.
italic: boolean;
Valor da propriedade
boolean
Comentários
name
Nome do tipo de letra (por exemplo, "Calibri")
name: string;
Valor da propriedade
string
Comentários
size
Tamanho do tipo de letra (por exemplo, 11)
size: number;
Valor da propriedade
number
Comentários
underline
Tipo de sublinhado aplicado à fonte. Veja Excel.ChartUnderlineStyle
para obter detalhes.
underline: Excel.ChartUnderlineStyle | "None" | "Single";
Valor da propriedade
Excel.ChartUnderlineStyle | "None" | "Single"
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.ChartFontLoadOptions): Excel.ChartFont;
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.ChartFont;
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.ChartFont;
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.ChartFontUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parâmetros
- properties
- Excel.Interfaces.ChartFontUpdateData
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.ChartFont): void;
Parâmetros
- properties
- Excel.ChartFont
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 Excel.ChartFont original é um objeto de API, o toJSON
método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ChartFontData
) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.ChartFontData;