ユースケース開発概要Visualization widgetsMarkdown

注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

Markdown

Markdown ウィジェットは、Markdown 形式のテキストをレンダリングする機能をサポートしています。さらに高度な機能を利用すると、Markdown テキストでオントロジーオブジェクトを参照したり、クリックイベントをサポートしたりすることができます。Markdown ウィジェットの設定を行うモジュールビルダーは、以下の機能を使用できます:

  • ボールド、イタリック、取り消し線、ハイライトなどの基本的な Markdown テキストの書式設定
  • ヘッダー、テーブル、ブロックスタイル、コードスタイル、URL など、より高度な Markdown 書式設定
  • 特定のハイライトされたアンカーテキストからオントロジーオブジェクトへの埋め込み参照
  • 特定のハイライトされたアンカーテキストからの Workshop のクリックイベントのトリガー

以下のスクリーンショットは、オブジェクト参照が含まれている設定済みの Markdown ウィジェットの例を示しています。ここでは、オントロジーオブジェクト参照が添付されているテキストアンカーが下線付きで表示され、選択可能であることが示されています:

markdown_object_references_simple_example

設定オプション

以下のスクリーンショットは、未設定の Markdown ウィジェットとその初期設定パネルの初期状態を示しています。

markdown_empty_state

Markdown ウィジェットにおける主要な設定オプションは以下のとおりです:

  • 入力データ:テキスト / 変数
    • テキスト: テキストオプションが選択された場合、ビルダーは設定パネルに直接入力したい Markdown テキストを入力できます。
    • 変数: 変数オプションが選択された場合、表示する入力 Markdown テキストとして文字列変数を選択できます。
  • 表示オプション:標準 Markdown/オブジェクト参照
    • 標準 Markdown: このオプションはデフォルトで有効になっており、入力を標準の Markdown 形式で表示します。
    • オブジェクト参照: 有効にすると、テキストにオントロジーオブジェクトへの参照と Workshop のクリックイベントのトリガーを埋め込むことができます。これは Markdown 構文のカスタム拡張であり、この高度な機能についての詳細は以下のドキュメンテーションを参照してください。

Markdown ウィジェット内のオブジェクト参照

高度な機能として、Markdown ウィジェットでは、ビルダーが Markdown テキストの一部("アンカー")にタグを付け、これらのアンカーを使用して特定のオントロジーオブジェクトにリンクしたり、Workshop のクリックイベントをトリガーしたりすることができます。

これらのアンカーを作成するための形式は以下の通りです:

:objectreference[$text_to_display]{objectType="$object_type_id" primaryKey="$object_primary_key"}  // :objectreference[$text_to_display]は表示するテキスト、objectType="$object_type_id"はオブジェクトのタイプを指定し、primaryKey="$object_primary_key"はオブジェクトの主キーを指定します

例として、2つのフライトアラートオブジェクトを文中で参照しようとしている場合を見てみましょう。まず、ユーザーに表示される画面での望ましい最終状態を確認しましょう。注:以下の各フライトアラートオブジェクトは、ユーザーが個別に選択可能で、それが Markdown ウィジェットの選択されたオブジェクトセットの出力になります。

markdown_object_references_config

上記を実現するために、背後にある Markdown 入力は以下の通りです。

ニューアーク空港は5月に__*まれに*__フライトの問題が発生していますが、高優先度の遅延が2件ありました::objectreference[Alert A00150]{objectType="flight-alert" primaryKey="A00150"}および:objectreference[Alert A00182]{objectType="flight-alert" primaryKey="A00182"}

上記で説明した Markdown 入力の構文に加えて、ビルダーはオブジェクト参照に対して以下のオプションを設定できます。

  • 選択されたオブジェクトセット: オブジェクト参照の使用に必要です。これは、Markdown ウィジェットの出力オブジェクトセットです。ユーザーが Markdown ウィジェット内のオブジェクト参照を選択すると、そのオブジェクトがこのオブジェクトセット変数に出力されます。
  • オブジェクトタイプ: オブジェクト参照の使用に必要です。ビルダーは、Markdown ウィジェット内で参照されるすべてのオブジェクトタイプを選択する必要があります。オブジェクトタイプが追加されると、ビルダーは内部の設定パネルで追加の条件付き書式設定ルールを設定できます。Markdown ウィジェクトでオブジェクトタイプが参照されている場合でも、このリストで設定されていない場合は、オブジェクト参照が Markdown ウィジェットに表示されません。
    • オブジェクトタイプ: 色とイベントオプションをさらに設定するオブジェクトタイプを指定します。
    • ハイライトカラー: 静的な色を選択するか、オントロジー書式設定を持つプロパティから色を継承するか、カスタムルールを定義して色を決定します。
    • 選択時のイベントを上書き: 指定されたオブジェクトタイプに対してトリガーする Workshop イベントを設定します。これは、選択時の他のイベントを上書きします。
  • 選択動作: Markdown ウィジェット内の選択動作を制御します。
    • ハイライトなし を選択すると、Markdown ウィジェット内のオブジェクト参照を選択しても選択状態になりません。
    • 最後に選択されたハイライト を選択すると、Markdown ウィジェット内のオブジェクト参照を選択すると、最も最近選択されたアンカーテキストがハイライトされます。
    • 選択された参照をハイライト を選択すると、Markdown ウィジェット内のハイライトは、選択されたオブジェクトセットの内容に基づいています。このオプションは、Markdown のオブジェクト参照が別のウィジェットからのオブジェクトと1:1であり、両方のウィジェットの選択されたオブジェクトセットが同じ場合に最適です。
  • 選択時のイベント: このオプションでは、モジュールビルダーは、Markdown ウィジェットでオブジェクト参照が選択されたときにトリガーする Workshop イベントを設定できます(例えば、より詳細なオブジェクトビューが表示されるドロワーを引き起こす)。

Markdown のオブジェクト参照には、標準の Markdown 書式設定も適用できます。以下のスクリーンショットには、見出しやオブジェクトが埋め込まれたテーブルなど、Markdown 書式設定のさまざまな例が含まれています。

markdown_additional_formatting