Excel.DataBarConditionalFormat class
Representa un tipo de barra de datos condicional de Excel.
- Extends
Comentarios
[ Conjunto de API: ExcelApi 1.6 ]
Propiedades
| axis |
Código de color HTML que representa el color de la línea Axis, en el formato #RRGGBB (por ejemplo, "FFA500") o como un color HTML con nombre (por ejemplo, "naranja"). El valor es "" (una cadena vacía) si no hay ningún eje presente o establecido. |
| axis |
Representación de cómo se determina el eje para una barra de datos de Excel. |
| bar |
Especifica la dirección en la que se debe basar el gráfico de la barra de datos. |
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| lower |
Regla para lo que constituye el límite inferior (y cómo calcularlo, si procede) para una barra de datos. El |
| negative |
Representación de todos los valores a la izquierda del eje en una barra de datos de Excel. |
| positive |
Representación de todos los valores a la derecha del eje en una barra de datos de Excel. |
| show |
Si |
| upper |
Regla de lo que constituye el límite superior (y cómo calcularlo, si es aplicable) de una barra de datos. El |
Métodos
| 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
axisColor
Código de color HTML que representa el color de la línea Axis, en el formato #RRGGBB (por ejemplo, "FFA500") o como un color HTML con nombre (por ejemplo, "naranja"). El valor es "" (una cadena vacía) si no hay ningún eje presente o establecido.
axisColor: string;Valor de propiedad
string
Comentarios
axisFormat
Representación de cómo se determina el eje para una barra de datos de Excel.
axisFormat: Excel.ConditionalDataBarAxisFormat | "Automatic" | "None" | "CellMidPoint";Valor de propiedad
Excel.ConditionalDataBarAxisFormat | "Automatic" | "None" | "CellMidPoint"
Comentarios
barDirection
Especifica la dirección en la que se debe basar el gráfico de la barra de datos.
barDirection: Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft";Valor de propiedad
Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft"
Comentarios
[ Conjunto de API: ExcelApi 1.6 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const range = sheet.getRange("B8:E13");
const conditionalFormat = range.conditionalFormats
.add(Excel.ConditionalFormatType.dataBar);
conditionalFormat.dataBar.barDirection = Excel.ConditionalDataBarDirection.leftToRight;
await context.sync();
});
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
lowerBoundRule
Regla para lo que constituye el límite inferior (y cómo calcularlo, si procede) para una barra de datos. El ConditionalDataBarRule objeto debe establecerse como un objeto JSON (use x.lowerBoundRule = {...} en lugar de x.lowerBoundRule.formula = ...).
lowerBoundRule: Excel.ConditionalDataBarRule;Valor de propiedad
Comentarios
negativeFormat
Representación de todos los valores a la izquierda del eje en una barra de datos de Excel.
readonly negativeFormat: Excel.ConditionalDataBarNegativeFormat;Valor de propiedad
Comentarios
positiveFormat
Representación de todos los valores a la derecha del eje en una barra de datos de Excel.
readonly positiveFormat: Excel.ConditionalDataBarPositiveFormat;Valor de propiedad
Comentarios
showDataBarOnly
Si truees , oculta los valores de las celdas donde se aplica la barra de datos.
showDataBarOnly: boolean;Valor de propiedad
boolean
Comentarios
upperBoundRule
Regla de lo que constituye el límite superior (y cómo calcularlo, si es aplicable) de una barra de datos. El ConditionalDataBarRule objeto debe establecerse como un objeto JSON (use x.upperBoundRule = {...} en lugar de x.upperBoundRule.formula = ...).
upperBoundRule: Excel.ConditionalDataBarRule;Valor de propiedad
Comentarios
Detalles del método
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.DataBarConditionalFormatLoadOptions): Excel.DataBarConditionalFormat;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.DataBarConditionalFormat;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.DataBarConditionalFormat;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.DataBarConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
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.DataBarConditionalFormat): void;Parámetros
- properties
- Excel.DataBarConditionalFormat
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 Excel.DataBarConditionalFormat original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.DataBarConditionalFormatData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Excel.Interfaces.DataBarConditionalFormatData;