Excel.ConditionalFormatCollection class
Representa una colección de todos los formatos condicionales que se superponen al intervalo.
- Extends
Comentarios
[ Conjunto de API: ExcelApi 1.6 ]
Propiedades
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| items | Obtiene los elementos secundarios cargados en esta colección. |
Métodos
| add(type) | Agrega un nuevo formato condicional a la colección con la prioridad primera o superior. |
| add(type |
Agrega un nuevo formato condicional a la colección con la prioridad primera o superior. |
| clear |
Borra todos los formatos condicionales activos en el intervalo actual especificado. |
| get |
Devuelve el número de formatos condicionales del libro. |
| get |
Devuelve un formato condicional para el identificador especificado. |
| get |
Devuelve un formato condicional en el índice especificado. |
| get |
Devuelve un formato condicional identificado por su identificador. Si el objeto de formato condicional no existe, este método devuelve un objeto con su |
| 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 |
| toJSON() | Invalida el método JavaScript |
Detalles de las propiedades
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
items
Obtiene los elementos secundarios cargados en esta colección.
readonly items: Excel.ConditionalFormat[];Valor de propiedad
Detalles del método
add(type)
Agrega un nuevo formato condicional a la colección con la prioridad primera o superior.
add(type: Excel.ConditionalFormatType): Excel.ConditionalFormat;Parámetros
Tipo de formato condicional que se va a agregar. Vea Excel.ConditionalFormatType para más información.
Devoluciones
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("B2:M5");
const conditionalFormat = range.conditionalFormats
.add(Excel.ConditionalFormatType.colorScale);
const criteria = {
minimum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.lowestValue, color: "blue" },
midpoint: { formula: "50", type: Excel.ConditionalFormatColorCriterionType.percent, color: "yellow" },
maximum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.highestValue, color: "red" }
};
conditionalFormat.colorScale.criteria = criteria;
await context.sync();
});
add(typeString)
Agrega un nuevo formato condicional a la colección con la prioridad primera o superior.
add(typeString: "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"): Excel.ConditionalFormat;Parámetros
- typeString
-
"Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"
Tipo de formato condicional que se va a agregar. Vea Excel.ConditionalFormatType para más información.
Devoluciones
Comentarios
clearAll()
Borra todos los formatos condicionales activos en el intervalo actual especificado.
clearAll(): void;Devoluciones
void
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();
range.conditionalFormats.clearAll();
await context.sync();
$(".conditional-formats").hide();
});
getCount()
Devuelve el número de formatos condicionales del libro.
getCount(): OfficeExtension.ClientResult<number>;Devoluciones
OfficeExtension.ClientResult<number>
Comentarios
[ Conjunto de API: ExcelApi 1.6 ]
Ejemplos
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "A1:C3";
const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
const conditionalFormat = range.conditionalFormats.add(Excel.ConditionalFormatType.iconSet);
conditionalFormat.iconSetOrNullObject.style = Excel.IconSet.fourTrafficLights;
const cfCount = range.conditionalFormats.getCount();
await context.sync()
console.log("Count: " + cfCount.value);
});
getItem(id)
Devuelve un formato condicional para el identificador especificado.
getItem(id: string): Excel.ConditionalFormat;Parámetros
- id
-
string
Identificador del formato condicional.
Devoluciones
Objeto de formato condicional.
Comentarios
[ Conjunto de API: ExcelApi 1.6 ]
Ejemplos
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "A1:C3";
const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
const conditionalFormats = range.conditionalFormats;
const conditionalFormat = conditionalFormats.getItemAt(3);
await context.sync()
console.log("Conditional Format at Item 3 Loaded");
});
getItemAt(index)
Devuelve un formato condicional en el índice especificado.
getItemAt(index: number): Excel.ConditionalFormat;Parámetros
- index
-
number
Índice de los formatos condicionales que se van a recuperar.
Devoluciones
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 worksheetRange = sheet.getRange();
worksheetRange.conditionalFormats.load("type");
await context.sync();
let cfRangePairs: { cf: Excel.ConditionalFormat, range: Excel.Range }[] = [];
worksheetRange.conditionalFormats.items.forEach(item => {
cfRangePairs.push({
cf: item,
range: item.getRange().load("address")
});
});
await context.sync();
if (cfRangePairs.length > 0) {
cfRangePairs.forEach(item => {
console.log(item.cf.type);
});
} else {
console.log("No conditional formats applied.");
}
});
getItemOrNullObject(id)
Devuelve un formato condicional identificado por su identificador. Si el objeto de formato condicional no existe, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
getItemOrNullObject(id: string): Excel.ConditionalFormat;Parámetros
- id
-
string
Identificador del formato condicional.
Devoluciones
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.ConditionalFormatCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalFormatCollection;Parámetros
- options
-
Excel.Interfaces.ConditionalFormatCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
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.ConditionalFormatCollection;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?: OfficeExtension.LoadOption): Excel.ConditionalFormatCollection;Parámetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
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.ConditionalFormatCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.ConditionalFormatCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.
toJSON(): Excel.Interfaces.ConditionalFormatCollectionData;