Excel.IconSetConditionalFormat class

Paquete:: excel

Representa un conjunto de criterios de iconos para el formato condicional.

Extends: OfficeExtension.ClientObject

Comentarios

[Conjunto de API: ExcelApi 1.6]

Propiedades

context	El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.
criteria	Una matriz de criterios y conjuntos de iconos para las reglas y posibles iconos personalizados para los iconos condicionales. Tenga en cuenta que para el primer criterio solo se puede modificar el icono personalizado, mientras que el tipo, la fórmula y el operador se omitirán cuando se establezcan.
reverseIconOrder	Si `true`, invierte el orden de los iconos del conjunto de iconos. Tenga en cuenta que esto no se puede establecer si se usan iconos personalizados.
showIconOnly	Si `true`, oculta los valores y solo muestra los iconos.
style	Si se establece, muestra la opción de conjunto de iconos para el formato condicional.

Métodos

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(propertyNames)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a `context.sync()` antes de leer las propiedades.
load(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a `context.sync()` antes de leer las propiedades.
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 API del mismo tipo.
set(properties)	Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente.
toJSON()	Reemplaza el método JavaScript `toJSON()` para proporcionar una salida más útil cuando se pasa un objeto API a `JSON.stringify()`. (`JSON.stringify`, a su vez, llama al `toJSON` método del objeto que se le pasa). Mientras que el objeto original `Excel.IconSetConditionalFormat` es un objeto API, el `toJSON` método devuelve un objeto JavaScript simple (escrito como `Excel.Interfaces.IconSetConditionalFormatData`) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

Detalles de las propiedades

context

El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Excel.RequestContext

criteria

Una matriz de criterios y conjuntos de iconos para las reglas y posibles iconos personalizados para los iconos condicionales. Tenga en cuenta que para el primer criterio solo se puede modificar el icono personalizado, mientras que el tipo, la fórmula y el operador se omitirán cuando se establezcan.

criteria: Excel.ConditionalIconCriterion[];

Valor de propiedad

Excel.ConditionalIconCriterion[]

Comentarios

[Conjunto de API: ExcelApi 1.6]

reverseIconOrder

Si true, invierte el orden de los iconos del conjunto de iconos. Tenga en cuenta que esto no se puede establecer si se usan iconos personalizados.

reverseIconOrder: boolean;

Valor de propiedad

boolean

Comentarios

[Conjunto de API: ExcelApi 1.6]

showIconOnly

Si true, oculta los valores y solo muestra los iconos.

showIconOnly: boolean;

Valor de propiedad

boolean

Comentarios

[Conjunto de API: ExcelApi 1.6]

style

Si se establece, muestra la opción de conjunto de iconos para el formato condicional.

style: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes";

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.6]

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.IconSetConditionalFormatLoadOptions): Excel.IconSetConditionalFormat;

Parámetros

options: Excel.Interfaces.IconSetConditionalFormatLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.IconSetConditionalFormat

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.IconSetConditionalFormat;

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

Excel.IconSetConditionalFormat

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.IconSetConditionalFormat;

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

Excel.IconSetConditionalFormat

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 API del mismo tipo.

set(properties: Interfaces.IconSetConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties: Excel.Interfaces.IconSetConditionalFormatUpdateData

Un objeto JavaScript con propiedades que están estructuradas isomorfamente a las propiedades del objeto en el 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, basadas en un objeto cargado existente.

set(properties: Excel.IconSetConditionalFormat): void;

Parámetros

properties: Excel.IconSetConditionalFormat

Devoluciones

void

toJSON()

Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.IconSetConditionalFormat es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.IconSetConditionalFormatData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

toJSON(): Excel.Interfaces.IconSetConditionalFormatData;

Devoluciones

Excel.Interfaces.IconSetConditionalFormatData

Comentarios

¿Le ha resultado útil esta página?