...
属性 | 説明 |
UniqueKey | パラメーターのユニークキーは、Yellowfinとプラグインの両方が、パラメーターにデータやメタデータを取得するために使用するキーです。これは、独自のプラグイン内でユニークである限り(普遍的にユニークである必要はありません)、任意のStringで構いません。この属性は、getter/setterメソッドを持ちます。 |
DataType | これは、このパラメーターが保持するデータ値の格納型となるUIPデータ型のひとつです。例:数字を保持するパラメーターは、TYPE_NUMERICとして格納され、チェックボックスパラメーターは、TYPE_BOOLEANになる、など。この属性は、getter/setterメソッドを持ちます。データ型について、より詳細な情報は、付録を参照してください。setterメソッドを持ちます。データ型について、より詳細な情報は、付録を参照してください。 |
DisplayType | この属性は、Yellowfinにパラメーターデータの表示方法を指示します。この値は、UIP表示型のひとつです。異なるパラメーターのセットアップには、異なる表示型が必要です。この属性は、getter/setterメソッドを持ちます。 |
DefaultValue | このパラメーターのデフォルト値を定義します。パラメーターが「リセット」の場合は、この値に戻り、ユーザーがこのパラメーターの値を設定しない場合は、その値はこの値をとして保存されます。この属性は、getter/setterメソッドを持ちます。 |
DisplayName | これは、ユーザーに表示されるパラメータの名前であり、多くの場合、パラメーターUI要素の隣に表示されます。この属性は、getter/setterメソッドを持ちます。 |
Description | これは、ユーザーに表示されるパラメーターの短い説明であり、多くの場合、パラメーターUI要素の隣、名前の近くに表示されます。この属性は、getter/setterメソッドを持ちます。 |
MinAllowedValue | 数値フィールドとともに使用します。これは、このインプットの最小数値を定義します。ユーザーがより小さい値を入力しようとしても、受け付けられません。この属性は、getter/setterメソッドを持ちます。 |
MaxAllowedValue | 数値フィールドとともに使用します。これは、このインプットの最大数値を定義します。ユーザーがより大きい値を入力しようとしても、受け付けられません。この属性は、getter/setterメソッドを持ちます。 |
Options | パラメーター表示型の中には、ドロップダウンボックスやURLボタンなど、追加のオプションを要求するものもあります。これらは、インスタンス化後に、パラメーターオブジェクトに追加する必要があります。この属性は、getter/setterメソッドを持ち、異なる表示、値、説明テキストの有無にかかわらず、オプションを追加できるメソッドを追加します。このガイドの付録には、各表示型の必須オプションとオプションの資料も含まれています。以下に、この属性の例を示します。setterメソッドを持ち、異なる表示、値、説明テキストの有無にかかわらず、オプションを追加できるメソッドを追加します。このガイドの付録には、各表示型の必須オプションとオプションの資料も含まれています。以下に、この属性の例を示します。 |
ViewOptions | パラメーター表示型の中には、表示型に特化した「ViewOption」と呼ばれる追加の表示構成オプションがあります。これは、時々変更され、資料が完全に更新されていない可能性もあるため、必要にならない限り、使用は差し控えることを推奨します。より詳細な情報は、付録を参照してください。」と呼ばれる追加の表示構成オプションがあります。これは、時々変更され、資料が完全に更新されていない可能性もあるため、必要にならない限り、使用は差し控えることを推奨します。より詳細な情報は、付録を参照してください。 |
オプションの例
以下の例は、表示型オプションの属性を参照しています。
...
Section | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|