Excel.ChartAxisTitle class
Representa o título de um eixo do gráfico.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
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 do título do eixo do gráfico. |
| text | Especifica o título do eixo. |
| text |
Especifica o ângulo para o qual o texto é orientado para o título do eixo do gráfico. O valor deve ser um inteiro de -90 a 90 ou o inteiro 180 para texto orientado verticalmente. |
| visible | Especifica se o título do eixo está visível. |
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. 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. |
| set |
Um valor de cadeia de caracteres que representa a fórmula do título do eixo do gráfico usando a notação no estilo A1. |
| toJSON() | Substitui o método JavaScript |
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
format
Especifica a formatação do título do eixo do gráfico.
readonly format: Excel.ChartAxisTitleFormat;Valor da propriedade
Comentários
text
Especifica o título do eixo.
text: string;Valor da propriedade
string
Comentários
textOrientation
Especifica o ângulo para o qual o texto é orientado para o título do eixo do gráfico. O valor deve ser um inteiro de -90 a 90 ou o inteiro 180 para texto orientado verticalmente.
textOrientation: number;Valor da propriedade
number
Comentários
[ Conjunto de API: ExcelApi 1.12 ]
Exemplos
await Excel.run(async (context) => {
// Get a chart named "Sales Chart" from the "Sample" worksheet.
const sheet = context.workbook.worksheets.getItem("Sample");
let chart = sheet.charts.getItem("Sales Chart");
// Set the value axis title to "Profits".
chart.axes.valueAxis.title.text = "Profits";
/* Set the value axis text orientation to 0.
For charts with a y-axis, this makes the label on the y-axis horizontal,
instead of the default look of rotated-vertically.
*/
chart.axes.valueAxis.title.textOrientation = 0;
await context.sync();
});
visible
Especifica se o título do eixo está visível.
visible: boolean;Valor da propriedade
boolean
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.ChartAxisTitleLoadOptions): Excel.ChartAxisTitle;Parâmetros
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.ChartAxisTitle;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
Exemplos
// Add "Values" as the title for the value Axis.
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.axes.valueAxis.title.text = "Values";
await context.sync();
console.log("Axis Title Added ");
});
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.ChartAxisTitle;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.ChartAxisTitleUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Excel.Interfaces.ChartAxisTitleUpdateData
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.ChartAxisTitle): void;Parâmetros
- properties
- Excel.ChartAxisTitle
Retornos
void
setFormula(formula)
Um valor de cadeia de caracteres que representa a fórmula do título do eixo do gráfico usando a notação no estilo A1.
setFormula(formula: string): void;Parâmetros
- formula
-
string
Uma cadeia de caracteres que representa a fórmula a ser definida.
Retornos
void
Comentários
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.ChartAxisTitle original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ChartAxisTitleData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.ChartAxisTitleData;Retornos
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de