Excel JavaScript API 1.6 の新機能What'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.

API リストAPI list

次の表に、Excel JavaScript API 要件セット1.6 の Api を示します。The following table lists the APIs in Excel JavaScript API requirement set 1.6. Excel JavaScript API 要件セット1.6 またはそれ以前でサポートされているすべての Api の API リファレンスドキュメントを表示するには、「要件セット1.6 またはそれ以前の Excel api」を参照してください。To 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()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.
CellValueConditionalFormatCellValueConditionalFormat formatformat 書式設定オブジェクトを返し、条件付き書式のフォント、塗りつぶし、罫線などのプロパティをカプセル化します。Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.
除外rule この条件付き書式の Rule オブジェクトを表します。Represents the Rule object on this conditional format.
ColorScaleConditionalFormatColorScaleConditionalFormat criteriacriteria カラースケールの基準。The criteria of the color scale. 2ポイントのカラースケールを使用している場合、中点はオプションです。Midpoint is optional when using a two point color scale.
threeColorScalethreeColorScale True の場合、カラースケールには3つのポイント (最小、中点、最大) が設定されます。それ以外の場合は、2つ (最小、最大) が設定されます。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.
演算子operator テキスト条件付き書式の演算子を指定します。The operator of the text conditional format.
ConditionalColorScaleCriteriaConditionalColorScaleCriteria maximummaximum 最大ポイントのカラー スケール条件。The maximum point Color Scale Criterion.
地点midpoint カラー スケールが 3 色スケールの場合のカラー スケール条件の中間値。The midpoint Color Scale Criterion if the color scale is a 3-color scale.
minimumminimum 最小ポイントのカラー スケール条件。The minimum point Color Scale Criterion.
ConditionalColorScaleCriterionConditionalColorScaleCriterion colorcolor 色スケールの色を表す HTML カラーコード。HTML color code representation of the color scale color. 例:E.g. #FF0000 は赤を表します。#FF0000 represents Red.
formulaformula 数値、数式、(型が LowestValue の場合は) null。A number, a formula, or null (if Type is LowestValue).
typetype 条件式の基準となる条件式を指定します。What the criterion conditional formula should be based on.
ConditionalDataBarNegativeFormatConditionalDataBarNegativeFormat borderColorborderColor 枠線の色を表す HTML カラー コード。形式は #RRGGBB (例: "FFA500")、または名前付きの HTML 色 (例: "オレンジ") です。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")、または名前付きの HTML 色 (例: "orange") として示されます。HTML color code representing the fill color, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").
matchPositiveBorderColormatchPositiveBorderColor 負の DataBar に正の DataBar と同じ枠線の色があるかどうかを表すブール値。Boolean representation of whether or not the negative DataBar has the same border color as the positive DataBar.
matchPositiveFillColormatchPositiveFillColor 負の DataBar に正の DataBar と同じ塗りつぶしの色があるかどうかを表すブール値。Boolean representation of whether or not the negative DataBar has the same fill color as the positive DataBar.
ConditionalDataBarPositiveFormatConditionalDataBarPositiveFormat borderColorborderColor 枠線の色を表す HTML カラー コード。形式は #RRGGBB (例: "FFA500")、または名前付きの HTML 色 (例: "オレンジ") です。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")、または名前付きの HTML 色 (例: "orange") として示されます。HTML color code representing the fill color, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").
gradientFillgradientFill DataBar のグラデーションの有無を表すブール値。Boolean representation of whether or not the DataBar has a gradient.
Conditionalの配列ConditionalDataBarRule formulaformula databar のルールを評価するために必要な場合、数式。The formula, if required, to evaluate the databar rule on.
typetype Databar のルールの種類。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() Conditonal 書式が適用される範囲を返します。または、複数の範囲に条件付き書式が適用されている場合は、null オブジェクトを返します。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.
cellValueOrNullObjectcellValueOrNullObject 現在の条件付き書式が CellValue 型の場合は、セル値の条件付き書式プロパティを返します。Returns the cell value conditional format properties if the current conditional format is a CellValue type.
colorScalecolorScale 現在の条件付き書式が ColorScale 型の場合は、ColorScale 条件付き書式プロパティを返します。Returns the ColorScale conditional format properties if the current conditional format is an ColorScale type. 読み取り専用です。Read-only.
colorScaleOrNullObjectcolorScaleOrNullObject 現在の条件付き書式が ColorScale 型の場合は、ColorScale 条件付き書式プロパティを返します。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.
customOrNullObjectcustomOrNullObject 現在の条件付き書式がカスタム型の場合は、カスタムの条件付き書式プロパティを返します。Returns the custom conditional format properties if the current conditional format is a custom type. 読み取り専用です。Read-only.
dataBardataBar 現在の条件付き書式がデータバーの場合、データバーのプロパティを返します。Returns the data bar properties if the current conditional format is a data bar. 読み取り専用です。Read-only.
dataBarOrNullObjectdataBarOrNullObject 現在の条件付き書式がデータバーの場合、データバーのプロパティを返します。Returns the data bar properties if the current conditional format is a data bar. 読み取り専用です。Read-only.
iconSeticonSet 現在の条件付き書式が IconSet 型の場合は、IconSet 条件付き書式プロパティを返します。Returns the IconSet conditional format properties if the current conditional format is an IconSet type. 読み取り専用です。Read-only.
iconSetOrNullObjecticonSetOrNullObject 現在の条件付き書式が IconSet 型の場合は、IconSet 条件付き書式プロパティを返します。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.
3-dpreset 事前設定の条件の条件付き書式を返します。Returns the preset criteria conditional format. 詳細については、「PresetCriteriaConditionalFormat」を参照してください。See Excel.PresetCriteriaConditionalFormat for more details.
presetOrNullObjectpresetOrNullObject 事前設定の条件の条件付き書式を返します。Returns the preset criteria conditional format. 詳細については、「PresetCriteriaConditionalFormat」を参照してください。See Excel.PresetCriteriaConditionalFormat for more details.
textComparisontextComparison 現在の条件付き書式がテキスト型の場合、特定のテキスト条件付き書式プロパティを返します。Returns the specific text conditional format properties if the current conditional format is a text type.
textComparisonOrNullObjecttextComparisonOrNullObject 現在の条件付き書式がテキスト型の場合、特定のテキスト条件付き書式プロパティを返します。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.
topBottomOrNullObjecttopBottomOrNullObject 現在の条件付き書式が TopBottom 型の場合、上位/下位条件付き書式プロパティを返します。Returns the Top/Bottom conditional format properties if the current conditional format is an TopBottom type.
typetype 条件付き書式の種類を指定します。A type of conditional format. 一度に設定できるのは1つだけです。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.
ConditionalFormatCollectionConditionalFormatCollection 追加 (種類: ConditionalFormatType)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) 指定された ID に対応する条件付き書式を返します。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 customIconcustomIcon 既定の IconSet と異なる場合は現在の条件のカスタム アイコン、そうでない場合は 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.
演算子operator アイコンの条件付き書式のルールの種類ごとに、GreaterThan または GreaterThanOrEqual。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.
ConditionalRangeBorderConditionalRangeBorder colorcolor 枠線の色を表す HTML カラー コード。形式は #RRGGBB (例: "FFA500")、または名前付きの HTML 色 (例: "オレンジ") です。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").
sideIndexsideIndex 罫線の特定の辺を表す定数値。Constant value that indicates the specific side of the border. 詳細については、「Excel の ConditionalRangeBorderIndex」を参照してください。See Excel.ConditionalRangeBorderIndex for details. 読み取り専用です。Read-only.
stylestyle 罫線の線スタイルを指定する、線スタイル定数のいずれか 1 つ。One of the constants of line style specifying the line style for the border. 詳細については、「Excel BorderLineStyle」を参照してください。See Excel.BorderLineStyle for details.
ConditionalRangeBorderCollectionConditionalRangeBorderCollection getItem (index: Excel. ConditionalRangeBorderIndex)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.
ConditionalRangeFillConditionalRangeFill clear()clear() 塗りつぶしをリセットします。Resets the fill.
colorcolor 塗りつぶしの色を表す HTML カラー コード。#RRGGBB 形式 (例: "FFA500")、または名前付きの HTML 色 (例: "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").
ConditionalRangeFontConditionalRangeFont 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 の Conditionalrangefont過小認識」を参照してください。See Excel.ConditionalRangeFontUnderlineStyle for details.
ConditionalRangeFormatConditionalRangeFormat 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.
ConditionalTextComparisonRuleConditionalTextComparisonRule 演算子operator テキスト条件付き書式の演算子を指定します。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.
CustomConditionalFormatCustomConditionalFormat formatformat 書式設定オブジェクトを返し、条件付き書式のフォント、塗りつぶし、罫線などのプロパティをカプセル化します。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")、または名前付きの HTML 色 (例: 「オレンジ」) です。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.
barDirectionbarDirection データバーのグラフィックスの基準となる方向を表します。Represents the direction that the data bar graphic should be based on.
小 BoundrulelowerBoundRule データ バーの下限値 (および該当する場合はその計算方法) を構成するルール。The rule for what consistutes the lower bound (and how to calculate it, if applicable) for a data bar.
negativeFormatnegativeFormat Excel データバーの軸の左側にあるすべての値の表現。Representation of all values to the left of the axis in an Excel data bar. 読み取り専用です。Read-only.
positiveFormatpositiveFormat Excel データバーの軸の右側にあるすべての値の表現。Representation of all values to the right of the axis in an Excel data bar. 読み取り専用です。Read-only.
Showます AronlyshowDataBarOnly true の場合、データ バーが適用されているセルの値を非表示にします。If true, hides the values from the cells where the data bar is applied.
upperBoundRuleupperBoundRule データ バーの上限値 (および該当する場合はその計算方法) を構成するルール。The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar.
IconSetConditionalFormatIconSetConditionalFormat criteriacriteria ルールの条件および IconSets の配列と、条件付きアイコンのユーザー設定のアイコン。An array of Criteria and IconSets for the rules and potential custom icons for conditional icons. 最初の条件では、カスタムアイコンのみを変更できることに注意してください。設定すると、type、formula、および operator は無視されます。Note that for the first criterion only the custom icon can be modified, while type, formula, and operator will be ignored when set.
reverseIconOrderreverseIconOrder True の場合は、IconSet のアイコンオーダーを逆にします。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 設定すると、条件付き書式の IconSet オプションが表示されます。If set, displays the IconSet option for the conditional format.
PresetCriteriaConditionalFormatPresetCriteriaConditionalFormat formatformat 書式設定オブジェクトを返し、条件付き書式のフォント、塗りつぶし、罫線などのプロパティをカプセル化します。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 範囲に交差する ConditionalFormats のコレクションです。Collection of ConditionalFormats that intersect the range. 読み取り専用です。Read-only.
TextConditionalFormatTextConditionalFormat formatformat 書式設定オブジェクトを返し、条件付き書式のフォント、塗りつぶし、罫線などのプロパティをカプセル化します。Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. 読み取り専用です。Read-only.
除外rule 条件付き書式のルール。The rule of the conditional format.
TopBottomConditionalFormatTopBottomConditionalFormat formatformat 書式設定オブジェクトを返し、条件付き書式のフォント、塗りつぶし、罫線などのプロパティをカプセル化します。Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. 読み取り専用です。Read-only.
除外rule 上位/下位条件付き書式の条件を指定します。The criteria of the Top/Bottom conditional format.
WorksheetWorksheet calculate (markAllDirty: boolean)calculate(markAllDirty: boolean) ワークシート上のすべてのセルを計算します。Calculates all cells on a worksheet.

関連項目See also