Interface: ExposerEvent

Data Visualizer とビジュアルパーツが連携するためのイベントのインターフェースです。ビジュアルパーツ側で取得したいイベントを設定し、最後に event.loaded.emit() をコールしてください。当イベントをコールした後に、Data Visualizer とのイベント連携が開始されます。

example

event.time.on((time) => {
  // do something
})
event.viewBox.on((viewBox) => {
  // do something
})

// イベント取得追加設定...

// イベント初期設定の完了通知
event.loaded.emit()

Properties

backgroundDisplay

• backgroundDisplay: object

このビジュアルパーツが Data Visualizer の背景として表示されているかどうかを取得します。背景として表示される際に表現を切り替えたい場合に使用します。

example

event.backgroundDisplay.on((backgroundDisplay) => {
  if (backgroundDisplay.selected) {
    // e.g. deactive background display button
  } else {
    // e.g. active background display button
  }
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: BackgroundDisplay) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: BackgroundDisplay) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: BackgroundDisplay) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

backgroundDisplayToggle

• backgroundDisplayToggle: object

ビジュアルパーツを Data Visualizer の背景として表示するかどうかを切り替えます。

example

event.backgroundDisplay.on((backgroundDisplay) => {
  // 初回: false を取得
  // buttonElement click直後: true を取得
  console.log(backgroundDisplay.selected)
})

buttonElement.onclick = () => {
  event.backgroundDisplayToggle.emit()
}

Type declaration:

Name	Type	Description
`emit`	(`event`: void) => void	イベントを送信します

baseURL

• baseURL: object

ビジュアルパーツの Base URL を Data Visualizer から取得します。画像を表示するときにパスの一部として使用します。

example

event.baseURL.on((baseURL) => {
  const imgSrc = `${baseURL}/image.png`
  // do something...
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: string) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: string) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: string) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

captureCreate

• captureCreate: object

Data Visualizer に表示されている時間範囲のCaptureを作成する画面を表示します。タイムラインで時間範囲が選択されている場合は、その範囲がCaptureになります。

example

event.captureCreate.emit()

Type declaration:

Name	Type	Description
`emit`	(`event`: void) => void	イベントを送信します

comparationTimeChangeWithPagePosition

• comparationTimeChangeWithPagePosition: object

Data Visualizer のタイムラインに設定されている比較対象時刻を変更します。当イベントは、標準ビジュアルパーツ Line Graph 専用のイベントで、 非推奨 です。

deprecated

Type declaration:

Name	Type	Description
`emit`	(`event`: ComparationTimeChangeWithPagePosition) => void	イベントを送信します

currentData

• currentData: object

Data Visualizer でパネルにバインドされている計測データの、再生位置のデータポイントを取得します。任意の計測データをビジュアルパーツで表現したい場合に使用します。データが存在しない場合は、 time=0, data="" となります。

example

event.currentData.on(({ dataIndex, data, time }) => {
  console.log(dataIndex) // バインドされているデータのIndex (0, ...)
  console.log(time)      // データが存在しない場合は 0
  console.log(data)      // バインドされているデータに紐づく計測データ
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: { `data`: any ; `dataIndex`: number ; `time`: number }) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: { `data`: any ; `dataIndex`: number ; `time`: number }) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: { `data`: any ; `dataIndex`: number ; `time`: number }) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

dataSpecification

• dataSpecification: object

Data Visualizer でパネルにバインドされているデータの定義を取得します。データバインドの変更後に、バインドされたデータの定義を取得して、表現を切り替えたい場合に使用します。

example

event.dataSpecification.on(({ dataIndex, spec }) => {
  console.log(dataIndx) // 変更されたバインドデータのIndex: 0 or 1 or ...
  console.log(spec)     // DataSpecificationの仕様を参照してください
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: { `dataIndex`: number ; `spec`: DataSpecification }) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: { `dataIndex`: number ; `spec`: DataSpecification }) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: { `dataIndex`: number ; `spec`: DataSpecification }) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

dataSpecifications

• dataSpecifications: object

Data Visualizer でデータのバインドが1つでも変更された場合(追加、変更、削除のいずれか)にデータバインドの情報をまとめて取得します。複数のデータバインドをまとめて取得して、表現を切り替えたい場合に使用します。

example

event.dataSpecifications.on((specs) => {
  console.log(specs)  // DataSpecificationの仕様を参照してください。
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: DataSpecification[]) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: DataSpecification[]) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: DataSpecification[]) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

