Excel.ChartAxis class
Representa um único eixo em um gráfico.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
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 | Representa a formatação de um objeto Chart, que inclui formatação de linha e de fonte. |
| major |
Devolve um objeto que representa as principais linhas de grelha do eixo especificado. |
| major |
Representa o intervalo entre as duas principais marcas de escala. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia. O valor retornado sempre é um número. |
| maximum | Representa o valor máximo no eixo dos valores. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia (para valores automáticos de eixo). O valor retornado sempre é um número. |
| minimum | Representa o valor mínimo no eixo dos valores. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia (para valores automáticos de eixo). O valor retornado sempre é um número. |
| minor |
Devolve um objeto que representa as linhas de grelha secundárias do eixo especificado. |
| minor |
Representa o intervalo entre as duas marcas de escala secundárias. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia (para valores automáticos de eixo). O valor retornado sempre é um número. |
| title | Representa o título do eixo. |
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
Representa a formatação de um objeto Chart, que inclui formatação de linha e de fonte.
readonly format: Excel.ChartAxisFormat;Valor da propriedade
Comentários
majorGridlines
Devolve um objeto que representa as principais linhas de grelha do eixo especificado.
readonly majorGridlines: Excel.ChartGridlines;Valor da propriedade
Comentários
majorUnit
Representa o intervalo entre as duas principais marcas de escala. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia. O valor retornado sempre é um número.
majorUnit: any;Valor da propriedade
any
Comentários
maximum
Representa o valor máximo no eixo dos valores. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia (para valores automáticos de eixo). O valor retornado sempre é um número.
maximum: any;Valor da propriedade
any
Comentários
minimum
Representa o valor mínimo no eixo dos valores. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia (para valores automáticos de eixo). O valor retornado sempre é um número.
minimum: any;Valor da propriedade
any
Comentários
minorGridlines
Devolve um objeto que representa as linhas de grelha secundárias do eixo especificado.
readonly minorGridlines: Excel.ChartGridlines;Valor da propriedade
Comentários
minorUnit
Representa o intervalo entre as duas marcas de escala secundárias. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia (para valores automáticos de eixo). O valor retornado sempre é um número.
minorUnit: any;Valor da propriedade
any
Comentários
title
Representa o título do eixo.
readonly title: Excel.ChartAxisTitle;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.ChartAxisLoadOptions): Excel.ChartAxis;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.ChartAxis;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
Exemplos
// Get the maximum of Chart Axis from Chart1.
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
const axis = chart.axes.valueAxis;
axis.load('maximum');
await context.sync();
console.log(axis.maximum);
});
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.ChartAxis;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.ChartAxisUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Excel.Interfaces.ChartAxisUpdateData
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.ChartAxis): void;Parâmetros
- properties
- Excel.ChartAxis
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 original Excel.ChartAxis é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ChartAxisData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.ChartAxisData;