UIComponent クラス: oracle.adf.view.faces.bi.component.gauge.UIGauge
コンポーネント・タイプ: oracle.dss.adf.gauge.Gauge
gaugeタグは、ADFゲージを作成する場合に使用します。ゲージはこのタグの属性を設定するだけで作成できますが、多くのコンポーネントでは、gaugeのいずれかの子タグを含めることにより、カスタム設定を指定することもできます。
ゲージは、温度、圧力、速度などの数量を表すための測定手段です。ゲージによって、メトリック値およびしきい値の範囲が図表形式で表示されます。ゲージ内にはインジケータがあります。インジケータはゲージのメトリック値を表します。1つのゲージには、1つのメトリック値が表示されます。値のグリッドがゲージに適用されると、複数のゲージが含まれるゲージ・セットとなり、それぞれのゲージによって、グリッド内の値が表されます。
ゲージには、ダイアル・ゲージ、ステータス・メーター、垂直ステータス・メーターおよびLEDゲージの4種類があります。ゲージは5つの主要部分(上位ラベル、下位ラベル、メトリック・ラベル、描画エリアおよび凡例エリア)で構成されます。ただし、LEDゲージの場合は例外で、描画エリアがありません。ゲージの他の部分(インジケータ、ティック・ラベル、ティック・マーク、ゲージ・フレームなど)を描画エリアに含めることもできます。
単一の値: ゲージの最も単純なデータ・モデルは、単一のメトリック値です。この値は値属性によって指定できます。また、しきい値はThresholdタグで、最小値はminValue属性で、最大値はmaxValue属性によって指定できます。次のJSPX xmlでは、単一のゲージが生成されます。
<dvt:gauge value = "10" minValue = "0" maxValue = "100"> <dvt:thresholdSet> <dvt:threshold thresholdMaxValue = "30"/> <dvt:threshold thresholdMaxValue = "60"/> <dvt:threshold/> </dvt:thresholdSet> </dvt:gauge>
データ・グリッド: この他に、データ・バインディング・ダイアログを使用して、通常は行セットに基づくデータ・コントロールにゲージをバインドする方法もあります。ゲージのデータを提供する一般的な方法としては、tabularData属性を使用してデータ・グリッドを作成する方法もあります。この方法では、バッキングBeanまたはマネージドBeanを使用する必要があります。
値のグリッドが指定されている場合、ゲージはゲージ・セットとなります。ゲージ・セット内の各ゲージによって、グリッド内の値が表されます。デフォルトでは、ゲージの数はグリッド内の行および列の数によって決まります。ユーザーは、gaugeSetColumnCount属性を使用して、ゲージ・セット内の列の数をカスタマイズできます。
データ指定: データ指定を使用すると、メトリック値、しきい値、最小値および最大値として使用されるデータの列または行を指定できます。次の例に、一連の表データに対してデータ指定を使用する方法を示します。この表データには、5つの列と2つの行が含まれています。データ指定を使用しない場合、次の表では10個のゲージが生成され、各値に1つのゲージが存在することになります。各列には、示されているように必要なデータ指定が割り当てられています。売上がメトリック値として割り当てられ、ノルマが最初のしきい値として割り当てられています。この場合、Boston用とChicago用に2つのゲージが生成されます。いずれのゲージにも、メトリック値、最小値、最大値およびしきい値が指定されています。
必要な指定 | メトリック | 最小値 | 最大値 | しきい値1 | しきい値2 |
名前 | Sales | Min | Inventory | Quota | Target |
Boston | 40 | 0 | 100 | 30 | 50 |
Chicago | 60 | 0 | 80 | 35 | 70 |
CommonGauge gauge = new CommonGauge();
Object[] specs = { DataSpecification.METRIC, DataSpecification.MINIMUM, DataSpecification.MAXIMUM, DataSpecification.THRESHOLD, DataSpecification.THRESHOLD };
String[] colLabels = new String[] { "Sales", "Min", "Max", "Quota", "Target" };
String[] rowLabels = new String[] { "Boston", "Chicago" };
double[][] values = new double[][] { {40, 60}, {0,0}, {100,80}, {30,35}, {50,70} };
List gaugeData = new ArrayList();
for (int c = 0; c < colLabels.length; c++) {
for (int r = 0; r < rowLabels.length; r++) {
gaugeData.add(new Object[] { colLabels[c], rowLabels[r], new Double(values[c][r]) });
}
}
gauge.setTabularData(specs, gaugeData);
描画エリアには、ゲージのメトリック値が図表形式で表されます。ゲージ・タイプによって、描画エリアが異なります。通常、描画エリア内にインジケータ、しきい値およびティック・マークが入ります。
ゲージ・フレームは、ダイアル・ゲージの描画エリア全体を囲む装飾用フレームです。ユーザーは、ゲージ・フレームの塗りつぶしおよび枠線の色を選択できます。
描画エリアの外観は、ゲージ・タイプによって異なります。
ダイアル・ゲージ描画エリアは、ダイアルと針で構成されます。外観はスピードメーターに似ています。ダイアルには、特定の角度で値を表示するティック・マークがあります。ユーザーは、angleExtent属性を使用してダイアルの角度範囲を指定できます。
垂直ステータス・メーターとステータス・メーターは、枠ボックス内に長方形のインジケータが配置されたメーターです。外観は水銀気圧計に似ています。枠ボックスには、ボックス内の特定の位置の値を示すティック・マークがあります。
LEDゲージには描画エリアがありません。LEDゲージの詳細は、次のインジケータの項を参照してください。
インジケータには、ゲージのメトリック値が表示されます。ダイアル・ゲージには、3つのタイプのインジケータ(線、針および塗りつぶし)があります。線と針は、ダイアルの特定の角度を指すメトリック値を示す回転ポインタです。針インジケータは、線インジケータよりも厚みがあります。塗りつぶしは、最小値からメトリック値までの範囲を塗りつぶすダイアルの区分またはセクションです。ユーザーは、インジケータの塗りつぶしおよび枠線の色を指定できます。
ステータス・メーターのインジケータは長方形です。その長さは、メトリック値に比例します。インジケータの塗りつぶしおよび枠線の色を指定するには、<dvt:indicatorBar>タグを使用します。
LEDゲージでは、値が主に色で表されます。色は、メトリック値がどのしきい値範囲に含まれるかに従って変更されます。このため、LEDゲージには、1つ以上のしきい値が存在している必要があります。ユーザーは、属性ledStyleによってLEDのスタイルを変更できます。LEDゲージの形状は、円形(LS_DOT)、矢印(LS_ARROW)、三角形(LS_TRIANGLE)またはカスタマイズ可能な形状(LS_CUSTOM)に変更できます。
カスタマイズ可能な形状を使用できるようにするには、ledStyleCallback属性とそのコールバック・クラスの両方を実装する必要があります。LedStyleCallbackクラスはコールバック・クラスによって拡張されます。各しきい値範囲に対応するイメージが返されるように、ユーザーがgetLEDImageメソッドを実装する場合、LedStyleCallbackクラスが必要となります。詳細は、LedStyleCallbackクラスのJavaDocを参照してください。
しきい値は、ノルマ、ターゲット値、制限値などの重要な値範囲を表します。インジケータがしきい値範囲の1つに当てはまる場合は、特定の基準が満たされているか、または満たされていないことを意味します。ゲージ内のしきい値範囲ごとに、異なる色を指定できます。この色は、ユーザーがカスタマイズできます。
しきい値範囲を指定するには、<dvt:thresholdSet>タグおよび<dvt:threshold>タグを使用します。範囲のブレークポイントを指定するには、thresholdMaxValue属性を使用します。たとえば、2つのしきい値タグのthresholdMaxValueを指定した場合には、3つのしきい値範囲(最小値から最初のthresholdMaxValueまで、最初のthresholdMaxValueから2番目のthresholdMaxValueまで、および2番目のthresholdMaxValueから最大値まで)が生成されます。しきい値範囲は、データ・バインディングを介して指定することもできます。
ゲージ凡例を追加すると、しきい値の色、範囲および説明を表示できます。
ダイアル・ゲージの場合は、しきい値表現のスタイルを変更できます。しきい値の色で描画エリア全体を塗りつぶしたり、描画エリアを実線またはセグメント線で囲むことができます。
ダイアル・ゲージとステータス・メーターには、描画エリアの特定の回転角度または位置の増分値、最小値および最大値を表示するためのティック・マークとティック・ラベルがあります。ユーザーは、ゲージ内にティック・マークを配置する位置(増分値、最小値、最大値、メトリック値、しきい値など)を指定できます。増分値を指定した場合、ユーザーはゲージ内に表示されるティックの数を決定できます。ティック・ラベルには、実際の値またはパーセント値が表示されます。ティック・ラベルは、描画エリアの内側にも外側にも配置できます。
ゲージ内には3つのラベル(上位ラベル、下位ラベルおよびメトリック・ラベル)があります。
上位ラベルには、ゲージのタイトルが表示されます。上位ラベルはゲージの上または内側に配置できます。データ・グリッド列ラベルは、ゲージ・セット内のデフォルトの上位ラベルです。
下位ラベルには、値の説明が表示されます。下位ラベルはゲージの下または内側に配置できます。データ・グリッド行ラベルが、ゲージ・セット内のデフォルトの下位ラベルです。
メトリック・ラベルには、メトリックの数値が表示されます。メトリック・ラベルは、下位ラベルの下か近く、またはゲージの内側に配置できます。メトリック・ラベルには、数値ではなくパーセンテージ値を表示することもできます。
上位ラベル、下位ラベルおよびメトリック・ラベルがゲージの内側に配置されている場合は、水平方向で中央揃えされます。2つ以上のラベルがゲージの内側に配置されている場合は、ゲージの描画エリアの中で垂直方向にも(上位ラベル、下位ラベル、メトリック・ラベルの順に)並べられます。
上のラベル・フレームは上位ラベルを囲む装飾用フレームであり、下のラベル・フレームは下位ラベルとメトリック・ラベルを囲むフレームです。これらのフレームの塗りつぶしおよび枠線の色は変更できます。
ゲージの凡例には、しきい値の説明が表示されます。各しきい値の色および名前または範囲が表示されます。ゲージの凡例は、<dvt:gaugeLegendArea>タグの位置属性を使用して、ゲージ描画領域の上、下、左または右に配置できます。
注意: 1つのゲージまたはゲージ・セットに含まれる凡例は1つのみです。ゲージ・セットの場合、凡例に表示されるしきい値の範囲または値は、ゲージ・セット内の最初のゲージによって決まります。このため、ゲージ・セット内で各ゲージに別々のしきい値範囲を使用することはお薦めしません。
凡例タイトルのカスタマイズには<dvt:gaugeLegendTitle>タグを使用し、凡例テキストのカスタマイズには<dvt:gaugeLegendText>タグを使用します。
デフォルトのゲージ・サイズは、高さ200ピクセル、幅200ピクセルです。サイズを変更するには、inlineStyle属性を使用できます。たとえば、ゲージ・サイズを高さ350ピクセル、幅500ピクセルに変更する場合は、inlineStyle = "width: 500px; height: 350px;"を設定します。幅と高さはパーセントで指定することもできます。明示的にサイズ指定されたコンテナまたはレイアウトを管理するコンテナにゲージを追加する場合にのみ、高さにパーセントを使用してください。それ以外の場合にパーセントを使用すると、ブラウザごとにゲージの動作が異なることになります。コンテナ・サイズに基づいてゲージのサイズを変更するには、dynamicResize属性を使用します。指定したサイズは、個々のゲージではなくゲージ・セット内のすべてのゲージに適用されることに注意してください。
ゲージではアニメーションがサポートされます。初期レンダリング中には、animationOnDisplay属性を使用してグラフをアニメートします。animationOnDataChange属性を使用して、データ変更時にグラフをアニメートすることもできます。アニメーション期間を指定するには、animationDuration属性を使用します。ゲージ・セットではアニメーションはサポートされません。
ツールチップは、データ・マーカーの識別情報や詳細情報を表示する際に役立ちます。インジケータにメトリック値の近似値が表示されている場合、ツールチップを使用すると正確な値を表示できるため便利です。
<dvt:gaugeFont>タグは、フォントの書式設定に使用します。テキストの色、スタイル、サイズおよびフォント名は、このタグを使用して指定できます。このタグは、ゲージのすべてのテキスト・コンポーネント・タグの子タグとして使用されます。ゲージのテキスト・コンポーネントは、topLabel、bottomLabel、metricLabel、gaugeLegendText、gaugeLegendTitleおよびtickLabelです。
ゲージ・セットの個々のコンポーネントの相互作用力を指定するには、shapeAttributesタグを使用します。この機能を使用するには、バッキングBeanまたはマネージドBeanが必要な場合があります。詳細は、<dvt:shapeAttributes>タグを参照してください。
次の例は、インジケータおよびメトリック・ラベルの相互作用力を示しています。これはダイアル・ゲージです。インジケータのツールチップはIndicatorとなり、メトリック・ラベルのツールチップはMetricLabelとなります。インジケータがクリックされると、ウィンドウ・タイトルはIndicator is clickedとなります。
<dvt:gauge gaugeType="DIAL"> <dvt:shapeAttributesSet> <dvt:shapeAttributes component="GAUGE_INDICATOR" alt="Indicator" onClick="document.title="Indicator is clicked";"/> <dvt:shapeAttributes component="GAUGE_METRICLABEL" alt="MetricLabel"/> </dvt:shapeAttributesSet> </dvt:gauge>
gaugeタグの子として使用できるタグは次のとおりです。
次の例は、gaugeタグを含むXMLを示しています。
<dvt:gauge id="foo2" value ="#{sampleGauge.gaugeDataModel}"
gaugeType="STATUSMETER" imageFormat="FLASH"
imageHeight="350" imageWidth="250"
gaugeSetAlignment="GSA_RIGHT" gaugeSetColumnCount="2"
gaugeSetDirection="GSD_ACROSS"
partialTriggers="gaugeTypes2" partialSubmit="true">
</dvt:gauge>
型 | フェーズ | 説明 |
---|---|---|
org.apache.myfaces.trinidad.event.AttributeChangeEvent | アプリケーションの起動、 リクエスト値の適用 |
属性変更を記述するために配信されるイベント。属性変更イベントは、プロパティに対するプログラム的な変更については配信されません。アプリケーションの特定のリクエストなしにレンダラによってプロパティが変更される場合にのみ配信されます。属性変更イベントの例には、クライアント側のサイズ変更をサポートしていた列の幅などがあります。 |
名前 | 型 | ELのサポート | 説明 |
---|---|---|---|
angleExtent | int | あり | ダイアル・ゲージの角度範囲を指定します。有効な値は次のとおりです。
|
animationDownColor | String | あり | データ値が減少したことを示すために使用する色を指定します。値はRGB 16進数で入力します。このリリースでは適用されません。 |
animationDuration | int | あり | アニメーションの継続時間をミリ秒単位で指定します。デフォルト値は1000です。 |
animationIndicators | String | あり |
表示するデータ変更インジケータのタイプを指定します。有効な値は次のとおりです。
このリリースでは適用されません。 |
animationOnDataChange | String | あり |
適用するデータ変更アニメーションのタイプを指定します。有効な値は次のとおりです。
|
animationOnDisplay | String | あり |
適用する初期レンダリング効果のタイプを指定します。有効な値は次のとおりです。
|
animationUpColor | String | あり | データ値が増加したことを示すために使用する色を指定します。値はRGB 16進数で入力します。このリリースでは適用されません。 |
attributeChangeListener | javax.el.MethodExpression | ELのみ | 属性変更リスナーへのメソッド・リファレンス。属性変更イベントは、プロパティに対するプログラム的な変更については配信されません。アプリケーションの特定のリクエストなしにレンダラによってプロパティが変更される場合にのみ配信されます。属性変更イベントの例には、クライアント側のサイズ変更をサポートしていた列の幅などがあります。 |
binding | String | ELのみ | コンポーネントのインスタンスを格納するためのバインディング参照を指定します。コンポーネントのタイプはUIGaugeである必要があります。たとえば、SampleGaugeクラスのゲージ・コンポーネントのインスタンスを格納するには、binding="#{sampleGaugeBean.gauge}"というコードを使用します。 |
clickAction | String | あり | グラフのナビゲーション処理を実行するバッキングBeanメソッドを参照して結果文字列を戻します。または静的な結果文字列を指定できます。JSF NavigationHandlerは、アプリケーション構成リソース・ファイル内のナビゲーション・ルールに結果文字列を一致させることにより、次に表示するページを選択します。ナビゲーション・ルールはアプリケーションによって書き込まれます。 |
clickListener | String | あり | 引数としてClickEventを取るバッキングBeanメソッドを参照します。ゲージがクリックされると、このメソッドが処理されます。 |
contentDelivery | String | あり |
データをページのロード時にフェッチするか、ページのロード後にフェッチするかを指定します。有効な値は次のとおりです。
|
customLayout | String | あり |
グラフによってそのコンポーネントの配置とサイズ設定が自動的に行われる場合のカスタム・レイアウト情報を指定します。有効な値は次のとおりです。
|
customShapesPath | String | あり | カスタム図形定義ファイルへのパスを指定します。 |
customizationId | String | あり | この属性は推奨されていません。永続的なカスタマイズを適用するには、id属性を使用する必要があります。この属性は、次のリリースでは削除されます。 |
drillingEnabled | boolean | あり | ゲージでドリル操作を有効にするかどうかを指定します。ゲージではドリル操作がまだサポートされていないため、この属性は常にfalseに設定されます。 |
dynamicResize | String | あり |
コンテナ・サイズに基づいてコンポーネントのサイズを変更するかどうかを指定します。有効な値は次のとおりです。
|
flashDefaultFontLoading | String | あり | デフォルト・フォントを中間層からFLASHにロードするかどうかを指定します。有効な値は次のとおりです。
|
fontURLMap | java.util.Map | あり | フォント名とフォントSWFファイルのURLのマッピングをjava.util.Mapオブジェクトの形式で指定します。このマップでは、キーとしてフォント名が指定され、値としてフォントのURLが指定されている必要があります。 |
gaugeSetAlignment | String | あり | ゲージ・セット内のどこにゲージを表示するかを決定します。有効な値は次のとおりです。
|
gaugeSetColumnCount | String | あり | ゲージ・セットに表示する列数を指定します。有効な値は次のとおりです。
|
gaugeSetDirection | String | あり | ゲージ・セットでゲージを処理する方向です。有効な値は次のとおりです。
|
gaugeType | String | あり | ゲージのタイプを指定します。有効な値は次のとおりです。
|
graphicAntialiasing | boolean | あり | グラフィック領域のアウトラインを滑らかにするためにアンチエイリアスを使用するかどうかを指定します。有効な値はtrue(デフォルト)とfalseです。 |
id | String | なし | コンポーネントの識別子。識別子は、HTMLで許可される構文のサブセットに準拠している必要があります。
|
imageFormat | String | あり | グラフ・イメージの形式。有効な値は次のとおりです。
|
imageHeight | int | あり | かわりにinlineStyle属性を使用してイメージの幅と高さを指定します。例: inlineStyle = "width:500px; height:350px;"
デフォルトの高さは200ピクセルです。 |
imageSource | String | あり | アプリケーションによって生成されたイメージ・ファイルのURIを指定します。たとえば、以前にPNG形式でエクスポートされたイメージがサーバー上に保存されている場合があります。この設定は、イメージのロード元になるベースを決定します。 |
imageWidth | int | あり | かわりにinlineStyle属性を使用してイメージの幅と高さを指定します。例: inlineStyle = "width:500px; height:350px;"
デフォルトの幅は200ピクセルです。 |
inlineStyle | String | あり | コンポーネントの外側の要素のスタイル |
ledStyle | String | あり | LEDゲージの種類を指定します。有効な値は次のとおりです。
|
ledStyleCallback | oracle.dss.gauge.LEDStyleCallback | あり | カスタムLEDスタイルを定義するコードを指定します。通常、コールバックのコードはゲージのバッキングBeanに格納されます。たとえば、ledStyleCallback="{sampleGauge.myStyleCallback}"のように入力します。 |
maxValue | double | あり | ゲージのスケールと軸の最大値を指定します。この属性を指定しない場合、最大値は自動的に計算されます。 |
minValue | double | あり | ゲージのスケールと軸の最小値を指定します。この属性を指定しない場合、最小値は自動的に計算されます。 |
otherProperties | String | あり | XML文字列の形式で他のプロパティの設定を指定します。たとえば、この属性を使用すると、gradientDirectionなどのSFXプロパティを設定できます。 |
partialSubmit | boolean | あり | ページの部分送信を使用して処理を実行するかどうかを指定します。有効な値はtrue(デフォルト)とfalseです。 |
partialTriggers | String | あり | 部分更新をトリガーする必要があるコンポーネントのIDを指定します。このコンポーネントはトリガー・コンポーネントをリスニングします。なんらかの方法で更新を発生させるイベントがいずれかのトリガー・コンポーネントで受信されると、このコンポーネントも更新を要求します。 |
renderImagemap | boolean | あり | イメージマップ(PNG)をレンダリングする必要があるかどうかを指定します。有効な値はtrue(デフォルト)とfalseです。 |
rendered | boolean | あり | コンポーネントをレンダリングするかどうかを指定します。 |
shortDesc | String | あり | ゲージの簡単な説明。スクリーン・リーダー・モードを使用する場合に役立ちます。 |
specularHighlight | String | あり | LS_DOTのLEDゲージに三日月形のハイライトを表示するかどうかを指定します。有効な値は、SH_ON(デフォルト)とSH_OFFです。SH_ONの場合、三日月形のハイライトが表示されます。SH_OFFの場合、三日月形のハイライトは表示されません。 |
styleClass | String | あり | このコンポーネントに対して使用するCSSスタイル・クラスを設定します。幅および高さはinlineStyleプロパティを使用して設定する必要があることに注意してください。 |
svgFontEmbedding | String | あり | 注意: SVGは出力形式としてのみサポートされているため、この属性は使用しないでください。この属性は、フォントを生成済SVGに直接埋め込むかどうかを指定します。この属性によって、中間層で使用可能なフォントと、クライアントで使用可能フォントとの間の不一致を回避できます。有効は値は次のとおりです。
|
tabularData | java.util.List | あり | java.util.Listオブジェクトの形式でゲージに表データ・セットを提供します。 |
textAntialiasing | boolean | あり | テキスト文字を滑らかにするためにアンチエイリアスを使用するかどうかを指定します。有効な値はtrueとfalse(デフォルト)です。 |
thresholdDialStyle | String | あり | しきい値のあるダイアル・ゲージのスタイルです。有効な値は次のとおりです。
|
value | String | あり | ゲージ・データ・モデル。これは、DataModelのインスタンスである必要があります。また、この属性では、(Java.lang.NumberオブジェクトまたはStringとして表現される)数値を指定することもできます。この数値はメトリック値として設定さます。 |
visualEffects | String | あり |
適用するvisualEffectのタイプを1つまたは複数指定します。有効な値は次のとおりです。
|