ドキュメントの検索
karat

+

K

APIリファレンス ↗

注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

コントロール

コントロールウィジェットカテゴリーは以下のウィジェットで構成されています:


ボタンウィジェット

以下の表は、ボタンウィジェットに使用可能なプロパティについての使用詳細を提供します。表の後にいくつかの例が続きます。

プロパティ

属性説明タイプ必須変更者
cssClassesボタンの CSS クラス。string[]いいえ直接編集
disabledユーザーがウィジェットと対話できるかどうかを指定します。デフォルトは false。値は通常、ブール値を生成するテンプレート式(例: “{{w1.on}}”)です。booleanはい直接編集
textボタンの表示テキスト。stringはい直接編集

ボタン

Copied!
1 2 3 4 5 { "cssClasses": ["pt-button","pt-intent-primary"], // CSSクラス ["pt-button","pt-intent-primary"] "disabled": false, // 無効化フラグ:false(ボタンは使用可能) "text": "Run" // ボタンのテキスト:"Run" }

デフォルト

Copied!
1 2 3 4 5 6 { "cssClasses": ["pt-button","pt-intent-primary"], // CSSクラス "disabled": false, // 無効化 (falseの場合、ボタンは有効) "queryNames": [], // クエリ名 "text": "Run" // テキスト (ボタンに表示される文字) }

チェックボックスウィジェット

以下の表は、チェックボックスウィジェットで使用可能なプロパティに関する詳細を提供します。

プロパティ

属性説明タイプ必須変更元
disabledユーザーがウィジェットと対話できるかどうかを指定します。デフォルトは false です。値は通常、ブール値(例:“{{w1.on}}”)を生成するテンプレート式です。booleanはい直接編集
displayValuesチェックボックスグループのアイテムの表示値を定義するオプションのリスト。 ‘values’ の各アイテムに対して表示値があるべきです。 ‘displayValues’ が指定されていない場合、各アイテムの生の値が代わりに表示されます。string[]いいえ直接編集
hovertooltipsEnabled = true の場合、このプロパティはマウスオーバーしている値を決定します。ICheckboxHoverいいえユーザー操作
selectedDisplayValues現在チェックされているアイテムの表示値のリスト。string[]はいユーザー操作
selectedValues現在チェックされているアイテムのリスト。any[]はいユーザー操作
tooltipsEnabledツールチップが有効かどうかを指定します。booleanはい直接編集
tooltipTextツールチップに表示されるテキスト。この値が null または空の文字列の場合、ツールチップは表示されません。HTML をサポートしています。stringいいえ直接編集
valuesチェックボックスグループのアイテムの値。any[]はい直接編集

ICheckboxHover

属性説明タイプ必須変更元
displayValue現在マウスオーバーしているチェックボックスの表示値。stringはいユーザー操作
index現在マウスオーバーしているチェックボックスのラベルのインデックス。numberはいユーザー操作
value現在マウスオーバーしているチェックボックスの生の値。anyはいユーザー操作

ドロップダウンウィジェット

以下の表は、ドロップダウンウィジェットで使用可能なプロパティに関する詳細を提供します。表の後にいくつかの例が続きます。

プロパティ

属性説明タイプ必須変更元
disabledユーザーがウィジェットと対話できるかどうかを指定します。デフォルトは false です。値は通常、ブール値(例:“{{w1.on}}”)を生成するテンプレート式です。booleanはい直接編集
fuzzySearchEnabled検索のためのファジーマッチングを切り替えます。booleanはい直接編集
displayValuesドロップダウンに表示される値。指定されていない場合、 ‘values’ が使用されます。any[]いいえ直接編集
groups対応する ‘values’ のエントリが表示されるグループ。any[]いいえ直接編集
maintainValidSelectionウィジェットが無効化されたときに、現在選択されている値が選択されたままであるべきかどうかを示します、ただし、その値はまだ有効である限り。booleanはい直接編集
searchText‘values’ 配列をフィルター処理するための検索テキスト。serverSearchEnabled の詳細を参照してください。stringはいユーザー操作
selectedDisplayValueドロップダウンの表示値。stringはいユーザー操作
selectedValue現在ユーザーが選択したドロップダウン値。anyはいユーザー操作
serverSearchEnabledユーザー入力の検索テキストが新たなクエリをトリガーするべきことを示します。それ以外の場合、 ‘values’ 配列はローカルで一致するものを検索します。booleanはい直接編集
values‘selectedValue’ が設定される値。displayValues が使用される場合、displayValues と一対一のマッピングであるべきです。any[]はい直接編集

ダイナミックドロップダウン

Copied!
1 2 3 4 5 6 7 8 { "disabled": false, // "無効化"がfalseなので、この機能は有効です "displayValues": "{{query1.memberName}}", // "displayValues"は"{{query1.memberName}}"を表示します。これはクエリ1のメンバー名を表示します "searchText": "John", // "searchText"は"John"です。これは検索テキストフィールドのデフォルト値です "selectedValue": "65849", // "selectedValue"は"65849"です。これは初期選択値です "serverSearchEnabled": true, // "serverSearchEnabled"がtrueなので、サーバーサイドの検索が有効です "values": "{{query1.memberId}}" // "values"は"{{query1.memberId}}"を表示します。これはクエリ1のメンバーIDを表示します }

スタティックドロップダウン

Copied!
1 2 3 4 5 6 7 8 9 10 11 { "disabled": false, // このフィールドは機能が無効化されているかどうかを示します。falseは有効、trueは無効を意味します。 "searchText": "", // このフィールドは検索テキストを保持します。ここは現在空です。 "selectedValue": "giraffe", // このフィールドは選択された値を表示します。現在は"キリン"が選択されています。 "serverSearchEnabled": false, // このフィールドはサーバー側での検索が有効化されているかどうかを示します。falseは無効、trueは有効を意味します。 "values": [ // このフィールドは選択可能な値のリストを保持します。 "giraffe", // "キリン" "rhinoceros", // "サイ" "elephant" // "象" ] }

デフォルト

Copied!
1 2 3 4 5 6 7 { "disabled": false, // ボタンが無効化されているかどうかを示す。falseなら有効。 "searchText": "", // 検索ボックスに入力されたテキストを保持する。 "selectedValue": null, // ユーザーが選択した値を保持する。初期値はnull。 "serverSearchEnabled": false, // サーバー側の検索が有効かどうかを示す。falseなら無効。 "values": [] // 選択可能な値のリスト。初期状態は空のリスト。 }

Input Box ウィジェット

以下のテーブルは、Input Box ウィジェットで利用できるプロパティについての使用詳細を提供します。テーブルの後にいくつかの例が続きます。

プロパティ

属性説明タイプ必須変更者
disabledユーザーがウィジェットと対話できるかどうかを指定します。デフォルトは false です。値は通常、ブーリアンを生成するテンプレート表現(例: “{{w1.on}}”)です。booleanYes直接編集
placeholder入力ボックスのプレースホルダーに使用するテキスト(IE9はサポートされていません)。stringNo直接編集
queryNamesEnter キーが使用されたときにこの入力ボックスが実行するべきクエリの名前。string[]No直接編集
textユーザーがボックスに入力したテキスト。stringYesユーザーのインタラクション

Input Box

Copied!
1 2 3 4 5 6 { "disabled": false, // 無効にするかどうか (true: 無効, false: 有効) "placeholder": "動物を選んでください...", // プレースホルダーテキスト "queryName": "query1", // クエリ名 "text": "" // テキスト }

デフォルト設定

Copied!
1 2 3 4 5 { "disabled": false, // "disabled"が"false"なので、この要素は無効になっていません "placeholder": "placeholder goes here", // "placeholder"の値はここに入力します "text": "" // 現在"text"は空です }

マルチセレクトボックスウィジェット

以下の表は、マルチセレクトボックスウィジェットで利用できるプロパティについての使用詳細を提供します。表の後にはいくつかの例が続きます。

プロパティ

属性説明必須変更者
disabledユーザーがウィジェットと対話できるかどうかを指定します。デフォルトは false です。値は通常、ブーリアンを生成するテンプレート化された式です (例:「{{w1.on}}」)。ブーリアンはい直接編集
displayValuesマルチセレクトボックスに表示される値。指定されていない場合は、「values」が使用されます。string[]いいえ直接編集
fuzzySearchEnabled検索のためのファジーマッチングをトグルします。ブーリアンはい直接編集
placeholderマルチセレクトボックスのプレースホルダーに使用するテキストstringいいえ直接編集
hasValuesユーザーが値を入力したかどうかを示します。ブーリアンはいユーザーのインタラクション
selectedDisplayValues現在のユーザー入力で表示される選択した値。string[]はいユーザーのインタラクション
selectedValues現在のユーザー入力で選択した値。any[]はいユーザーのインタラクション
searchText「values」配列をフィルター処理するための検索テキスト。serverSearchEnabled の詳細はそちらを参照してください。stringはいユーザーのインタラクション
serverSearchEnabledユーザー入力の検索テキストが新しいクエリをトリガーするべきであることを示します。そうでなければ、「values」配列はローカルで一致するものを検索します。ブーリアンはい直接編集
tokenSeparator入力でトークンを分割する文字列。指定されていない場合、入力はトークン化されません。改行文字は入力内のスペースとして読み取られます。stringいいえ直接編集
values「selectedValues」が設定される「values」。もし「displayValues」が使用されている場合、「displayValues」と「values」は一対一のマッピングであるべきです。any[]はい直接編集

ダイナミックマルチセレクト

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 { // "disabled"は機能が無効化されているかどうかを示します。falseは有効を意味します。 "disabled": false, // "displayValues"は表示する値を示します。ここでは"query1.memberName"(メンバーの名前)が表示されます。 "displayValues": "{{query1.memberName}}", // "hasValues"は値が存在するかどうかを示します。falseは値が存在しないことを意味します。 "hasValues": false, // "searchText"は検索テキストを示します。ここでは"John"を検索します。 "searchText": "John", // "selectedDisplayValues"は選択された表示値を示します。選択された表示値がない場合は空の配列が表示されます。 "selectedDisplayValues": [], // "selectedValues"は選択された値を示します。選択された値がない場合は空の配列が表示されます。 "selectedValues": [], // "serverSearchEnabled"はサーバー検索が有効かどうかを示します。trueは有効を意味します。 "serverSearchEnabled": true, // "values"は値を示します。ここでは"query1.memberId"(メンバーのID)が値として使用されます。 "values": "{{query1.memberId}}" }

スタティックマルチセレクト

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 { "disabled": false, // 無効化されているかどうか。falseなら無効化されていない "hasValues": true, // 値が存在するかどうか。trueなら存在する "selectedDisplayValues": [ // 選択されて表示される値 "giraffe", // キリン "rhinoceros" // サイ ], "selectedValues": [ // 選択された値 "giraffe", // キリン "rhinoceros" // サイ ], "serverSearchEnabled": false, // サーバー検索が有効かどうか。falseなら有効ではない "values": [ // 値のリスト "giraffe", // キリン "rhinoceros", // サイ "elephant" // ゾウ ] }

デフォルト

Copied!
1 2 3 4 5 6 7 8 { "disabled": false, // このフィールドが無効化されているかどうかを示すフラグ。falseの場合、フィールドは有効。 "hasValues": false, // このフィールドに値があるかどうかを示すフラグ。falseの場合、フィールドには値がない。 "selectedDisplayValues": [], // 選択された表示値のリスト。選択された値がない場合、リストは空になります。 "selectedValues": [], // 選択された値のリスト。選択された値がない場合、リストは空になります。 "serverSearchEnabled": false, // サーバー検索が有効化されているかどうかを示すフラグ。falseの場合、サーバー検索は無効。 "values": [] // フィールドの値のリスト。値がない場合、リストは空になります。 }

ラジオボタンウィジェット

以下の表は、ラジオボタンウィジェットで利用できるプロパティの使用詳細を提供します。

プロパティ

属性説明タイプ必須変更者
disabledユーザーがウィジェットと対話できるかどうかを指定します。デフォルトは false です。値は通常、真偽値を生成するテンプレート表現(例: “{{w1.on}}”)です。booleanはい直接編集
displayValuesラジオボタングループのアイテムの表示値を定義するオプションのリストです。 ‘values’ の各アイテムに対して表示値があるべきです。 ‘displayValues’ が指定されていない場合、各アイテムの生の値が代わりに表示されます。string[]いいえ直接編集
preselectFirstElement最初の値がデフォルトで選択されているかどうかを指定します。booleanはい直接編集
hovertooltipsEnabled = true のとき、このプロパティはユーザーがホバーしている値を決定します。IRadioHoverいいえユーザーの操作
selectedDisplayValue現在選択されている表示値です。stringはいユーザーの操作
selectedValue現在選択されている値です。anyはいユーザーの操作
tooltipsEnabledツールチップが有効かどうかを指定します。booleanはい直接編集
tooltipTextツールチップに表示されるテキストです。この値が null または空の文字列の場合、ツールチップは表示されません。HTML をサポートします。stringいいえ直接編集
valuesラジオボタングループのアイテムの値です。any[]はい直接編集

ICheckboxHover

属性説明タイプ必須変更者
displayValue現在ホバーしているラジオの表示値です。stringはいユーザーの操作
index現在ホバーしているラジオラベルのインデックスです。numberはいユーザーの操作
value現在ホバーしているラジオの生の値です。anyはいユーザーの操作

セグメンテッドコントロールウィジェット

以下の表は、セグメンテッドコントロールウィジェットで利用できるプロパティの使用詳細を提供します。

プロパティ

属性説明タイプ必須変更者
disabledユーザーがウィジェットと対話できるかどうかを指定します。デフォルトは false です。値は通常、真偽値を生成するテンプレート表現(例: “{{w1.on}}”)です。booleanはい直接編集
displayValuesセグメンテッドコントロールに表示される値です。指定されていない場合、 ‘values’ が使用されます。any[]いいえ直接編集
hovertooltipsEnabled = true のとき、このプロパティはユーザーがホバーしている値を決定します。ISegmentedControlHoverいいえユーザーの操作
multiselectEnabledユーザーが一つの値だけを選択できるか、複数の値を選択できるかどうかを指定します。booleanはい直接編集
preselectFirstElement最初の値がデフォルトで選択されているかどうかを指定します。booleanはい直接編集
selectionRequiredすべての値の選択を解除できるかどうかを指定します。有効にすると、このフラグはユーザーがウィジェットの最後の選択値の選択を解除するのを防ぎます。ウィジェットが選択されていない値から始まる場合、ユーザーが初期選択を行った後だけ選択を解除するのを防ぎます。booleanはい直接編集
selectedValues現在のユーザーが選択した値または値です。any[]はいユーザーの操作
tooltipsEnabledツールチップを表示するかどうかを指定しますbooleanはいユーザーの操作
tooltipTextツールチップに表示されるテキストです。HTML をサポートします。stringいいえ直接編集
values‘selectedValues’ が設定されている値です。displayValues が使用されている場合、displayValues と一対一のマッピングをするべきです。any[]はい直接編集

ISegmentedControlHover

属性説明タイプ必須変更者
displayValue現在ホバーしているセグメントの表示値です。stringはいユーザーの操作
index現在ホバーしているセグメントのインデックスです。セグメントは左から右に番号付けされますnumberはいユーザーの操作
value現在ホバーしているセグメントの生の値です。anyはいユーザーの操作

スライダーウィジェット

以下の表は、スライダーウィジェットで利用できるプロパティの使用詳細を提供します。表の後にはいくつかの例があります。

プロパティ

属性説明タイプ必須変更者
disabledユーザーがウィジェットと対話できるかどうかを指定します。デフォルトは false です。値は通常、真偽値を生成するテンプレート表現(例: “{{w1.on}}”)です。booleanはい直接編集
formatModeスライダーラベルの形式を指定します。“Grouped” は指定した区切り文字で数字をグループ化します。例えば、区切り文字がコンマの場合、1000000 は 1,000,000 になります。 “Numeric” は提供された Numeral.js 形式を使用して値を形式化します。 “Time” は提供された moment.js 形式を使用して値を形式化します。stringはい直接編集
formatter“Numeric” または “Time” が選択された場合、このプロパティは形式文字列を保持します。stringいいえ直接編集
from範囲モードが有効なとき、このプロパティは範囲の下限の値を保持します。それ以外の場合、単一のスライダーハンドルの現在の位置に関連付けられた値を保持します。numberはいユーザーの操作
groupingDelimiter“Grouped” 形式が選択されたとき、このプロパティはグループを分離するために使用される区切り文字文字列を保持します。stringいいえ直接編集
max選択可能な最大値です。numberはい直接編集
min選択可能な最小値です。numberはい直接編集
numLabels表示する軸ラベルの数です。値が提供されていない場合、デフォルトは 6 です。numberはい直接編集
postfixすべての値に追加するテキストです。例: ” €” は “100” を “100 €” に変換しますstringいいえ直接編集
prefixすべての値の前に追加するテキストです。例: “$” は “100” を “$100” に変換しますstringいいえ直接編集
rangeEnabled範囲の値の選択が有効か、単一のポイントだけが有効かを指定します。booleanはい直接編集
step選択可能な値のステップサイズです。numberいいえ直接編集
to範囲モードが有効なとき、このプロパティは範囲の上限の値を保持します。numberいいえユーザーの操作
updateOnSlideスライダーの値が更新されるタイミングを指定します。“Release” は、ハンドルがリリースされた後に値が更新されることを示します。“Slide” は、スライダーがドラッグされると値が更新されることを示します。パフォーマンスの影響により、“Slide” は軽い操作(UI の更新など)でのみ使用するべきです。“Slide” の更新は 100ms にスロットルされます。booleanはい直接編集

スライダー

Copied!
1 2 3 4 5 6 7 8 9 10 11 { "disabled": false, // 無効化されていないことを示すフラグ。Falseの場合、有効。 "from": 25, // 範囲の開始値。ここでは25。 "groupingDelimiter": " ", // グループ化の区切り文字。ここではスペース。 "groupingEnabled": true, // グループ化が有効化されていることを示すフラグ。Trueの場合、有効。 "max": "{{query1.maxValue}}", // 範囲の最大値。ここではquery1の最大値。 "min": 1, // 範囲の最小値。ここでは1。 "prefix": "$", // 値の前につく接頭辞。ここではドル記号。 "rangeEnabled": true, // 範囲が有効化されていることを示すフラグ。Trueの場合、有効。 "to": 50 // 範囲の終了値。ここでは50。 }

デフォルト設定

Copied!
1 2 3 4 5 6 7 8 { "disabled": false, // 無効化されているかどうかを示すフラグ。falseならば有効。 "from": 25, // 開始値を示す。ここでは25。 "groupingEnabled": false, // グループ化が有効かどうかを示すフラグ。falseならばグループ化は無効。 "max": 100, // 最大値を示す。ここでは100。 "min": 0, // 最小値を示す。ここでは0。 "rangeEnabled": false // 範囲が有効かどうかを示すフラグ。falseならば範囲は無効。 }

Textarea ウィジェット

以下の表は、Textarea ウィジェットで利用可能なプロパティの使用詳細を提供します。表の後にいくつかの例が続きます。

プロパティ

属性説明タイプ必須変更者
delimiter2つの値の分離を示す1つ以上の文字のシーケンス。たとえば、「text」が「hello- -world」で、「delimiter」が「- -」の場合、「values」は ["hello", "world"]になります。stringいいえ直接編集
disabledユーザーがウィジェットと対話できるかどうかを指定します。デフォルトは false です。値は通常、ブール値を生成するテンプレート化された表現です(例:“{{w1.on}}”)。booleanはい直接編集
hasValuesユーザーが値を入力したかどうかを示します。booleanはいユーザーの操作
maxLengthEnabled有効にすると、ユーザーが入力するテキストの長さを制限します。booleanはい直接編集
maxLengthボックスに入力できるテキストの最大長。numberいいえ直接編集
placeholdertextarea のプレースホルダーに使用するテキスト(IE9 はサポートされていません)stringいいえ直接編集
textユーザーがボックスに入力するテキスト。stringはいユーザーの操作
valuesinputTextから導き出されるユーザーの入力値。arrayはいユーザーの操作

Textarea

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 { "delimiter": ";", // デリミタ(区切り文字)はセミコロンです "disabled": false, // このフィールドは無効化されていません "hasValues": true, // このフィールドには値が含まれています "placeholder": "Choose an animal...", // プレースホルダーのテキストは「動物を選んでください...」です "text": "giraffe; rhinoceros; elephant", // テキストフィールドには「キリン; サイ; 象」と表示されます "values": [ // このフィールドで選択可能な値は次の通りです "giraffe", // キリン "rhinoceros", // サイ "elephant" // 象 ] }

デフォルト

Copied!
1 2 3 4 5 6 7 { "delimiter": ";", // 区切り文字 "disabled": false, // 無効化 "hasValues": false, // 値があるかどうか "text": "", // テキスト "values": [] // 値のリスト }

トグルウィジェット

以下の表は、トグルウィジェットで利用可能なプロパティに関する使用詳細を提供しています。表の後にはいくつかの例が続きます。

プロパティ

属性説明タイプ必須変更者
disabledユーザーがウィジェットと対話できるかどうかを指定します。デフォルトは false です。値は通常、ブール値を生成するテンプレート式です(例:「{{w1.on}}」)。booleanはい直接編集
offLabelトグルスイッチの「オフ」状態のラベルstringはい直接編集
onLabelトグルスイッチの「オン」状態のラベルstringはい直接編集
useCustomIcons選択された場合、トグルは Blueprint のカスタムアイコンを使用しますcheckboxはい直接編集
onIconトグルスイッチの「オン」状態のアイコンstringいいえ直接編集
offIconトグルスイッチの「オフ」状態のアイコンstringいいえ直接編集
onトグルスイッチの現在の状態で、「オン」状態は「true」に対応しますbooleanはいユーザーインタラクション