depDatas

• depDatas: object

Data Visualizer のパネルにバインドされているデータリストのいずれかが変更されたときにイベントを取得します。当イベントは非推奨です。 dataSpecificationsイベントを参照してください。

deprecated

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: DepData[]) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: DepData[]) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: DepData[]) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

error

• error: object

ビジュアルパーツ内部で発生したエラーを Data Visualizer に通知します。

example

event.error.emit(new Error('error'))

Type declaration:

Name	Type	Description
`emit`	(`event`: Error) => void	イベントを送信します

extension

• extension: object

Data Visualizer のパネルにバインドされているビジュアルパーツの拡張設定情報を取得します。拡張設定情報を使用してビジュアルパーツの表現を切り替えたい場合に使用します。 extension の情報は任意のObject形式で取得します。各ビジュアルパーツ内でバリデーションを行ってください。

example

event.extension.on((extension) => {
  console.log(extension) // Object
  // validate extension
  // ...
  // use extension
  // ...
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: Extension) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: Extension) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: Extension) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

extensionPatch

• extensionPatch: object

Data Visualizer に、ビジュアルパーツの拡張設定情報の一部を送信し、永続化します。拡張設定の全ての項目が確定している場合は、全項目を送信しても問題ありません。

example

type Extension = {
  n: number
  s: string
}

let extension = {}
event.exension.on((recvExtension) => {
  // validate extension
  // ...
  extension = recvExtension
})

// do something

// nのproperty のみ差分で更新する
event.extensionPatch.emit({
  n: 100, // patch n=100
})

Type declaration:

Name	Type	Description
`emit`	(`event`: Extension) => void	イベントを送信します

fontFamilies

• fontFamilies: object

ビジュアルパーツで表示するフォントファミリーを Data Visualizer から取得します。取得したフォントファミリーをビジュアルパーツのスタイルに適用する際に使用します。

example

event.fontFamilies.on((fontFamilies) => {
  element.style.fontFamily = fontFamilies.apt7seg
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: FontFamilies) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: FontFamilies) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: FontFamilies) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

googleMapsOptions

• googleMapsOptions: object

Data Visualizer から、 Google Maps のオプション情報(Google Maps API Key を含む)を取得します。ビジュアルパーツ内で Google Maps を使用する場合に使用します。

example

event.googleMapsOptions.on((options) => {
  // 空文字列のフィールドは値が未設定であることを表します。
  // 両方のフィールドに値が設定されている場合は、clientID を使用してください。
  console.log(options) // { apiKey: "....", clientID: "...." }
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: GoogleMapsOptions) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: GoogleMapsOptions) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: GoogleMapsOptions) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

loaded

• loaded: object

Data Visualizer に、ビジュアルパーツのイベント取得初期設定が完了したことを通知します。 Data Visualizer は当イベントを取得すると、ビジュアルパーツへの各イベントの送信を開始します。

example

// 各イベントの初期設定
// event.xxxxx.on(() => {...})

// Data Visualizer にイベント初期設定完了を通知する
event.loaded.emit()

Type declaration:

Name	Type	Description
`emit`	(`event`: void) => void	イベントを送信します

measurement

• measurement: object

Data Visualizer が作成した計測について、その情報 Measurement を取得します。 iSCP の Upstream を利用して、ビジュアルパーツから計測データを送信する場合に使用します。計測が未作成の場合、または計測が終了した場合は null になります。

since Data Visualizer v3.8.0

example

event.measurement.on((measurement) => {
  console.log(measurement)
  // 計測情報を作成済み
  // {
  //   uuid: "00000000-0000-0000-0000-000000000000",
  //   baseTime: 1604027947.123456,
  //   edgeUUID: "00000000-0000-0000-0000-000000000000",
  // }
  //
  // 計測が未作成、または終了済み
  // null
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: `null` \| Measurement) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: `null` \| Measurement) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: `null` \| Measurement) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

measurementCreate

• measurementCreate: object

時系列データを Data Visualizer からサーバーに送信するために、 Data Visualizer で計測 Measurement を作成します。 LIVE 再生中、または LIVE 一時停止中のみ受け付け可能です。

since Data Visualizer v3.8.0

example

event.measurementCreate.emit()

Type declaration:

Name	Type	Description
`emit`	(`event`: void) => void	イベントを送信します

