ExcelScript.ConditionalFormat interface

Paquete:

ExcelScript

Objeto que encapsula el intervalo, el formato, la regla y otras propiedades de un formato condicional.

Métodos

delete()	Elimina este formato condicional.
getCellValue()	Devuelve las propiedades de formato condicional del valor de celda si el formato condicional actual es un CellValue tipo.
getColorScale()	Devuelve las propiedades de formato condicional de escala de colores si el formato condicional actual es un ColorScale tipo.
getCustom()	Devuelve las propiedades de formato condicional personalizado si el formato condicional actual es un tipo personalizado.
getDataBar()	Devuelve las propiedades de la barra de datos si el formato condicional actual es una barra de datos.
getIconSet()	Devuelve las propiedades de formato condicional del conjunto de iconos si el formato condicional actual es un IconSet tipo.
getId()	Prioridad del formato condicional en el objeto actual ConditionalFormatCollection.
getPreset()	Devuelve el formato condicional de los criterios preestablecidos. Consulte ExcelScript.PresetCriteriaConditionalFormatpara obtener más información.
getPriority()	Prioridad (o índice) dentro de la colección de formato condicional en la que existe actualmente este formato condicional. Cambiar esto también cambia las prioridades de otros formatos condicionales, para permitir un orden de prioridad contiguo. Use una prioridad negativa para comenzar desde atrás. Las prioridades mayores que los límites se obtienen y establecen en la prioridad máxima (o mínima si es negativa). Tenga en cuenta también que si cambia la prioridad, tendrá que volver a capturar una nueva copia del objeto en esa nueva ubicación de prioridad si desea realizar más cambios en él.
getRange()	Devuelve el intervalo al que se aplica el formato condicional. Si el formato condicional se aplica a varios intervalos, este método devuelve undefined.
getRanges()	Devuelve , RangeAreasque comprende uno o varios intervalos rectangulares, a los que se aplica el formato condicional.
getStopIfTrue()	Si se cumplen las condiciones de este formato condicional, los formatos de menor prioridad no surtirán efecto en esa celda. El valor está null en las barras de datos, los conjuntos de iconos y las escalas de colores, ya que no hay ningún concepto de StopIfTrue para ellas.
getTextComparison()	Devuelve las propiedades de formato condicional de texto específicas si el formato condicional actual es un tipo de texto. Por ejemplo, para dar formato a celdas que coincidan con la palabra "Texto".
getTopBottom()	Devuelve las propiedades de formato condicional superior e inferior si el formato condicional actual es un TopBottom tipo. Por ejemplo, para dar formato al 10 % superior o inferior 10 elementos.
getType()	Tipo de formato condicional. Solo se puede establecer uno a la vez.
setPriority(priority)	Prioridad (o índice) dentro de la colección de formato condicional en la que existe actualmente este formato condicional. Cambiar esto también cambia las prioridades de otros formatos condicionales, para permitir un orden de prioridad contiguo. Use una prioridad negativa para comenzar desde atrás. Las prioridades mayores que los límites se obtienen y establecen en la prioridad máxima (o mínima si es negativa). Tenga en cuenta también que si cambia la prioridad, tendrá que volver a capturar una nueva copia del objeto en esa nueva ubicación de prioridad si desea realizar más cambios en él.
setStopIfTrue(stopIfTrue)	Si se cumplen las condiciones de este formato condicional, los formatos de menor prioridad no surtirán efecto en esa celda. El valor está null en las barras de datos, los conjuntos de iconos y las escalas de colores, ya que no hay ningún concepto de StopIfTrue para ellas.

Detalles del método

delete()

Elimina este formato condicional.

delete(): void;

Devoluciones

void

getCellValue()

Devuelve las propiedades de formato condicional del valor de celda si el formato condicional actual es un CellValue tipo.

getCellValue(): CellValueConditionalFormat | undefined;

Devoluciones

ExcelScript.CellValueConditionalFormat | undefined

Ejemplos

/**
 * This script applies conditional formatting to a range.
 * That formatting is conditional upon the cell's numerical value.
 * Any value between 50 and 75 will have the cell fill color changed and the font made italic.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range to format.
  const sheet = workbook.getActiveWorksheet();
  const ratingColumn = sheet.getRange("D2:D20");

  // Add cell value conditional formatting.
  const cellValueConditionalFormatting =
    ratingColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValue).getCellValue();
  
  // Create the condition, in this case when the cell value is between 50 and 75.
  let rule: ExcelScript.ConditionalCellValueRule = {
    formula1: "50",
    formula2: "75",
    operator: ExcelScript.ConditionalCellValueOperator.between
  };
  cellValueConditionalFormatting.setRule(rule);

  // Set the format to apply when the condition is met.
  let format = cellValueConditionalFormatting.getFormat();
  format.getFill().setColor("yellow");
  format.getFont().setItalic(true);

}

getColorScale()

Devuelve las propiedades de formato condicional de escala de colores si el formato condicional actual es un ColorScale tipo.

getColorScale(): ColorScaleConditionalFormat | undefined;

Devoluciones

ExcelScript.ColorScaleConditionalFormat | undefined

Ejemplos

/**
 * This script applies a red, white, and blue color scale to the selected range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the selected range.
  let selectedRange = workbook.getSelectedRange();

  // Create a new conditional formatting object by adding one to the range.
  let conditionalFormatting = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.colorScale);

  // Set the colors for the three parts of the scale: minimum, midpoint, and maximum.
  conditionalFormatting.getColorScale().setCriteria({
    minimum: {
      color:"#F8696B", /* A pale red. */
      type:ExcelScript.ConditionalFormatColorCriterionType.lowestValue
    },
    midpoint: {
      color: "#FCFCFF", /* Slightly off-white. */
      formula:'=50',type:ExcelScript.ConditionalFormatColorCriterionType.percentile
    },
    maximum: {
      color: "#5A8AC6", /* A pale blue. */
      type:ExcelScript.ConditionalFormatColorCriterionType.highestValue
    }
  });
}

