このトピックでは、ウィジェットの登録、デバッグ、公開、および削除の方法について説明します。
背景情報
Quick BI カスタム ウィジェットには、実行ステータスと表示ステータスの 2 つのディメンションのステータスがあります。
実行ステータス
実行ステータスは、ウィジェットの作成から破棄までの一連のステータスを表し、ウィジェットの開発パターンによって異なります。 カスタム ウィジェット管理プラットフォームでウィジェットの実行ステータスを維持できます。パスは、オープンプラットフォーム > カスタム ウィジェット です。
オンライン編集
公開待ち - ウィジェットが新しく登録されたとき、または公開済みだが情報が変更され、まだオンラインに同期されていないときのステータスです。
公開済み - ウィジェットがオンラインで実行されているときのステータスです。
プロフェッショナルモード
開発中 - ウィジェットが新しく登録されたが、デプロイメント パッケージがアップロードされていないときのステータスです。
公開待ち - デプロイメント パッケージがアップロードされたとき、またはウィジェットが公開済みだが情報が調整され、まだオンラインに同期されていないときのステータスです。
公開済み - ウィジェットがオンラインで実行されているときのステータスです。
カスタム ウィジェット管理プラットフォームでウィジェットの実行ステータスを維持できます。
ウィジェットの編集
ウィジェット管理リストで、
アイコンをクリックします。
[ウィジェットの変更] ページで、インターフェイス パラメーターを変更します。
オンライン編集
ウィジェット名、アイコン、その他のパラメーターを変更できます。 詳細については、「インターフェイス パラメーターの説明」をご参照ください。
プロフェッショナルモード
この例では、デプロイメント パッケージのアップロードについて紹介します。
その他のインターフェイス パラメーターの詳細については、「インターフェイス パラメーターの説明」をご参照ください。
[確認] をクリックします。
変更が完了すると、ウィジェットは [公開待ち] ステータスになります。プロフェッショナルモードでは、開発者はシード プロジェクトで npm run pack
を実行することで、ウィジェット パッケージをエクスポートできます。
ウィジェットのデバッグ
以下の図の手順に従って、ウィジェットをデバッグできます。
オンライン編集 では、ウィジェットのデバッグ環境は 3 つあります。
オンライン開発環境 - ウィジェットのソースコードをオンラインで編集でき、その他の構成は公開待ちパッケージ構成を使用します。
公開待ち環境 - ウィジェット リソースは公開待ちパッケージから読み取られ、その他の構成は公開待ち構成を使用します。
オンライン環境 - ウィジェット リソースは公開済みパッケージから読み取られ、その他の構成は公開済み構成を使用します。
プロフェッショナルモード では、ウィジェットのデバッグモードは 3 つあります。
ローカル デバッグ: ウィジェット リソースはローカル サービスから取得されます。これは、ウィジェットの登録後のローカル開発に適しています。
公開待ちパッケージ デバッグ: ウィジェット リソースは公開待ちパッケージから取得されます。これは、公開前のプレビューに適しています。
公開済みパッケージ デバッグ: ウィジェット リソースはオンラインで取得されます。これは、非表示のウィジェットをオンラインで表示する場合に適しています。
ローカル デバッグでは、ウィジェットのローカル サービスが開始されていることを確認してください。
デバッグモードでは、ダッシュボードのカスタム ウィジェットがメニューバーに表示されます。つまり、ウィジェットの表示ステータスは無効です。
デバッグモードでは、ダッシュボードは保存できますが、公開できません。
ウィジェット デバッグ ダイアログ ボックスで、デバッグ範囲、ワークスペース、および対応するダッシュボードを選択してデバッグします。 デバッグに移動 をクリックして、対応するダッシュボード ページに移動します。 詳細については、「ウィジェットのデバッグ」をご参照ください。
ウィジェットの表示/非表示
表示ステータスは、カスタム ウィジェットがダッシュボードに表示されるかどうかを示します。2 つのステータスがあります。
非表示: [非表示] をクリックすると、カスタム ウィジェットはダッシュボード編集ページの [チャートの追加]->[カスタム] に表示されなくなり、チャートに切り替えることができなくなります。ただし、以前に保存したチャートは引き続き表示できます。
表示: [表示] をクリックすると、カスタム ウィジェットはダッシュボード編集ページの [チャートの追加]->[カスタム] に表示され、チャートの切り替えがサポートされます。
ダッシュボードでは、これによりウィジェット エントリが表示されるか非表示になるかが決まります。
ウィジェットの表示ステータスを変更しても、ウィジェットが [公開待ち] ステータスになることはありません。代わりに、変更はオンラインで直接有効になります。
ステータスが [開発中] の場合、ウィジェットは常に表示されます。
ウィジェットの公開
オンライン編集
ウィジェット管理リストで、[公開待ち] ステータスのウィジェットを見つけます。 [公開] アイコンをクリックして、ウィジェットを公開します。
ポップアップ表示される [ウィジェットの公開] ダイアログ ボックスで、変更が正しいことを確認します (変更されたプロパティは赤でマークされます)。 [公開の確認] をクリックします。
ウィジェットは [公開済み] ステータスになります。
[コード比較の表示] をクリックすると、具体的なコードの変更内容を表示できます。
プロフェッショナルモード
ウィジェットを公開する前に、デプロイメント パッケージがアップロードされていることを確認してください。
ウィジェット管理リストで、[公開待ち] ステータスのウィジェットを見つけます。 [公開] アイコンをクリックして、ウィジェットを公開します。
ポップアップ表示される [ウィジェットの公開] ダイアログ ボックスで、変更が正しいことを確認します (変更されたプロパティは赤でマークされます)。 [公開の確認] をクリックします。
ウィジェットは [公開済み] ステータスになります。
ウィジェットの削除
ウィジェット管理リストで、対象のウィジェットを見つけ、[削除] アイコンをクリックしてウィジェットを削除します。
ウィジェットを削除すると、次の影響が発生します。
カスタム ウィジェットに基づいて新しいチャートを作成できなくなります。
以前に保存したカスタム ウィジェットのチャートには、ウィジェットが表示されなくなります。代わりに、ウィジェットの元の場所に [チャート メタデータが異常か、削除されています] というプロンプトが表示されます。