playbackComparationTime

• playbackComparationTime: object

比較対象の時刻（Compared Position）を Data Visualizer から取得します。時刻の情報は、ビジュアルパーツ内に時刻を表示するために使用することができます。また、 values で取得した時系列データ(ValueData の配列）の中から比較対象のデータを得るために使用することができます。

example

event.playbackComparationTime.on((time) => {
  // Format. `UnixTimeタイムスタンプ.小数点(マイクロ秒)`
  // e.g. time = 1604027947.123456
  // -> 2020/10/30 12:19:07.123456 (JST)
  element.textContent = String(time)
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: number) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: number) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: number) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

playbackCount

• playbackCount: object

Data Visualizer で再生を実施した回数を取得します。再生回数は以下のタイミングでインクリメントされます。

pause、stop から play に変更した。
Stored Data 再生で、最後まで表示した。
再生中にタイムラインを使って任意の時刻に移動した。

example

event.playbackCount.on((playbackCount) => {
  console.log(playbackCount) // `1, 2, ....`
  // do something
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: number) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: number) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: number) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

playbackMode

• playbackMode: object

Data Visualizer の再生モードを取得します。 LIVE 再生中であるか Stored Data の再生中であるかによってビジュアルパーツ内の表示を切り替えたい場合に使用します。

example

event.playbackMode.on((playbackMode) => {
  console.log(playbackMode) // `live` or `stored_data`
  // do something
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: PlaybackMode) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: PlaybackMode) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: PlaybackMode) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

playbackRate

• playbackRate: object

Data Visualizer の再生速度を取得します。再生速度に応じて、ビジュアルパーツの表現を切り替えたい場合に使用します。

example

event.playbackRate.on((playbackRate) => {
  // 1x: 1
  // 2x: 2
  // 0.5x: 0.5
  console.log(playbackRate)
  // do something
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: number) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: number) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: number) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

playbackStatus

• playbackStatus: object

Data Visualizer の再状状態を取得します。再生状態が、再生、停止、一時停止のどれであるかによってビジュアルパーツ内の表示を切り替えたい場合に使用します。

example

event.playbackStatus.on((playbackStatus) => {
  console.log(playbackStatus) // `play` or `pause` or `stop`
  // do something
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: PlaybackStatus) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: PlaybackStatus) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: PlaybackStatus) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

playbackTimeRange

• playbackTimeRange: object

Data Visualizer が再生している時間範囲を取得します。再生時間範囲に応じてビジュアルパーツの表現を切り替えたい場合に使用します。 LIVE 再生時の再生時間範囲は、一定の長さ(Data Visualiser の Timeline Settings の LIVE Duration Time )を保持したまま常に更新されます。 Stored Data再生時の再生時間範囲は、指定がある場合はその範囲であり、指定がない場合は計測全体です。

example

event.playbackTimeRange.on((timeRange) => {
  console.log(timeRange) // { start: 1604027947.123456, end: 1604029999.555555 }
  // do something
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: PlaybackTimeRange) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: PlaybackTimeRange) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: PlaybackTimeRange) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

playbackTimeSelectedRange

• playbackTimeSelectedRange: object

Data Visualizer で選択されている時間範囲を取得します。タイムライン上で選択された時間範囲についてビジュアルパーツの表現を切り替えたい場合に使用します。タイムライン上で時間範囲が選択されていない場合は、playbackTimeRangeと同じ値になります。

example

event.playbackTimeSelectedRange.on((timeSelectedRange) => {
  console.log(timeSelectedRange) // { start: 1604027947.123456, end: 1604029999.555555 }
  // do something
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: PlaybackTimeSelectedRange) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: PlaybackTimeSelectedRange) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: PlaybackTimeSelectedRange) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

playbackTimeSelectedRangeChange

• playbackTimeSelectedRangeChange: object

ビジュアルパーツ上で指定された範囲を、Data Visualizer のタイムライン上で選択範囲とします。

Type declaration:

Name	Type	Description
`emit`	(`event`: PlaybackTimeSelectedRange) => void	イベントを送信します

playbackTimeSelectedRangeChangeStartMove

• playbackTimeSelectedRangeChangeStartMove: object

Data Visualizer に表示されているタイムラインでの、選択済み範囲をスライドする操作の開始イベントを通知します。通知後の、マウス操作、範囲選択確定処理は、Data Visualizer 側で処理します。当イベントは、標準ビジュアルパーツ Line Graph 専用のイベントで、 非推奨 です。

