Новые возможности API JavaScript для Excel 1.6What's new in Excel JavaScript API 1.6

Условное форматированиеConditional formatting

Добавлена возможность условного форматирования диапазона.Introduces conditional formating of a range. Допускаются следующие типы условного форматирования:Allows the following types of conditional formatting:

  • Цветовая шкалаColor scale
  • ГистограммаData bar
  • Набор значковIcon set
  • НастраиваемыйCustom

Дополнительно:In addition:

  • Возврат диапазона, к которому применено условное форматирование.Returns the range the conditional format is applied to.
  • Удаление условного форматирования.Removal of conditional formatting.
  • Предоставляет приоритет и stopifTrue возможности.Provides priority and stopifTrue capability.
  • Получение полной коллекции условного форматирования для определенного диапазона.Get collection of all conditional formatting on a given range.
  • Полное удаление условного форматирование в указанном диапазоне.Clears all conditional formats active on the current specified range.

Список APIAPI list

В следующей таблице перечислены API в наборе обязательных элементов API JavaScript для Excel 1,6.The following table lists the APIs in Excel JavaScript API requirement set 1.6. Чтобы просмотреть справочную документацию по API для всех API, поддерживаемых набором обязательных элементов API JavaScript для Excel 1,6 или более ранней версии, обратитесь к разделам API Excel в наборе требований 1,6To view API reference documentation for all APIs supported by Excel JavaScript API requirement set 1.6 or earlier, see Excel APIs in requirement set 1.6 or earlier.

