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

Wijmo_Viewer.Viewerbase

ViewerBase クラス

すべてのビューアコントロールの基本クラス。

階層

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

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

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

    引数

    • element: any

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

    • オプション options: any

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

    戻り値 ViewerBase

プロパティ

filePath

filePath: string

サーバー上のドキュメントの完全パスを取得または設定します。

パスは、指定されたドキュメントをロードするためにサーバーに登録されているプロバイダのキーで始まります。

fullScreen

fullScreen: boolean

ビューアが全画面表示モードかどうかを示す値を取得または設定します。

hostElement

hostElement: HTMLElement

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

isTouching

isTouching: boolean

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

isUpdating

isUpdating: boolean

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

mouseMode

mouseMode: MouseMode

マウスの動作を示す値を取得または設定します。

デフォルトはSelectToolです。その場合は、マウスでクリックしてドラッグすると、テキストが選択されます。

pageIndex

pageIndex: number

ビューパネルに現在表示されているページのインデックスを取得します。

requestHeaders

requestHeaders: any

データを送信または要求するときに使用する要求ヘッダーを含むオブジェクトを取得または設定します。

このプロパティは、認証が必要なシナリオでよく使用されます。以下に例を示しています。

viewer.requestHeaders = {
    Authorization: 'Bearer ' + appAuthService.getToken();
};

rightToLeft

rightToLeft: boolean

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

serviceUrl

serviceUrl: string

C1 Web APIサービスのアドレスを取得または設定します。

例："http://demos.componentone.com/ASPNET/c1webapi/4.0.20172.105/api/report"。

thresholdWidth

thresholdWidth: number

モバイルテンプレートとPCテンプレートの切り替えに使用するしきい値を取得または設定します。

デフォルト値は767pxです。コントロールの幅がthresholdWidthより小さい場合は、 モバイルテンプレートが適用されます。コントロールの幅がthresholdWidth以上の場合は、PCテンプレートが適用されます。 thresholdWidthを0に設定すると、PCテンプレートだけが適用されます。 9999などの大きな数字に設定すると、モバイルテンプレートだけが適用されます。

viewMode

viewMode: ViewMode

ドキュメントページの表示方法を示す値を取得または設定します。

zoomFactor

zoomFactor: number

ドキュメントページを表示する現在のズーム倍率を示す値を取得または設定します。

zoomMode

zoomMode: ZoomMode

ドキュメントページを表示する現在のズームモードを示す値を取得または設定します。

静的 controlTemplate

controlTemplate: string

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

メソッド

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

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

moveToPage

  • 指定したインデックスにあるページに移動します。

    引数

    • index: number

      移動先のページの0から始まるインデックス。

    戻り値 IPromise

    An wijmo.viewer.IPromise object with current page index.

onBeforeSendRequest

onFullScreenChanged

onGotFocus

onLostFocus

onMouseModeChanged

onPageIndexChanged

onPageLoaded

onQueryLoadingData

onRefreshed

onRefreshing

onViewModeChanged

onZoomFactorChanged

onZoomModeChanged

propertyIsEnumerable

  • propertyIsEnumerable(v: PropertyKey): boolean

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

    引数

    • v: PropertyKey

      プロパティの名前。

    戻り値 boolean

refresh

  • refresh(fullUpdate?: boolean): void

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

    引数

    • オプション fullUpdate: boolean

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

    戻り値 void

reload

  • reload(): void

  • ドキュメントを再ロードします。

    これは、ドキュメントを強制的に再ロードおよび再レンダリングする場合に便利です。

    戻り値 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

    The number of listeners removed.

showPageSetupDialog

  • showPageSetupDialog(): void

  • ページ設定ダイアログボックスを表示します。

    戻り値 void

toLocaleString

  • toLocaleString(): string

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

    戻り値 string

toString

  • toString(): string

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

    戻り値 string

valueOf

  • valueOf(): Object

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

    戻り値 Object

zoomToView

  • zoomToView(): void

  • 現在のページを拡大縮小して、ビューパネルにページ全体を表示します。

    戻り値 void

zoomToViewWidth

  • zoomToViewWidth(): void

  • ビューパネルの幅に合わせて現在のページを拡大縮小します。

    戻り値 void

静的 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

イベント

beforeSendRequest

beforeSendRequest: Event<ViewerBase, RequestEventArgs>

各要求がサーバーに送信される前に発生します。

このイベントでは、サーバーに送信する前に、URL、ヘッダー、データなどのリクエストオプションに加えてリクエストメソッドも変更できます。 このイベントは、RequestEventArgs 型の引数を渡します。 そのプロパティは、wijmo.httpRequest メソッドのパラメータと同じ意味と構造を持ち、要求属性を更新するように変更できます。

たとえば、認証トークンを 'Authorization'ヘッダーに入れることができます。

viewer.beforeSendRequest.addHandler((s, e) => {
    e.settings.requestHeaders.Authorization = 'Bearer ' + appAuthService.getToken();
});

ブラウザで自動的に（たとえば、URLがwindow.open() 関数へのパラメータとして、 またはHTMLリンクとして使用される場合）実行されるHTTP要求が誘導するためにURLが使用されている場合、 e.settings引数はnullになります。

fullScreenChanged

fullScreenChanged: Event<ViewerBase, EventArgs>

全画面表示モードが変更された後に発生します。

gotFocus

gotFocus: Event<Control, EventArgs>

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

lostFocus

lostFocus: Event<Control, EventArgs>

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

mouseModeChanged

mouseModeChanged: Event<ViewerBase, EventArgs>

マウスモードが変更された後に発生します。

pageIndexChanged

pageIndexChanged: Event<ViewerBase, EventArgs>

ページインデックスが変更された後に発生します。

pageLoaded

pageLoaded: Event<ViewerBase, PageLoadedEventArgs>

サーバーから次のページが読み込まれ、そのSVGが描画されたときに発生します。

queryLoadingData

queryLoadingData: Event<ViewerBase, QueryLoadingDataEventArgs>

ドキュメントのロード前に、サービスに送られる要求データをクエリーしたときに発生します。

refreshed

refreshed: Event<Control, EventArgs>

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

refreshing

refreshing: Event<Control, EventArgs>

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

viewModeChanged

viewModeChanged: Event<ViewerBase, EventArgs>

ビューモードが変更された後に発生します。

zoomFactorChanged

zoomFactorChanged: Event<ViewerBase, _IZoomFactorChangedEventArgs>

ズーム倍率が変更された後に発生します。

zoomModeChanged

zoomModeChanged: Event<ViewerBase, _IZoomModeChangedEventArgs>

ズームモードが変更された後に発生します。