[]
【重要】2024年1月公開のアップデート「未適用」のお客様へ デモ ヘルプ APIリファレンス
トライアル版
(Showing Draft Content)

Wijmo_Gauge.Lineargauge

LinearGauge クラス

LinearGauge は、1つの値を表すインジケータと、参照値を表す範囲 （オプション）を使用して、線形目盛りを表示します。

ゲージのLinearGauge.isReadOnly プロパティを falseに設定すると、 ユーザーがゲージをクリックして値を編集できるようになります。

Example

階層

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

  • new LinearGauge(element: any, options?: any): LinearGauge

  • LinearGauge クラスの新しいインスタンスを初期化します。

    引数

    • element: any

      コントロールをホストするDOM要素、またはホスト要素のCSS セレクター（例: '#theCtrl'）。

    • オプション options: any

      コントロールの初期化データを含むJavaScriptオブジェクト。

    戻り値 LinearGauge

プロパティ

direction

direction: GaugeDirection

ゲージの値が増加する方向を取得または設定します。

このプロパティのデフォルト値はGaugeDirection.Rightです。

face

face: Range

ゲージの全体的な形状と外観を表すために使用される Range を取得または設定します。

faceBounds

faceBounds: Rect

ゲージのフェイス要素の境界を取得します。

このプロパティは、ゲージ上にカスタムのSVG要素を配置するために使用されます。

format

format: string

ゲージ値をテキストとして表示するために使用される書式文字列を取得または設定します。

getText

getText: Function

ゲージ値の表示に使用されるカスタマイズされた文字列を返す コールバックを取得または設定します。

このプロパティは、ゲージに表示される文字列をカスタマイズしたいが、 format プロパティでは十分でない場合に使用してください。

指定する場合、コールバック関数は、ゲージ、部分名、値、および 書式設定された値をパラメータとして取る必要があります。また、ゲージに表示される文字列を返す必要があります。

次に例を示します。

// 値を文字列に変換するコールバック
gauge.getText = function (gauge, part, value, text) {
  switch (part) {
    case 'value':
      if (value <= 10) return 'Empty!';
      if (value <= 25) return 'Low...';
      if (value <= 95) return 'Good';
      return 'Full';
    case 'min':
      return 'EMPTY';
    case 'max':
      return 'FULL';
  }
  return text;
}

hasShadow

hasShadow: boolean

ゲージに影の効果を表示するかどうかを示す値を取得または 設定します。

このプロパティのデフォルト値はtrueです。

hostElement

hostElement: HTMLElement

コントロールをホストしているDOM要素を取得します。

isAnimated

isAnimated: boolean

Gauge が値の変更を示すためにアニメーションを使用するか どうかを決定する値を取得または設定します。

このプロパティのデフォルト値はtrueです。

isDisabled

isDisabled: boolean

コントロールが無効かどうかを判定する値を取得または設定します。

無効化されたコントロールは、マウスイベントやキーボードイベントを取得できません。

isReadOnly

isReadOnly: boolean

ユーザーがマウスとキーボードを使用して値を編集できるかどうかを示す値を 取得または設定します。

このプロパティのデフォルト値はtrueです。

isTouching

isTouching: boolean

現在、コントロールがタッチイベントを処理しているかどうかを示す値を取得します。

isUpdating

isUpdating: boolean

コントロールが現在更新中かどうかを示す値を取得します。

max

max: number

ゲージに表示できる最大値を取得または設定します。

min およびmax プロパティの使用方法については、 「minおよびmaxプロパティの使用」トピックを参照してください。

min

min: number

ゲージに表示できる最小値を取得または設定します。

min およびmax プロパティの使用方法については、 「minおよびmaxプロパティの使用」トピックを参照してください。

origin

origin: number

範囲を描画するための始点を取得または設定します。

デフォルトでは、このプロパティはnullに設定されており、値の範囲はゲージの最小値から始まります。最小値がゼロ未満の場合はゼロから始まります。

pointer

pointer: Range

ゲージの現在の値を表すために使用される Range を取得または設定します。

ranges

ranges: ObservableArray

このゲージの範囲のコレクションを取得します。

rightToLeft

rightToLeft: boolean

要素内のコントロールを右から左のレイアウトでホストするかどうかを示す値を取得します。

showRanges

showRanges: boolean

ranges プロパティに含まれる範囲をゲージに表示するかどうか を示す値を取得または設定します。

