Skip to main content

Type alias: Metadata

Ƭ Metadata: object

ビジュアルパーツのメタデータを定義します。

Type declaration:

NameTypeDescription
defaultExtension?Objectビジュアルパーツ拡張設定(Extension)のデフォルト値(JSON Object)を指定します。 設定した値は、Panel Optionのデフォルト値として表示されます。
getThumbnailURL(baseURL: string) => stringビジュアルパーツのサムネイルURLを返す関数を指定します。 引数 baseURL には、デプロイ時に設定したURLが与えられます。 戻り値は、「baseURL + 画像の相対パス」としてください。
groupNamestringData Visualizer で表示されるビジュアルパーツのグループ名を指定します。 同じグループ名のビジュアルパーツは、ビジュアルパーツ一覧画面に並べて表示されます。
panelOptionConfigPanelOptionConfigビジュアルパーツのPanel Optionを設定します。
panelTagNamestringビジュアルパーツのカスタム要素名(HTMLタグ名)を設定します(例: 'x-sample-01' ) Data Visualizer内で一意である必要があります。
panelViewConfigPartial<PanelViewConfig>パネルでのビジュアルパーツの表示に関する設定です。
partsNamestringData Visualizer で表示されるビジュアルパーツ名を設定します。
partsTypestringビジュアルパーツの内部識別子を設定します(例: '@sample/01' ) 内部識別子はData Visualizer内で一意である必要があります。