Excel.ChartAxes class
Representa os eixos de um gráfico.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Propriedades
| category |
Representa o eixo de categoria em um gráfico. |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| series |
Representa o eixo da série de um gráfico 3D. |
| value |
Representa o eixo dos valores em um eixo. |
Métodos
| get |
Retorna o eixo específico identificado por tipo e grupo. |
| get |
Retorna o eixo específico identificado por tipo e grupo. |
| 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
categoryAxis
Representa o eixo de categoria em um gráfico.
readonly categoryAxis: Excel.ChartAxis;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
seriesAxis
Representa o eixo da série de um gráfico 3D.
readonly seriesAxis: Excel.ChartAxis;Valor da propriedade
Comentários
valueAxis
Representa o eixo dos valores em um eixo.
readonly valueAxis: Excel.ChartAxis;Valor da propriedade
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Exemplos
// Set the maximum, minimum, majorUnit, minorUnit of valueAxis.
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.axes.valueAxis.maximum = 5;
chart.axes.valueAxis.minimum = 0;
chart.axes.valueAxis.majorUnit = 1;
chart.axes.valueAxis.minorUnit = 0.2;
await context.sync();
console.log("Axis Settings Changed");
});
Detalhes do método
getItem(type, group)
Retorna o eixo específico identificado por tipo e grupo.
getItem(type: Excel.ChartAxisType, group?: Excel.ChartAxisGroup): Excel.ChartAxis;Parâmetros
- type
- Excel.ChartAxisType
Especifica o tipo de eixo. Veja Excel.ChartAxisType para obter detalhes.
- group
- Excel.ChartAxisGroup
Opcional. Especifica o grupo de eixos. Veja Excel.ChartAxisGroup para obter detalhes.
Retornos
Comentários
getItem(typeString, groupString)
Retorna o eixo específico identificado por tipo e grupo.
getItem(typeString: "Invalid" | "Category" | "Value" | "Series", groupString?: "Primary" | "Secondary"): Excel.ChartAxis;Parâmetros
- typeString
-
"Invalid" | "Category" | "Value" | "Series"
Especifica o tipo de eixo. Veja Excel.ChartAxisType para obter detalhes.
- groupString
-
"Primary" | "Secondary"
Opcional. Especifica o grupo de eixos. Veja Excel.ChartAxisGroup para obter detalhes.
Retornos
Comentários
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.ChartAxesLoadOptions): Excel.ChartAxes;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.ChartAxes;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.ChartAxes;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.ChartAxesUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Excel.Interfaces.ChartAxesUpdateData
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.ChartAxes): void;Parâmetros
- properties
- Excel.ChartAxes
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.ChartAxes é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ChartAxesData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.ChartAxesData;