deprecated

Type declaration:

Name	Type	Description
`emit`	(`event`: PlaybackTimeSelectedRangeChangeWithPageAndRect) => void	イベントを送信します

playbackTimeSelectedRangeChangeStartResizeEnd

• playbackTimeSelectedRangeChangeStartResizeEnd: object

Data Visualizer に表示されているタイムラインでの、選択済み範囲の終点のみをスライドする操作の開始イベントを通知します。通知後の、マウス操作、範囲選択確定処理は、Data Visualizer 側で処理します。当イベントは、標準ビジュアルパーツ Line Graph 専用のイベントで、 非推奨 です。

deprecated

Type declaration:

Name	Type
`emit`	(`event`: PlaybackTimeSelectedRangeChangeWithPageAndRect) => void

playbackTimeSelectedRangeChangeStartResizeStart

• playbackTimeSelectedRangeChangeStartResizeStart: object

Data Visualizer に表示されているタイムラインでの、選択済み範囲の始点のみをスライドする操作の開始イベントを通知します。通知後の、マウス操作、範囲選択確定処理は、Data Visualizer 側で処理します。当イベントは、標準ビジュアルパーツ Line Graph 専用のイベントで、 非推奨 です。

deprecated

Type declaration:

Name	Type	Description
`emit`	(`event`: PlaybackTimeSelectedRangeChangeWithPageAndRect) => void	イベントを送信します

playbackTimeSelectedRangeChangeStartSelect

• playbackTimeSelectedRangeChangeStartSelect: object

Data Visualizer に表示されているタイムラインでの、範囲選択操作の開始イベントを通知します。通知後の、マウス操作、範囲選択確定処理は、Data Visualizer 側で処理します。当イベントは、標準ビジュアルパーツ Line Graph 専用のイベントで、 非推奨 です。

deprecated

Type declaration:

Name	Type	Description
`emit`	(`event`: PlaybackTimeSelectedRangeChangeWithPageAndRect) => void	イベントを送信します

playbackTimeSelectedRangeReset

• playbackTimeSelectedRangeReset: object

Data Visualizer に表示されているタイムラインの選択範囲状態をリセットします。

example

event.playbackTimeSelectedRangeReset.emit()

Type declaration:

Name	Type	Description
`emit`	(`event`: void) => void	イベントを送信します

project

• project: object

Data Visualizer で参照しているプロジェクトの情報を取得します。プロジェクトに紐づくリソースを intdash API を使用して参照する場合に使用します。

since Data Visualizer v3.6.0

example

event.project.on((project) => {
  console.log(project) // { uuid: "00000000-0000-0000-0000-000000000000", name: "GlobalProject" }
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: Project) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: Project) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: Project) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

renderingProfile

• renderingProfile: object

ビジュアルパーツの描画処理に要した時間を Data Visualizer に通知します。

since Data Visualizer v3.3.0

example

event.renderingProfile.emit({
  // ビジュアパーツの描画処理に10.123ミリ秒を要した。
  actualDuration: 0.010123,
})

Type declaration:

Name	Type	Description
`emit`	(`event`: RenderingProfile) => void	イベントを送信します

senderEdge

• senderEdge: object

Data Visualizer で設定している SenderEdge を取得します。

since Data Visualizer v3.8.0

example

event.senderEdge.on((senderEdge) => {
  console.log(senderEdge)
  // Sender Edge の機能が無効
  // {
  //   enabled: false,
  //   uuid: '',
  // }
  //
  // Sender Edge の機能が有効、かつ Sender Edge が未設定
  // {
  //   enabled: true,
  //   uuid: '',
  // }
  //
  // Sender Edge の機能が有効、かつ Sender Edge が設定済み
  // {
  //   enabled: false,
  //   uuid: '28b579ae-08bb-4a09-8452-dc5c10fe3136',
  // }
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: SenderEdge) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: SenderEdge) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: SenderEdge) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

size

• size: object

表示されているビジュアルパーツのサイズ(単位はピクセル)を Data Visualizer から取得します。当イベントは非推奨です。 viewBoxイベントを参照してください。

deprecated

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: { `height`: number ; `width`: number }) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: { `height`: number ; `width`: number }) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: { `height`: number ; `width`: number }) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

time

• time: object

