Excel.ChartTrendline class
Este objeto representa los atributos de un objeto de línea de tendencia del gráfico.
- Extends
Comentarios
[ Conjunto de API: ExcelApi 1.7 ]
Propiedades
| backward |
Representa el número de periodos que la línea de tendencia se extiende hacia atrás. |
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| format | Representa el formato de línea de tendencia de un gráfico. |
| forward |
Representa el número de periodos que la línea de tendencia se extiende hacia delante. |
| intercept | Representa el valor de la intersección de la línea de tendencia. Puede establecerse en un valor numérico o una cadena vacía (para valores automáticos). El valor devuelto siempre es un número. |
| label | Representa la etiqueta de una línea de tendencia del gráfico. |
| moving |
Representa el período de una línea de tendencia del gráfico. Solo se aplica a las líneas de tendencia con el tipo |
| name | Representa el nombre de la línea de tendencia. Se puede establecer en un valor de cadena, un |
| polynomial |
Representa el orden de una línea de tendencia del gráfico. Solo se aplica a las líneas de tendencia con el tipo |
| show |
True si la ecuación de la línea de tendencia se muestra en el gráfico. |
| show |
True si el valor de r cuadrado de la línea de tendencia se muestra en el gráfico. |
| type | Representa el tipo de línea de tendencia de un gráfico. |
Métodos
| delete() | Elimina el objeto de la línea de tendencia. |
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| set(properties, options) | Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo. |
| set(properties) | Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente. |
| toJSON() | Invalida el método JavaScript |
Detalles de las propiedades
backwardPeriod
Representa el número de periodos que la línea de tendencia se extiende hacia atrás.
backwardPeriod: number;Valor de propiedad
number
Comentarios
context
Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
context: RequestContext;Valor de propiedad
format
Representa el formato de línea de tendencia de un gráfico.
readonly format: Excel.ChartTrendlineFormat;Valor de propiedad
Comentarios
forwardPeriod
Representa el número de periodos que la línea de tendencia se extiende hacia delante.
forwardPeriod: number;Valor de propiedad
number
Comentarios
intercept
Representa el valor de la intersección de la línea de tendencia. Puede establecerse en un valor numérico o una cadena vacía (para valores automáticos). El valor devuelto siempre es un número.
intercept: any;Valor de propiedad
any
Comentarios
label
Representa la etiqueta de una línea de tendencia del gráfico.
readonly label: Excel.ChartTrendlineLabel;Valor de propiedad
Comentarios
movingAveragePeriod
Representa el período de una línea de tendencia del gráfico. Solo se aplica a las líneas de tendencia con el tipo MovingAverage.
movingAveragePeriod: number;Valor de propiedad
number
Comentarios
name
Representa el nombre de la línea de tendencia. Se puede establecer en un valor de cadena, un null valor representa valores automáticos. El valor devuelto siempre es una cadena
name: string;Valor de propiedad
string
Comentarios
polynomialOrder
Representa el orden de una línea de tendencia del gráfico. Solo se aplica a las líneas de tendencia con el tipo Polynomial.
polynomialOrder: number;Valor de propiedad
number
Comentarios
showEquation
True si la ecuación de la línea de tendencia se muestra en el gráfico.
showEquation: boolean;Valor de propiedad
boolean
Comentarios
showRSquared
True si el valor de r cuadrado de la línea de tendencia se muestra en el gráfico.
showRSquared: boolean;Valor de propiedad
boolean
Comentarios
type
Representa el tipo de línea de tendencia de un gráfico.
type: Excel.ChartTrendlineType | "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power";Valor de propiedad
Excel.ChartTrendlineType | "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"
Comentarios
[ Conjunto de API: ExcelApi 1.7 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-trendlines.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
let seriesCollection = sheet.charts.getItemAt(0).series;
// Get the trendline for series 1 and load its type property.
let trendline = seriesCollection.getItemAt(0).trendlines.getItem(0);
trendline.load("type");
await context.sync();
console.log("The trendline type is:" + trendline.type);
});
Detalles del método
delete()
Elimina el objeto de la línea de tendencia.
delete(): void;Devoluciones
void
Comentarios
load(options)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(options?: Excel.Interfaces.ChartTrendlineLoadOptions): Excel.ChartTrendline;Parámetros
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
load(propertyNames)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames?: string | string[]): Excel.ChartTrendline;Parámetros
- propertyNames
-
string | string[]
Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.
Devoluciones
load(propertyNamesAndPaths)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ChartTrendline;Parámetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.
Devoluciones
set(properties, options)
Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.
set(properties: Interfaces.ChartTrendlineUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.ChartTrendlineUpdateData
Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.
- options
- OfficeExtension.UpdateOptions
Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.
Devoluciones
void
set(properties)
Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
set(properties: Excel.ChartTrendline): void;Parámetros
- properties
- Excel.ChartTrendline
Devoluciones
void
toJSON()
Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.ChartTrendline es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.ChartTrendlineData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Excel.Interfaces.ChartTrendlineData;