このプロパティがfalseに設定されている場合、ranges プロパティに含まれる範囲はゲージに表示されません。 代わりに、これらは、値の変化のアニメーション中に、pointer 範囲の色を補間するために使用されます。 このプロパティのデフォルト値は true です。

showText

showText: ShowText

ゲージにテキストとして表示する ShowText の値を取得または設定します。

このプロパティのデフォルト値については、RadialGaugeコントロールの場合は ShowText.All 、とLinearGauge コントロールの場合は ShowText.None です。

showTicks

showTicks: boolean

ゲージで、各 step 値に目盛りマークを表示するかどうかを決定するプロパティを 取得または設定します。

目盛りマークは、CSSでwj-gaugeクラス名とwj-ticksクラス名を 使用して書式設定できます。次に例を示します。

.wj-gauge .wj-ticks {
    stroke-width: 2px;
    stroke: white;
}

このプロパティのデフォルト値は false です。

stackRanges

stackRanges: boolean

ranges コレクションに含まれる範囲をゲージ内に積み重ねる かどうかを決定する値を取得または設定します。

stackRanges のデフォルト値はfalseであり、ranges コレクションの範囲はゲージのフェイスと同じ太さで表示されます。

stackRanges をtrueに設定すると、範囲が狭くなり、 並んで表示されます。

step

step: number

ユーザーが方向キーを押すかマウスホイールを回したときに value プロパティを増減する量を取得または設定します。

thickness

thickness: number

ゲージの太さを0~1のスケールで取得または設定します。

thicknessを1に設定すると、ゲージは最大限に太くなります。

値が小さいほどゲージは細くなります。

thumbSize

thumbSize: number

ゲージの現在の値を示す要素のサイズ（ピクセル単位）を取得または設定します。

tickSpacing

tickSpacing: number

目盛りマークの間隔を取得または設定します。

目盛りマークの間隔を取得または設定します。

ゲージ上に目盛りを表示するようにするには、showTicks　プロパティをtrueに設定します。 デフォルトでは、目盛りマークの間隔はstep プロパティによって定義されます。

tickSpacing プロパティを使用してデフォルトをオーバーライドし、 step プロパティの値と異なるスペーシングを設定できます。 デフォルトの動作に戻すには、tickSpacing プロパティをnullに 設定します。

value

value: number

ゲージに表示される値を取得または設定します。

静的 controlTemplate

controlTemplate: string

Gauge コントロールのインスタンス化に使用されるテンプレートを取得または設定します。

メソッド

addEventListener

  • addEventListener(target: EventTarget, type: string, fn: any, capture?: boolean, passive?: boolean): void

  • このControl が所有する要素にイベントリスナーを追加します。

    コントロールは、アタッチされているリスナーとそのハンドラのリストを保持し、 コントロール が破棄されているときにそれらを簡単に削除すること ができます（dispose と removeEventListener ) メソッドを参照してください）。

    イベントリスナーを削除しないと、メモリリークが発生する可能があります。

    デフォルトでは passive パラメータはfalseに設定されています。これはイベントハンドラが event.preventDefault() を呼び出すことを意味します。 タッチイベントまたはマウスホイールイベントにpassiveハンドラを追加する場合は、このパラメータをtrueに設定するとアプリケーションのパフォーマンスが向上します。

    passive　イベントリスナーの詳細については、「Improving scrolling performance with passive listeners」を参考してください。

    引数

    • target: EventTarget

      イベントのターゲット要素。

    • type: string

      イベントを指定する文字列。

    • fn: any

      イベントが発生したときに実行する関数。

    • オプション capture: boolean

      リスナーがターゲット要素によって処理される前にコントロールによって処理される必要があるかどうかを示します。

    • オプション passive: boolean

      ハンドラーが preventDefault() を呼び出さないことを示します。

    戻り値 void