再生位置の時刻を Data Visualizer から取得します。時刻の情報は、ビジュアルパーツ内に時刻を表示するために使用することができます。また、 values で取得した時系列データ（ValueData の配列）の中から再生位置のデータを得るために使用することができます。

example

event.time.on((time) => {
  // Format. `UnixTimeタイムスタンプ.小数点(マイクロ秒)`
  // e.g. time = 1604027947.123456
  // -> 2020/10/30 12:19:07.123456 (JST)
  element.textContent = String(time)
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: number) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: number) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: number) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

timeChange

• timeChange: object

Data Visualizer のタイムライン上の再生位置をビジュアルパーツから変更します。当イベントは開発中のため、 v3.0.0 時点ではイベントを送信しても反映されません。

coming_soon

Type declaration:

Name	Type	Description
`emit`	(`event`: TimeChange) => void	イベントを送信します

timeChangeWithPageAndRect

• timeChangeWithPageAndRect: object

Data Visualizer のタイムライン上の再生位置を変更します。当イベントは、標準ビジュアルパーツ Line Graph 専用のイベントで、 非推奨 です。

deprecated

Type declaration:

Name	Type	Description
`emit`	(`event`: TimeChangeWithPageAndRect) => void	イベントを送信します

timeChangeWithPagePosition

• timeChangeWithPagePosition: object

Data Visualizer のタイムライン上の再生位置を変更します。当イベントは、標準ビジュアルパーツ Line Graph 専用のイベントで、 非推奨 です。

deprecated

Type declaration:

Name	Type	Description
`emit`	(`event`: TimeChangeWithPagePosition) => void	イベントを送信します

user

• user: object

Data Visualizer でログイン中のユーザーの情報を取得します。ユーザーに紐づくロール文字列データを使用して、ビジュアルパーツの表現を切り替えたい場合に使用します。ロールの定義は、Data Visualizer を提供するインスタンスのサーバー設定によって任意に設定されます。

example

event.user.on((user) => {
  console.log(user.roles) // [{ name: "role", } ...]
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: User) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: User) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: User) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

values

• values: object

このパネルにバインドされている全てのデータの、再生時間範囲内のすべてのデータポイントを取得します。計測データをビジュアルパーツで表現したい場合に使用します。 Value の配列は DataSpecifications で取得する配列の並びと同じです。各計測データについては、 Valueの定義情報を参照してください

example

event.values.on((values) => {
  values.forEach((value) => {
    // do something
  })
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: Value[]) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: Value[]) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: Value[]) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

viewBox

• viewBox: object

Data Visualizer のパネルのサイズをピクセル数で取得します。パネルのサイズに応じてビジュアルパーツの表現を切り替えたい場合に使用します。

example

event.viewBox.on((viewBox) => {
  // w:320px, h:240px
  console.log(viewBox) // { width: 320, height: 240 }
  // do something
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: ViewBox) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: ViewBox) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: ViewBox) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

viewContentFit

• viewContentFit: object

ビジュアルパーツがパネル内に隙間なしの設定で表示されているかどうかを取得します。隙間なしで表示されているかどうかによって処理を切り替えたい場合に使用します。

example

event.viewContentFit.on((contentFit) => {
  if (contentFit.selected) {
    // render fit
  } else {
    // render no fit
  }
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: ViewContentFit) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: ViewContentFit) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: ViewContentFit) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

viewGrid

• viewGrid: object

Data Visualizer のパネルが使用しているマス数を取得します。パネルのマス数に応じて、ビジュアルパーツの表現を切り替えたい場合に使用します。

example

event.viewGrid.on((viewGrid) => {
  // 横2マス、縦1マスを使用
  console.log(viewGrid) // { colSpan: 2, rowSpan: 1 }
  // do something
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: ViewGrid) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: ViewGrid) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: ViewGrid) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

viewTimeline

• viewTimeline: object

ビジュアルパーツがタイムラインとして表示されているかを取得します。タイムライン表示対象のビジュアルパーツは、v3.0.0時点 では固定されているため、基本的にビジュアルパーツの追加開発でこのイベントハンドラを使用することはありません。

example

event.viewTimeline.on((timeline) => {
  console.log(timeline) // { selected: false }
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: ViewTimeline) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: ViewTimeline) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: ViewTimeline) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

viewZoom

• viewZoom: object