getCustom()

Devuelve las propiedades de formato condicional personalizado si el formato condicional actual es un tipo personalizado.

getCustom(): CustomConditionalFormat | undefined;

Devoluciones

ExcelScript.CustomConditionalFormat | undefined

Ejemplos

/**
 * This script applies a custom conditional formatting to the selected range.
 * A light-green fill is applied to a cell if the value is larger than the value in the row's previous column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the selected cells.
  let selectedRange = workbook.getSelectedRange();

  // Apply a rule for positive change from the previous column.
  let positiveChange = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom);
  positiveChange.getCustom().getFormat().getFill().setColor("lightgreen");
  positiveChange.getCustom().getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}>${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`);
}

getDataBar()

Devuelve las propiedades de la barra de datos si el formato condicional actual es una barra de datos.

getDataBar(): DataBarConditionalFormat | undefined;

Devoluciones

ExcelScript.DataBarConditionalFormat | undefined

Ejemplos

/**
 * This script creates data bar conditional formatting on the selected range.
 * The scale of the data bar goes from 0 to 1000.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the selected range.
  const selected = workbook.getSelectedRange();
  
  // Create new conditional formatting on the range.
  const format = selected.addConditionalFormat(ExcelScript.ConditionalFormatType.dataBar);
  const dataBarFormat = format.getDataBar();

  // Set the lower bound of the data bar formatting to be 0.
  const lowerBound: ExcelScript.ConditionalDataBarRule = {
    type: ExcelScript.ConditionalFormatRuleType.number,
    formula: "0"
  };
  dataBarFormat.setLowerBoundRule(lowerBound);

  // Set the upper bound of the data bar formatting to be 1000.
  const upperBound: ExcelScript.ConditionalDataBarRule = {
    type: ExcelScript.ConditionalFormatRuleType.number,
    formula: "1000"
  };
  dataBarFormat.setUpperBoundRule(upperBound);
}

getIconSet()

Devuelve las propiedades de formato condicional del conjunto de iconos si el formato condicional actual es un IconSet tipo.

getIconSet(): IconSetConditionalFormat | undefined;

Devoluciones

ExcelScript.IconSetConditionalFormat | undefined

Ejemplos

/**
 * This script applies icon set conditional formatting to a range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range "A1:A5" on the current worksheet.
  const sheet = workbook.getActiveWorksheet();
  const range = sheet.getRange("A1:A5");

  // Create icon set conditional formatting on the range.
  const conditionalFormatting = range.addConditionalFormat(ExcelScript.ConditionalFormatType.iconSet);

  // Use the "3 Traffic Lights (Unrimmed)" set.
  conditionalFormatting.getIconSet().setStyle(ExcelScript.IconSet.threeTrafficLights1);

  // Set the criteria to use a different icon for the bottom, middle, and top thirds of the values in the range.
  conditionalFormatting.getIconSet().setCriteria([
    {
      formula:'=0',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
      type:ExcelScript.ConditionalFormatIconRuleType.percent
    },
    {
      formula:'=33',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
      type:ExcelScript.ConditionalFormatIconRuleType.percent},
    {
      formula:'=67',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
      type:ExcelScript.ConditionalFormatIconRuleType.percent
    }]);
}

getId()

Prioridad del formato condicional en el objeto actual ConditionalFormatCollection.

getId(): string;

Devoluciones

string

getPreset()

Devuelve el formato condicional de los criterios preestablecidos. Consulte ExcelScript.PresetCriteriaConditionalFormatpara obtener más información.

getPreset(): PresetCriteriaConditionalFormat | undefined;

Devoluciones

ExcelScript.PresetCriteriaConditionalFormat | undefined

Ejemplos

/**
 * This script applies a conditional format that uses a preset criterion.
 * Any cell in row 1 will have the color fill set to green if it is a duplicate value
 * (of anything else in row 1).
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range for row 1.
  const sheet = workbook.getActiveWorksheet();
  const formattedRange = sheet.getRange("1:1");

  // Add new conditional formatting to that range.
  const conditionalFormat = formattedRange.addConditionalFormat(
    ExcelScript.ConditionalFormatType.presetCriteria);

  // Set the conditional formatting to apply a green fill.
  const presetFormat = conditionalFormat.getPreset();
  presetFormat.getFormat().getFill().setColor("green");

  // Set a rule to apply the conditional format when values are duplicated in the range.
  const duplicateRule: ExcelScript.ConditionalPresetCriteriaRule = {
    criterion: ExcelScript.ConditionalFormatPresetCriterion.duplicateValues
  };
  presetFormat.setRule(duplicateRule);
}

getPriority()

Prioridad (o índice) dentro de la colección de formato condicional en la que existe actualmente este formato condicional. Cambiar esto también cambia las prioridades de otros formatos condicionales, para permitir un orden de prioridad contiguo. Use una prioridad negativa para comenzar desde atrás. Las prioridades mayores que los límites se obtienen y establecen en la prioridad máxima (o mínima si es negativa). Tenga en cuenta también que si cambia la prioridad, tendrá que volver a capturar una nueva copia del objeto en esa nueva ubicación de prioridad si desea realizar más cambios en él.

getPriority(): number;

Devoluciones

number

getRange()

Devuelve el intervalo al que se aplica el formato condicional. Si el formato condicional se aplica a varios intervalos, este método devuelve undefined.

getRange(): Range;

Devoluciones

ExcelScript.Range

getRanges()

Devuelve , RangeAreasque comprende uno o varios intervalos rectangulares, a los que se aplica el formato condicional.

getRanges(): RangeAreas;

Devoluciones

ExcelScript.RangeAreas

getStopIfTrue()

Si se cumplen las condiciones de este formato condicional, los formatos de menor prioridad no surtirán efecto en esa celda. El valor está null en las barras de datos, los conjuntos de iconos y las escalas de colores, ya que no hay ningún concepto de StopIfTrue para ellas.

getStopIfTrue(): boolean;

Devoluciones

boolean

getTextComparison()

Devuelve las propiedades de formato condicional de texto específicas si el formato condicional actual es un tipo de texto. Por ejemplo, para dar formato a celdas que coincidan con la palabra "Texto".

getTextComparison(): TextConditionalFormat | undefined;

Devoluciones

ExcelScript.TextConditionalFormat | undefined

Ejemplos

/**
 * This script adds conditional formatting to the first column in the worksheet.
 * This formatting gives the cells a green fill if they have text starting with "Excel".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first column in the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const firstColumn = currentSheet.getRange("A:A");

  // Add conditional formatting based on the text in the cells.
  const textConditionFormat = 
    firstColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.containsText).getTextComparison();

  // Set the conditional format to provide a green fill.
  textConditionFormat.getFormat().getFill().setColor("green");

  // Apply the condition rule that the text begins with "Excel".
  const textRule: ExcelScript.ConditionalTextComparisonRule = {
    operator: ExcelScript.ConditionalTextOperator.beginsWith,
    text: "Excel"
  };
  textConditionFormat.setRule(textRule);
}

getTopBottom()

Devuelve las propiedades de formato condicional superior e inferior si el formato condicional actual es un TopBottom tipo. Por ejemplo, para dar formato al 10 % superior o inferior 10 elementos.

getTopBottom(): TopBottomConditionalFormat | undefined;

Devoluciones

ExcelScript.TopBottomConditionalFormat | undefined

Ejemplos

/**
 * This script applies top/bottom conditional formatting to a range.
 * The top 2 values in the range will have the cell fill color changed to green.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range to format.
  const sheet = workbook.getWorksheet("TopBottom");
  const dataRange = sheet.getRange("B2:D5");

  // Set the fill color to green for the top 2 values in the range.
  const topBottomFormat = dataRange.addConditionalFormat(
    ExcelScript.ConditionalFormatType.topBottom).getTopBottom();
  topBottomFormat.getFormat().getFill().setColor("green");
  topBottomFormat.setRule({
    rank: 2, /* The numeric threshold. */
    type: ExcelScript.ConditionalTopBottomCriterionType.topItems /* The type of the top/bottom condition. */
  });
}

getType()

Tipo de formato condicional. Solo se puede establecer uno a la vez.

getType(): ConditionalFormatType;

Devoluciones

ExcelScript.ConditionalFormatType

setPriority(priority)

Prioridad (o índice) dentro de la colección de formato condicional en la que existe actualmente este formato condicional. Cambiar esto también cambia las prioridades de otros formatos condicionales, para permitir un orden de prioridad contiguo. Use una prioridad negativa para comenzar desde atrás. Las prioridades mayores que los límites se obtienen y establecen en la prioridad máxima (o mínima si es negativa). Tenga en cuenta también que si cambia la prioridad, tendrá que volver a capturar una nueva copia del objeto en esa nueva ubicación de prioridad si desea realizar más cambios en él.

setPriority(priority: number): void;

Parámetros

priority

number

Devoluciones

void

setStopIfTrue(stopIfTrue)

Si se cumplen las condiciones de este formato condicional, los formatos de menor prioridad no surtirán efecto en esa celda. El valor está null en las barras de datos, los conjuntos de iconos y las escalas de colores, ya que no hay ningún concepto de StopIfTrue para ellas.

setStopIfTrue(stopIfTrue: boolean): void;

Parámetros

stopIfTrue

boolean

Devoluciones

void