КлассClass ПоляFields ОписаниеDescription
ApplicationApplication Суспендапикалкулатионунтилнекстсинк ()suspendApiCalculationUntilNextSync() Приостанавливает вычисление до вызова следующего "context.sync()". После этого за пересчет книги и распространение всех зависимостей несет ответственность разработчик.Suspends calculation until the next "context.sync()" is called. Once set, it is the developer's responsibility to re-calc the workbook, to ensure that any dependencies are propagated.
ЦеллвалуекондитионалформатCellValueConditionalFormat formatformat Возвращает объект Format, который инкапсулирует шрифты условного форматирования, заливки, границы и другие свойства.Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.
правилаrule Представляет объект Rule в этом условном форматировании.Represents the Rule object on this conditional format.
КолорскалекондитионалформатColorScaleConditionalFormat criteriacriteria Критерии цветовой шкалы.The criteria of the color scale. При использовании цветовой шкалы с двумя координатами средняя точка является необязательной.Midpoint is optional when using a two point color scale.
СриколорскалеthreeColorScale Если задано значение true, цветовая шкала будет иметь три точки (минимальная, средняя, максимальная), в противном случае будет существовать два (минимум, максимум).If true the color scale will have three points (minimum, midpoint, maximum), otherwise it will have two (minimum, maximum).
ConditionalCellValueRuleConditionalCellValueRule Formula1formula1 Формула, с помощью которой при необходимости оценивается правило условного форматирования.The formula, if required, to evaluate the conditional format rule on.
formula2formula2 Формула, с помощью которой при необходимости оценивается правило условного форматирования.The formula, if required, to evaluate the conditional format rule on.
oroperator Оператор условного форматирования текста.The operator of the text conditional format.
КондитионалколорскалекритериаConditionalColorScaleCriteria maximummaximum Условие цветовой шкалы "максимальная точка".The maximum point Color Scale Criterion.
точкаmidpoint Условие цветовой шкалы "средняя точка", если используется трехцветная цветовая шкала.The midpoint Color Scale Criterion if the color scale is a 3-color scale.
minimumminimum Условие цветовой шкалы "минимальная точка".The minimum point Color Scale Criterion.
КондитионалколорскалекритерионConditionalColorScaleCriterion colorcolor Цветовое HTML-представление цвета цветовой шкалы.HTML color code representation of the color scale color. Например,E.g. #FF0000 обозначает красный.#FF0000 represents Red.
formulaformula Число, формула или значение NULL (если указан тип LowestValue).A number, a formula, or null (if Type is LowestValue).
typetype Какова должна основываться Условная формула условия.What the criterion conditional formula should be based on.
КондитионалдатабарнегативеформатConditionalDataBarNegativeFormat borderColorborderColor HTML-код, представляющий цвет линии границы в виде #RRGGBB (например, FFA500) или в виде ключевого слова (например, orange).HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").
fillColorfillColor HTML-код, представляющий цвет заливки в виде #RRGGBB (например, FFA500) или в виде ключевого слова (например, orange).HTML color code representing the fill color, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").
МатчпоситивебордерколорmatchPositiveBorderColor Указывает, имеет ли отрицательная гистограмма тот же цвет границы, что и положительная.Boolean representation of whether or not the negative DataBar has the same border color as the positive DataBar.
МатчпоситивефиллколорmatchPositiveFillColor Указывает, имеет ли отрицательная гистограмма тот же цвет заливки, что и положительная.Boolean representation of whether or not the negative DataBar has the same fill color as the positive DataBar.
КондитионалдатабарпоситивеформатConditionalDataBarPositiveFormat borderColorborderColor HTML-код, представляющий цвет линии границы в виде #RRGGBB (например, FFA500) или в виде ключевого слова (например, orange).HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").
fillColorfillColor HTML-код, представляющий цвет заливки в виде #RRGGBB (например, FFA500) или в виде ключевого слова (например, orange).HTML color code representing the fill color, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").
ГрадиентфиллgradientFill Логическое значение, которое указывает, имеет ли гистограмма градиент.Boolean representation of whether or not the DataBar has a gradient.
КондитионалдатабаррулеConditionalDataBarRule formulaformula Формула, с помощью которой при необходимости оценивается правило гистограммы.The formula, if required, to evaluate the databar rule on.
typetype Тип правила для гистограмма.The type of rule for the databar.
ConditionalFormatConditionalFormat delete()delete() Удаляет это условное форматирование.Deletes this conditional format.
getRange()getRange() Возврат диапазона, к которому применено условное форматирование.Returns the range the conditonal format is applied to. Выдает ошибку, если условное форматирование применяется к нескольким диапазонам.Throws an error if the conditional format is applied to multiple ranges. Только для чтения.Read-only.
getRangeOrNullObject()getRangeOrNullObject() Возвращает диапазон, к которому применяется формат кондитонал, или пустой объект, если условное форматирование применяется к нескольким диапазонам.Returns the range the conditonal format is applied to, or a null object if the conditional format is applied to multiple ranges. Только для чтения.Read-only.
важнуюpriority Приоритет (или индекс) в коллекции условных форматов, в которой в настоящее время существует данное условное форматирование.The priority (or index) within the conditional format collection that this conditional format currently exists in. Изменение такжеChanging this also
cellValuecellValue Возвращает свойства условного форматирования значения ячейки, если текущим условным форматированием является тип CellValue.Returns the cell value conditional format properties if the current conditional format is a CellValue type.
ЦеллвалуеорнуллобжектcellValueOrNullObject Возвращает свойства условного форматирования значения ячейки, если текущим условным форматированием является тип CellValue.Returns the cell value conditional format properties if the current conditional format is a CellValue type.
СправаcolorScale Возвращает свойства условного форматирования цветовой шкалы, если текущим условным форматированием является тип цветовой шкалы.Returns the ColorScale conditional format properties if the current conditional format is an ColorScale type. Только для чтения.Read-only.
КолорскалеорнуллобжектcolorScaleOrNullObject Возвращает свойства условного форматирования цветовой шкалы, если текущим условным форматированием является тип цветовой шкалы.Returns the ColorScale conditional format properties if the current conditional format is an ColorScale type. Только для чтения.Read-only.
собственныйcustom Возвращает свойства настраиваемого условного форматирования, если текущим условным форматированием является настраиваемый тип.Returns the custom conditional format properties if the current conditional format is a custom type. Только для чтения.Read-only.
КустоморнуллобжектcustomOrNullObject Возвращает свойства настраиваемого условного форматирования, если текущим условным форматированием является настраиваемый тип.Returns the custom conditional format properties if the current conditional format is a custom type. Только для чтения.Read-only.
ГистограммаdataBar Возвращает свойства гистограммы, если текущим условным форматированием является панель данных.Returns the data bar properties if the current conditional format is a data bar. Только для чтения.Read-only.
ДатабарорнуллобжектdataBarOrNullObject Возвращает свойства гистограммы, если текущим условным форматированием является панель данных.Returns the data bar properties if the current conditional format is a data bar. Только для чтения.Read-only.
iconSeticonSet Возвращает свойства условного форматирования набора значков, если текущим условным форматированием является тип набора значков.Returns the IconSet conditional format properties if the current conditional format is an IconSet type. Только для чтения.Read-only.
ИконсеторнуллобжектiconSetOrNullObject Возвращает свойства условного форматирования набора значков, если текущим условным форматированием является тип набора значков.Returns the IconSet conditional format properties if the current conditional format is an IconSet type. Только для чтения.Read-only.
idid Приоритет условного форматирования в пределах текущего класса ConditionalFormatCollection.The Priority of the Conditional Format within the current ConditionalFormatCollection. Только для чтения.Read-only.
набораpreset Возвращает условное форматирование предварительно установленных условий.Returns the preset criteria conditional format. Дополнительные сведения см. в статье Excel. Пресеткритериакондитионалформат.See Excel.PresetCriteriaConditionalFormat for more details.
ПресеторнуллобжектpresetOrNullObject Возвращает условное форматирование предварительно установленных условий.Returns the preset criteria conditional format. Дополнительные сведения см. в статье Excel. Пресеткритериакондитионалформат.See Excel.PresetCriteriaConditionalFormat for more details.
ТексткомпарисонtextComparison Возвращает определенные свойства условного форматирования текста, если текущим условным форматированием является текстовый тип.Returns the specific text conditional format properties if the current conditional format is a text type.
ТексткомпарисонорнуллобжектtextComparisonOrNullObject Возвращает определенные свойства условного форматирования текста, если текущим условным форматированием является текстовый тип.Returns the specific text conditional format properties if the current conditional format is a text type.
topBottomtopBottom Возвращает верхнее и нижнее свойства условного форматирования, если текущее условное форматирование имеет тип TopBottom.Returns the Top/Bottom conditional format properties if the current conditional format is an TopBottom type.
ТопботтоморнуллобжектtopBottomOrNullObject Возвращает верхнее и нижнее свойства условного форматирования, если текущее условное форматирование имеет тип TopBottom.Returns the Top/Bottom conditional format properties if the current conditional format is an TopBottom type.
typetype Тип условного форматирования.A type of conditional format. В каждый момент времени можно задать только один из них.Only one can be set at a time. Только для чтения.Read-only.
stopIfTruestopIfTrue Если выполняются условия этого условного форматирования, форматы с более низким приоритетом не будут применяться в этой ячейке.If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell.
КондитионалформатколлектионConditionalFormatCollection Добавить (тип: Excel. Кондитионалформаттипе)add(type: Excel.ConditionalFormatType) Добавляет новое условное форматирование в коллекцию по первому или верхнему приоритету.Adds a new conditional format to the collection at the first/top priority.
clearAll ()clearAll() Полное удаление условного форматирование в указанном диапазоне.Clears all conditional formats active on the current specified range.
getCount()getCount() Возвращает число условных форматов в книге.Returns the number of conditional formats in the workbook. Только для чтения.Read-only.
getItem(id: string)getItem(id: string) Возвращает условное форматирование для указанного идентификатора.Returns a conditional format for the given ID.
getItemAt(index: number)getItemAt(index: number) Возвращает условное форматирование по индексу.Returns a conditional format at the given index.
itemsitems Получает загруженные дочерние элементы в этой коллекции.Gets the loaded child items in this collection.
ConditionalFormatRuleConditionalFormatRule formulaformula Формула, с помощью которой при необходимости оценивается правило условного форматирования.The formula, if required, to evaluate the conditional format rule on.
formulaLocalformulaLocal Формула, с помощью которой при необходимости оценивается правило условного форматирования на языке пользователя.The formula, if required, to evaluate the conditional format rule on in the user's language.
formulaR1C1formulaR1C1 Формула, с помощью которой при необходимости оценивается правило условного форматирования в формате R1C1.The formula, if required, to evaluate the conditional format rule on in R1C1-style notation.
ConditionalIconCriterionConditionalIconCriterion КустомиконcustomIcon Специальный значок для текущего условия, если он отличается от набора значков по умолчанию, в противном случае возвращается значение NULL.The custom icon for the current criterion if different from the default IconSet, else null will be returned.
formulaformula Число или формула в зависимости от типа.A number or a formula depending on the type.
oroperator GreaterThan или Греатерсанорекуал для каждого типа правила для условного форматирования значка.GreaterThan or GreaterThanOrEqual for each of the rule type for the Icon conditional format.
typetype На чем должна основываться условная формула значка.What the icon conditional formula should be based on.
ConditionalPresetCriteriaRuleConditionalPresetCriteriaRule текущегоcriterion Критерий условного форматирования.The criterion of the conditional format.
КондитионалранжебордерConditionalRangeBorder colorcolor HTML-код, представляющий цвет линии границы в виде #RRGGBB (например, FFA500) или в виде ключевого слова (например, orange).HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").
СидеиндексsideIndex Постоянное значение, указывающее определенную сторону границы.Constant value that indicates the specific side of the border. Дополнительные сведения см. в статье Excel. Кондитионалранжебордериндекс.See Excel.ConditionalRangeBorderIndex for details. Только для чтения.Read-only.
stylestyle Одна из констант стиля линии, определяющая стиль линии границы.One of the constants of line style specifying the line style for the border. Дополнительные сведения см. в статье Excel. Бордерлинестиле.See Excel.BorderLineStyle for details.
КондитионалранжебордерколлектионConditionalRangeBorderCollection GetItem (index: Excel. Кондитионалранжебордериндекс)getItem(index: Excel.ConditionalRangeBorderIndex) Возвращает объект границы по его имени.Gets a border object using its name.
getItemAt(index: number)getItemAt(index: number) Возвращает объект границы по его индексу.Gets a border object using its index.
bottombottom Получает нижнюю границу.Gets the bottom border. Только для чтения.Read-only.
countcount Количество объектов границы в коллекции.Number of border objects in the collection. Только для чтения.Read-only.
itemsitems Получает загруженные дочерние элементы в этой коллекции.Gets the loaded child items in this collection.
leftleft Получает левую границу.Gets the left border. Только для чтения.Read-only.
rightright Получает правую границу.Gets the right border. Только для чтения.Read-only.
toptop Получает верхнюю границу.Gets the top border. Только для чтения.Read-only.
КондитионалранжефиллConditionalRangeFill clear()clear() Удаляет заливку.Resets the fill.
colorcolor HTML-код, представляющий цвет заливки в виде #RRGGBB (например, FFA500) или в виде ключевого слова (например, orange).HTML color code representing the color of the fill, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").
КондитионалранжефонтConditionalRangeFont boldbold Указывает, является ли шрифт полужирным.Represents the bold status of font.
clear()clear() Удаляет форматирование шрифтов.Resets the font formats.
colorcolor HTML-код цвета текста.HTML color code representation of the text color. Например,E.g. #FF0000 обозначает красный.#FF0000 represents Red.
italicitalic Указывает, применяется ли курсив.Represents the italic status of the font.
strikethroughstrikethrough Указывает, зачеркнут ли шрифт.Represents the strikethrough status of the font.
underlineunderline Тип подчеркивания, применяемый для шрифта.Type of underline applied to the font. Дополнительные сведения см. в статье Excel. Кондитионалранжефонтундерлинестиле.See Excel.ConditionalRangeFontUnderlineStyle for details.
КондитионалранжеформатConditionalRangeFormat numberFormatnumberFormat Представляет код числового формата Excel для заданного диапазона.Represents Excel's number format code for the given range. Очищается, если передается значение null.Cleared if null is passed in.
bordersborders Коллекция объектов Border, которые применяются к общему диапазону условного форматирования.Collection of border objects that apply to the overall conditional format range. Только для чтения.Read-only.
fillfill Возвращает объект Fill, определенный в общем диапазоне условного форматирования.Returns the fill object defined on the overall conditional format range. Только для чтения.Read-only.
fontfont Возвращает объект Font, определенный в общем диапазоне условного форматирования.Returns the font object defined on the overall conditional format range. Только для чтения.Read-only.
КондитионалтексткомпарисонрулеConditionalTextComparisonRule oroperator Оператор условного форматирования текста.The operator of the text conditional format.
texttext Текстовое значение условного форматирования.The Text value of conditional format.
ConditionalTopBottomRuleConditionalTopBottomRule rankrank От 1 до 1000 для числовых рейтингов или от 1 до 100 для процентных рейтингов.The rank between 1 and 1000 for numeric ranks or 1 and 100 for percent ranks.
typetype Форматирование значений на основе верхнего или нижнего ранга.Format values based on the top or bottom rank.
КустомкондитионалформатCustomConditionalFormat formatformat Возвращает объект Format, который инкапсулирует шрифты условного форматирования, заливки, границы и другие свойства.Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Только для чтения.Read-only.
правилаrule Представляет объект Rule в этом условном форматировании.Represents the Rule object on this conditional format. Только для чтения.Read-only.
ДатабаркондитионалформатDataBarConditionalFormat axisColoraxisColor HTML-код, представляющий цвет линии оси в виде #RRGGBB (например, FFA500) или в виде ключевого слова (например, orange).HTML color code representing the color of the Axis line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").
АксисформатaxisFormat Представление определения оси для панели данных Excel.Representation of how the axis is determined for an Excel data bar.
БардиректионbarDirection Представляет направление, на котором должен основываться рисунок на панели данных.Represents the direction that the data bar graphic should be based on.
ЛовербаундрулеlowerBoundRule Правило для нижней границы гистограммы (и как ее вычислить).The rule for what consistutes the lower bound (and how to calculate it, if applicable) for a data bar.
НегативеформатnegativeFormat Отображение всех значений слева от оси в панели данных Excel.Representation of all values to the left of the axis in an Excel data bar. Только для чтения.Read-only.
ПоситивеформатpositiveFormat Представление всех значений справа от оси в панели данных Excel.Representation of all values to the right of the axis in an Excel data bar. Только для чтения.Read-only.
ШовдатабаронлиshowDataBarOnly Значение true скрывает значения ячеек, где применяется гистограмма.If true, hides the values from the cells where the data bar is applied.
УппербаундрулеupperBoundRule Правило для верхней границы гистограммы (и как ее вычислить).The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar.
ИконсеткондитионалформатIconSetConditionalFormat criteriacriteria Массив критериев и IconSets для правил и потенциальных настраиваемых значков для условных значков.An array of Criteria and IconSets for the rules and potential custom icons for conditional icons. Обратите внимание, что для первого критерия можно изменить только настраиваемый значок, в то время как тип, формула и оператор будут игнорироваться при установке.Note that for the first criterion only the custom icon can be modified, while type, formula, and operator will be ignored when set.
РеверсеиконордерreverseIconOrder Если этот параметр имеет значение true, отменяет порядок значков для набора значков.If true, reverses the icon orders for the IconSet. Обратите внимание, что этот параметр невозможно задать при использовании настраиваемых значков.Note that this cannot be set if custom icons are used.
showIconOnlyshowIconOnly Значение true скрывает значения и показывает только значки.If true, hides the values and only shows icons.
stylestyle Если этот параметр установлен, отображается параметр "набор значков" для условного форматирования.If set, displays the IconSet option for the conditional format.
ПресеткритериакондитионалформатPresetCriteriaConditionalFormat formatformat Возвращает объект Format, который инкапсулирует шрифты условного форматирования, заливки, границы и другие свойства.Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.
правилаrule Правило условного форматирования.The rule of the conditional format.
RangeRange calculate()calculate() Вычисляет диапазон ячеек на листе.Calculates a range of cells on a worksheet.
conditionalFormatsconditionalFormats Коллекция объектов Кондитионалформатс, пересекающих диапазон.Collection of ConditionalFormats that intersect the range. Только для чтения.Read-only.
ТексткондитионалформатTextConditionalFormat formatformat Возвращает объект Format, который инкапсулирует шрифты условного форматирования, заливки, границы и другие свойства.Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Только для чтения.Read-only.
правилаrule Правило условного форматирования.The rule of the conditional format.
ТопботтомкондитионалформатTopBottomConditionalFormat formatformat Возвращает объект Format, который инкапсулирует шрифты условного форматирования, заливки, границы и другие свойства.Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Только для чтения.Read-only.
правилаrule Критерии условного форматирования Top/Bottom.The criteria of the Top/Bottom conditional format.
WorksheetWorksheet Calculate (markAllDirty: Boolean)calculate(markAllDirty: boolean) Вычисляет все ячейки на листе.Calculates all cells on a worksheet.

См. такжеSee also