--- title: "JavaScript API v3" canonical: "https://wiki.yellowfin.co.jp/space/yfcurrent/1905938/JavaScript%20API%20v3" format: markdown --- > Macro (anchor) > Macro (toc) ## Yellowfin JavaScript APIについて Yellowfin JavaScript APIは、以下の目的のために使用されます。 1. Yellowfin内から、ダッシュボードコードモードにカスタムロジックを作成するため (これは、Yellowfin内でのユーザーエクスペリエンスをカスタマイズしたり、ダッシュボードにアプリケーションロジックを組み込むことができます)。 2. Yellowfin コンテンツを他のweb アプリケーションに組み込み、そのコンテンツを操作するため。この方法で組み込むことができるYellowfin コンテンツには、レポート（表、グラフ、キャンバス）と、ダッシュボード全体（キャンバスおよび既存のグリッドスタイルの両方）が含まれます。 APIは、コンテンツの組み込みに、2つの広範な方法をサポートしています。 - **リンクの埋め込み：**Yellowfin アプリケーションから埋め込みリンクを取得し、レポート、グラフ、ダッシュボードを既存のアプリケーションに組み込むために使用します。組み込んだコンテンツの外観や動作をさらに制御するために、リンクに様々なパラメーターを追加できます。 - **高度なAPI：**高度なAPIを使用することで、組み込んだコンテンツをより動的かつ柔軟に制御できます。API関数の豊富なセットは、組み込んだコンテンツの多数の要素を、プログラムにより制御することができます。 > ⚠️ このAPIのバージョン3は、Yellowfin バージョン9で最初にリリースされ、既存のバージョン2 APIを置き換えます。特にアナウンスをするまで、バージョン2 APIは引き続きサポートされますが、機能強化されることはありません。この既存のAPIについての情報は、[こちら](#JavaScriptAPIv3-JavaScriptAPI)を参照してください。 ## 本ガイドについて 本ガイドは、次の広範な項目に分かれています。 - [JS API コンポーネントがどのように設定されているかについての概要](https://yellowfinjp.atlassian.net/wiki/spaces/yfcurrent/pages/1904107)。 - [ダッシュボードコードモードでのJS APIの使用](https://yellowfinjp.atlassian.net/wiki/spaces/yfcurrent/pages/1906698)。 - [JS APIを使用したYellowfin コンテンツの組み込み](https://yellowfinjp.atlassian.net/wiki/spaces/yfcurrent/pages/1906054)。こちらの項目では、JS APIを使用するために必要な基本的な前提条件を説明し、埋め込みリンク、および高度なAPIを使用してコンテンツを組み込むための詳細な情報を提供します。 - 各サブAPIのための詳細なAPIリファレンスには、次の項目が含まれます。 - [Base API - 高度なAPI](https://yellowfinjp.atlassian.net/wiki/spaces/yfcurrent/pages/1905363) - [ダッシュボード API](https://yellowfinjp.atlassian.net/wiki/spaces/yfcurrent/pages/1903715) - [サブタブ API](https://yellowfinjp.atlassian.net/wiki/spaces/yfcurrent/pages/1906874) - [レポート API](https://yellowfinjp.atlassian.net/wiki/spaces/yfcurrent/pages/1903830) - [フィルター API](https://yellowfinjp.atlassian.net/wiki/spaces/yfcurrent/pages/1904368) - [LoaderEvents API](https://yellowfinjp.atlassian.net/wiki/spaces/yfcurrent/pages/1905146) - [ウィジェット API](https://yellowfinjp.atlassian.net/wiki/spaces/yfcurrent/pages/1902268) 各APIリファレンスは、以下を含みます。 - APIの目的の概要と説明 - （該当する場合は）任意のプロパティ - 関数リファレンス（説明、パラメーター、リターン、コードスニペット） - イベントリファレンス - 制限 - 対象の機能をコードモード、組み込みモード、または両方のモードで使用できるか、など ## 前提条件 ### CORSの有効化 Yellowfin JavaScript APIは、**オリジン間リソース共有（Cross Origin Resource Sharing: CORS）**に依存します。デフォルトでは、Yellowfin サーバに対して作成されたすべてのCORSリクエストは却下されます。そのため、まず最初にしなくてはいけないことは、JS APIを使用するサーバからのCORSリクエストを有効化することです。 これは、Yellowfinの管理コンソールに移動し、**許可するオリジン**項目にサーバURLを追加することで実現できます。**管理 **＞ **システム構成 **＞ **システム **＞ **一般設定**に移動します。 URLはひとつ以上入力することができます。 ![image](media://e9d31706-8ec1-4593-878f-32ec8345be67) Yellowfin サーバ上でこれを有効化したら、コンテンツを組み込むことができます。 ### Yellowfin コンテンツの作成 まずは、組み込むコンテンツが、Yellowfin内に存在していなくてはいけません。データソース接続、ビュー、レポート、グラフ、ダッシュボードなど、Yellowfin コンテンツの作成に関連する様々な技術は、すべて本wiki内で詳しく紹介しています。