Excel.ChartFont class

Esse objeto representa os atributos de fonte (como nome da fonte, tamanho da fonte e cor) para um objeto 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 de código de cor HTML da cor do texto (por exemplo, #FF0000 representa Vermelho).

context

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

italic

Representa o status da fonte em itálico.

name

Nome da fonte (por exemplo, "Calibri")

size

Tamanho da fonte (por exemplo, 11)

underline

Tipo de sublinhado aplicado à fonte. Confira Excel.ChartUnderlineStyle detalhes.

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

Detalhes da propriedade

bold

Representa o status da fonte em negrito.

bold: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

color

Representação de código de cor HTML da cor do texto (por exemplo, #FF0000 representa Vermelho).

color: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

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

italic

Representa o status da fonte em itálico.

italic: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

name

Nome da fonte (por exemplo, "Calibri")

name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

size

Tamanho da fonte (por exemplo, 11)

size: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

underline

Tipo de sublinhado aplicado à fonte. Confira Excel.ChartUnderlineStyle detalhes.

underline: Excel.ChartUnderlineStyle | "None" | "Single";

Valor da propriedade

Excel.ChartUnderlineStyle | "None" | "Single"

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

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

options
Excel.Interfaces.ChartFontLoadOptions

Fornece opções para quais propriedades do objeto 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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

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

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

Parâmetros

properties
Excel.Interfaces.ChartFontUpdateData

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.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 é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.ChartFont original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ChartFontData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.ChartFontData;

Retornos