Excel.ChartLineFormat class
Encapsula las opciones de formato de los elementos de línea.
- Extends
Comentarios
[ Conjunto de API: ExcelApi 1.1 ]
Propiedades
| color | Código de color HTML que representa el color de las líneas del gráfico. |
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| line |
Representa el estilo de línea. Vea |
| weight | Indica el grosor de la línea, en puntos. |
Métodos
| clear() | Borra el formato de línea de un elemento de gráfico. |
| 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
color
Código de color HTML que representa el color de las líneas del gráfico.
color: string;Valor de propiedad
string
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
lineStyle
Representa el estilo de línea. Vea Excel.ChartLineStyle para más información.
lineStyle: Excel.ChartLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | "Grey75" | "Automatic" | "RoundDot";Valor de propiedad
Excel.ChartLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | "Grey75" | "Automatic" | "RoundDot"
Comentarios
weight
Indica el grosor de la línea, en puntos.
weight: number;Valor de propiedad
number
Comentarios
Detalles del método
clear()
Borra el formato de línea de un elemento de gráfico.
clear(): void;Devoluciones
void
Comentarios
[ Conjunto de API: ExcelApi 1.1 ]
Ejemplos
// Clear the format of the major gridlines on Chart1.
await Excel.run(async (context) => {
const gridlines = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").axes.valueAxis.majorGridlines;
gridlines.format.line.clear();
await context.sync();
console.log("Chart Major Gridlines Format Cleared");
});
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.ChartLineFormatLoadOptions): Excel.ChartLineFormat;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.ChartLineFormat;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
Ejemplos
// Set chart major gridlines on value axis to be red.
await Excel.run(async (context) => {
const gridlines = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").axes.valueAxis.majorGridlines;
gridlines.format.line.color = "#FF0000";
await context.sync()
console.log("Chart Gridlines Color Updated");
});
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.ChartLineFormat;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.ChartLineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.ChartLineFormatUpdateData
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.ChartLineFormat): void;Parámetros
- properties
- Excel.ChartLineFormat
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.ChartLineFormat es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.ChartLineFormatData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Excel.Interfaces.ChartLineFormatData;