applyTemplate

  • applyTemplate(classNames: string, template: string, parts: Object, namePart?: string): HTMLElement

  • コントロールの新しいインスタンスにテンプレートを適用し、ルート要素を返します。

    このメソッドはテンプレート化されたコントロールのコンストラクターによって呼び出され、 テンプレートのパーツを対応するコントロールメンバにバインドする役割を持ちます。 以下のサンプルコードは、InputNumber コントロールのインスタンスにテンプレートを適用します。 このテンプレートには、'wj-part'属性が'input'、'btn-inc'、および'btn-dec'に設定された要素を含める必要があります。 コントロールのメンバである'_tbx'、'_btnUp'、'_btnDn'には、これらの要素への参照が割り当てられます。

    this.applyTemplate('wj-control wj-inputnumber', template, {
  _tbx: 'input',
  _btnUp: 'btn-inc',
  _btnDn: 'btn-dec'
}, 'input');

    引数

    • classNames: string

      コントロールのホスト要素に追加するクラスの名前。

    • template: string

      コントロールのテンプレートを定義するHTML文字列。

    • parts: Object

      パーツ変数とその名前のディクショナリー。

    • オプション namePart: string

      ホスト要素にちなんで名付けられたパーツの名前。 これにより、コントロールがフォームで使用されたときにデータをどのように送信するかが決まります。

    戻り値 HTMLElement

beginUpdate

  • beginUpdate(): void

containsFocus

  • containsFocus(): boolean

  • このコントロールにフォーカスのある要素が含まれているかどうかをチェックします。

    戻り値 boolean

deferUpdate

  • deferUpdate(fn: Function): void

  • beginUpdate/endUpdate ブロック内で関数を実行します。

    この関数の実行が完了するまでコントロールは更新されません。 このメソッドは、関数が例外を生成した場合でも endUpdate が呼び出されるようにします。

    引数

    • fn: Function

      実行する関数。

    戻り値 void

dispose

  • dispose(): void

  • ホスト要素との関連付けを解除することによってコントロールを破棄します。

    dispose メソッドは、addEventListener メソッドによって 追加されたイベントリスナーを自動的に削除します。

    コントロールを動的に作成および削除するアプリケーションでは、 dispose メソッドを呼び出すことが重要です。 コントロールを破棄しないと、 メモリリークが発生する可能があります。.

    戻り値 void

endUpdate

  • endUpdate(): void

focus

  • focus(): void

  • このコントロールにフォーカスを設定します。

    戻り値 void

getTemplate

  • getTemplate(): string

  • コントロールのインスタンスの作成に使用されたHTMLテンプレートを取得します。

    このメソッドは、クラス階層をさかのぼってコントロールのテンプレートを指定する最も近い祖先を探します。 たとえば、ComboBox コントロールのプロトタイプを指定した場合、 そのプロトタイプによってDropDown 基本クラスで定義されたテンプレートがオーバーライドされます。

    戻り値 string

hasOwnProperty

  • hasOwnProperty(v: PropertyKey): boolean

  • オブジェクトが指定されたプロパティを持つかどうかを判定します。

    引数

    • v: PropertyKey

      プロパティの名前。

    戻り値 boolean

hitTest

  • hitTest(pt: any, y?: number): number

  • 指定したポイントにあるゲージの値に対応する数値を取得します。

    例: 

    // ユーザーがゲージをクリックしたときにそのポイントのヒットテストを行います。
gauge.hostElement.addEventListener('click', function (e) {
  var ht = gauge.hitTest(e.pageX, e.pageY);
  if (ht != null) {
    console.log('you clicked the gauge at value ' + ht.toString());
  }
});

    引数

    • pt: any

      調べるポイント（ウィンドウ座標単位）、MouseEventオブジェクト、またはポイントのX座標。

    • オプション y: number

      ポイントのY座標（最初のパラメーターが数値の場合）。

    戻り値 number

initialize

  • initialize(options: any): void

  • 指定したオブジェクトからプロパティをコピーしてコントロールを初期化します。

    このメソッドを使用すると、各プロパティの値をコードで設定する代わりにプレーンなデータオブジェクトを使用してコントロールを初期化できます。

    例: 

    grid.initialize({
  itemsSource: myList,
  autoGenerateColumns: false,
  columns: [
    { binding: 'id', header: 'Code', width: 130 },
    { binding: 'name', header: 'Name', width: 60 }
  ]
});
// これは以下と同等です。
grid.itemsSource = myList;
grid.autoGenerateColumns = false;
// など

    初期化データは適用時に型チェックされます。 初期化オブジェクトに不明なプロパティ名または無効なデータ型が含まれている場合、このメソッドは例外をスローします。

    引数

    • options: any

      初期化データを含むオブジェクト。

    戻り値 void

invalidate

  • invalidate(fullUpdate?: boolean): void

  • 非同期更新を発生させるため、コントロールを無効にします。

    引数

    • オプション fullUpdate: boolean

      内容だけでなくコントロールのレイアウトも更新するかどうか。

    戻り値 void