Data Visualizer のZoom Scale値を取得します。 Zoom Scale値の情報を取得して、表現を切り替えたい場合に使用します。 Zoom 操作によるパネルの拡大・縮小表示は、Data Visualizer側で実施しているので、基本的には当イベントの処理は不要です。

example

event.viewZoom.on((zoom) => {
  // zoom: 100% -> scale: 1
  console.log(zoom) // { scale: 1 }
})

Type declaration:

Name	Type	Description
`off`	(`listener`: (`event`: ViewZoom) => void) => void	`on`で設定したイベントハンドラを削除します。
`on`	(`listener`: (`event`: ViewZoom) => void) => { `dispose`: () => void }	イベントハンドラとして、変更が発生するたびに実行されるべき処理を設定します。イベントハンドラには変更された値が渡されます。
`once`	(`listener`: (`event`: ViewZoom) => void) => void	イベントハンドラとして、変更が発生したときに一度だけ実行されるべき処理を設定します（処理は一度実行されると破棄されるため、一度しか実行されません）。イベントハンドラには変更された値が渡されます。

Interface: ExposerEvent

Properties​

backgroundDisplay​

Type declaration:​

backgroundDisplayToggle​

Type declaration:​

baseURL​

Type declaration:​

captureCreate​

Type declaration:​

comparationTimeChangeWithPagePosition​

Type declaration:​

currentData​

Type declaration:​

dataSpecification​

Type declaration:​

dataSpecifications​

Type declaration:​

depDatas​

Type declaration:​

error​

Type declaration:​

extension​

Type declaration:​

extensionPatch​

Type declaration:​

fontFamilies​

Type declaration:​

googleMapsOptions​

Type declaration:​

loaded​

Type declaration:​

measurement​

Type declaration:​

measurementCreate​

Type declaration:​

playbackComparationTime​

Type declaration:​

playbackCount​

Type declaration:​

playbackMode​

Type declaration:​

playbackRate​

Type declaration:​

playbackStatus​

Type declaration:​

playbackTimeRange​

Type declaration:​

playbackTimeSelectedRange​

Type declaration:​

playbackTimeSelectedRangeChange​

Type declaration:​

playbackTimeSelectedRangeChangeStartMove​

Type declaration:​

playbackTimeSelectedRangeChangeStartResizeEnd​

Type declaration:​

playbackTimeSelectedRangeChangeStartResizeStart​

Type declaration:​

playbackTimeSelectedRangeChangeStartSelect​

Type declaration:​

playbackTimeSelectedRangeReset​

Type declaration:​

project​

Type declaration:​

renderingProfile​

Type declaration:​

senderEdge​

Type declaration:​

size​

Type declaration:​

time​

Type declaration:​

timeChange​

Type declaration:​

timeChangeWithPageAndRect​

Type declaration:​

timeChangeWithPagePosition​

Type declaration:​

user​

Type declaration:​

Properties

backgroundDisplay

Type declaration:

backgroundDisplayToggle

Type declaration:

baseURL

Type declaration:

captureCreate

Type declaration:

comparationTimeChangeWithPagePosition

Type declaration:

currentData

Type declaration:

dataSpecification

Type declaration:

dataSpecifications

Type declaration:

depDatas

Type declaration:

error

Type declaration:

extension

Type declaration:

extensionPatch

Type declaration:

fontFamilies

Type declaration:

googleMapsOptions

Type declaration:

loaded

Type declaration:

measurement

Type declaration:

measurementCreate

Type declaration:

playbackComparationTime

Type declaration:

playbackCount

Type declaration:

playbackMode

Type declaration:

playbackRate

Type declaration:

playbackStatus

Type declaration:

playbackTimeRange

Type declaration:

playbackTimeSelectedRange

Type declaration:

playbackTimeSelectedRangeChange

Type declaration:

playbackTimeSelectedRangeChangeStartMove

Type declaration:

playbackTimeSelectedRangeChangeStartResizeEnd

Type declaration:

playbackTimeSelectedRangeChangeStartResizeStart

Type declaration:

playbackTimeSelectedRangeChangeStartSelect

Type declaration:

playbackTimeSelectedRangeReset

Type declaration:

project

Type declaration:

renderingProfile

Type declaration:

senderEdge

Type declaration:

size

Type declaration:

time

Type declaration:

timeChange

Type declaration:

timeChangeWithPageAndRect

Type declaration:

timeChangeWithPagePosition

Type declaration:

user

Type declaration:

values