isPrototypeOf

  • isPrototypeOf(v: Object): boolean

  • オブジェクトが別のオブジェクトのプロトタイプチェーンに存在するかどうかを判定します。

    引数

    • v: Object

      プロトタイプチェーンが判定される別のオブジェクト。

    戻り値 boolean

onGotFocus

onLostFocus

onRefreshed

onRefreshing

onValueChanged

propertyIsEnumerable

  • propertyIsEnumerable(v: PropertyKey): boolean

  • 指定されたプロパティが列挙可能かどうかを判断します。

    引数

    • v: PropertyKey

      プロパティの名前。

    戻り値 boolean

refresh

  • refresh(fullUpdate?: boolean): void

  • コントロールを更新します。

    引数

    • オプション fullUpdate: boolean

      内容だけでなくコントロールのレイアウトも更新するかどうかを示します。

    戻り値 void

removeEventListener

  • removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number

  • このControl が所有する要素にアタッチされている1つまたは複数のイベントリスナーを解除します。

    引数

    • オプション target: EventTarget

      イベントのターゲット要素。 nullの場合、すべてのターゲットにアタッチされているリスナーが解除されます

    • オプション type: string

      イベントを指定する文字列。 nullの場合、すべてのイベントにアタッチされているリスナーが解除されます。

    • オプション fn: any

      削除するハンドラ。 nullの場合は、すべてのハンドラが削除されます。

    • オプション capture: boolean

      リスナーがキャプチャリスナーかどうか。 nullの場合、キャプチャリスナーと非キャプチャリスナーの両方が解除されます。

    戻り値 number

toLocaleString

  • toLocaleString(): string

  • 現在のロケールを使用して文字列に変換された日付を返します。

    戻り値 string

toString

  • toString(): string

  • オブジェクトの文字列表現を返します。

    戻り値 string

valueOf

  • valueOf(): Object

  • 指定されたオブジェクトのプリミティブ値を返します。

    戻り値 Object

静的 disposeAll

  • disposeAll(e?: HTMLElement): void

  • HTML要素に含まれるすべてのWijmoコントロールを破棄します。

    引数

    • オプション e: HTMLElement

      コンテナー要素。

    戻り値 void

静的 getControl

  • getControl(element: any): Control

  • 指定したDOM要素でホストされているコントロールを取得します。

    引数

    • element: any

      コントロールをホストするDOM要素、またはホスト要素のCSS セレクター（例: '#theCtrl'）。

    戻り値 Control

静的 invalidateAll

  • invalidateAll(e?: HTMLElement): void

  • 指定したHTML要素に含まれるすべてのWijmoコントロールを無効化します。

    このメソッドは、コントロールの表示状態やサイズを変更する 動的なパネルをアプリケーションで使用している場合に使用します。 たとえば、スプリッタ、アコーディオン、およびタブコントロールは通常、 その中の要素の表示状態を変更します。この場合、その要素に含まれるコントロールに通知しないと、 それらのコントロールが適切に機能しなくなる可能性があります。 これが起こる場合は、動的コンテナーで適切なイベントを処理し、 Control.invalidateAll メソッドを呼び出してコンテナー内のWijmoコントロールの レイアウト情報が適切に更新されるようにする必要があります。

    引数

    • オプション e: HTMLElement

      コンテナー要素。nullに設定すると、ページ上に存在するすべてのWijmoコントロールが無効化されます。

    戻り値 void

静的 refreshAll

  • refreshAll(e?: HTMLElement): void

  • HTML要素で存在するすべてのWijmoコントロールを更新する。

    コントロールが時間おいて更新される代わりに直ちに更新されること以外はinvalidateAll メソッドと同様です。

    引数

    • オプション e: HTMLElement

      コンテナー要素。nullに設定すると、ページ上に存在するすべてのWijmoコントロールが無効化されます。

    戻り値 void

イベント

gotFocus

gotFocus: Event

コントロールがフォーカスを取得したときに発生します。

lostFocus

lostFocus: Event

コントロールがフォーカスを失ったときに発生します。

refreshed

refreshed: Event

コントロールが内容を更新した後で発生します。

refreshing

refreshing: Event

コントロールが内容を更新する直前に発生します。

valueChanged

valueChanged: Event

value プロパティの値が変更されたときに発生します。