APL早見表(Cheat Sheet)


APL早見表(Cheat Sheet)

Alexa Presentation Language(APL)早見表を活用して、APL開発の生産性を向上させましょう。APL早見表は、APLドキュメントとそのコンポーネント、コマンド、プロパティの構文とセマンティクスに関する情報を、簡潔でわかりやすい形式で提供するクイックリファレンスガイドです。

前提条件

APLでの開発中にAPL早見表を使用するには、APLドキュメントの基本概念と構造を理解しておく必要があります。APLを初めて使用する場合は、このAPLドキュメントの「開発を始める」セクションのスキルに視覚要素とオーディオを追加するから始めてください。

APL 2024.1の早見表をダウンロードする

早見表を使用するには、まず早見表をダウンロードします。APL早見表は印刷可能なPDFドキュメントとして提供されます。印刷して手元で参照することも、コンピューターでPDFとして使用することもできます。印刷しておくと、画面やウィンドウを切り替えることなく、開発中に情報を簡単に調べることができます。

APL早見表をダウンロード、表示、印刷するには

  • 次の画像をクリックします。
APL早見表をダウンロードする

APL早見表バージョン2024.1、最終更新日2024年3月21日。

APL早見表の使用方法

APL早見表を最大限に活用できるように、その構造、形式、記号について以下に説明します。

構造

APL早見表PDFドキュメントは4ページあります。各ページの上部には、記載されている情報を示すタイトルが付いています。

  • ページ1: ドキュメントとデータコンテキスト - APLドキュメントとその初期データコンテキスト、リソース、スタイル、コマンド、レイアウト定義、環境変数、Viewport変数に関する特に重要な情報を提供するとともに、ドキュメント内のAPLコンポーネントやコマンドから使用できる関数とデータ型を示します。
  • ページ2: コンポーネント - APLコンポーネントと、そのプロパティおよびイベントハンドラーに関する情報が含まれます。
  • ページ3: コンポーネントとAVG - 2ページ目に続き、APLコンポーネントに関する情報が含まれます。さらに、APLドキュメントでAlexa Vector Graphics(AVG)を定義する方法の詳細も提供します。
  • ページ4: コマンド - APLコマンドとそのプロパティ、イベントオブジェクト、コンポーネントセレクター構文に関する情報を提供します。

セクションとその番号

すべてのページはセクションに分かれています。各セクションは、個々のAPLの概念、つまりコンポーネントやコマンドなどのAPL要素を表しています。セクションタイトルが中かっこ({})で囲まれている場合、その要素はAPLドキュメント内のJSONオブジェクトであることを示しています。たとえば、次の画像は3ページのセクションC.16を示し、APLのVectorGraphicコンポーネントのプロパティが一覧表示されています。

APL早見表3ページ、セクションC.16

早見表では、各セクションは文字と1つ以上の数字で識別されます。たとえば、VectorGraphicコンポーネントに関する情報を含むセクションの識別子はC.16です。これらの識別子は、早見表で各セクションの相互参照に使用されます。たとえば、セクションC.16では、VectorGraphicコンポーネントのonLoadイベントプロパティをAPLコマンドオブジェクトの配列として定義していますが、その詳細はセクションE.1で説明されています。さらに、このコンポーネントにはタッチ可能なコンポーネントであるという特徴もあります。これについては、セクションC.3で詳しく説明されています。

プロパティの定義

APL早見表の主な目的は、APLコンポーネントとコマンドのJSONベースのスキーマを説明して、スキーマに準拠した機能的なAPL JSONドキュメントの作成を支援することです。APLドキュメントの各要素には、名前と値が割り当てられた明確に定義された一連のプロパティがあります。APL早見表では、通常の値プロパティとイベントプロパティを別々に表示し、背景色を変えて区別しています。イベントプロパティは、イベントハンドラーとも呼ばれ、コンポーネントのプロパティ定義テーブルの下部に明るい青色の背景色で表示されます。たとえば、VectorGraphicコンポーネントには、onFailonLoadという2つの固有のイベントハンドラーが用意されています。

コンポーネントのプロパティ定義では、一貫して同じ記号、形式、構文を使用して、その値と動作の詳細を記述しています。次の行は、定義のパターンを示しています。

{ ◻︎ | ◼︎ | ▲ | △ | ► | ▷ } プロパティ名 [ : 値の型 ] [ = 値 | 値セット ]

記号

定義は常に、プロパティの特定の関連アトリビュートを示す記号{ ◻︎ | ◼︎ | ▲ | △ | ► | ▷ }で始まります。早見表の各ページの上部には、各記号の意味を説明する凡例があります。

値プロパティには、次の記号が適用されます。

  • ◼(塗りつぶされた正方形)- プロパティは動的です。動的プロパティは、動的値式を使用して割り当てることができます。また、SetValueコマンドを使用して再割り当てすることもできます。
  • △(白抜きの三角形)- プロパティはスタイル設定可能です。スタイル設定可能プロパティは、APLスタイル定義に追加できます。したがって、その値はコンポーネントの状態に応じて変化する可能性があります。スタイル設定可能プロパティの詳細については、APLスタイル設定可能プロパティを参照してください。
  • ▲(塗りつぶされた三角形)- プロパティは動的かつスタイル設定可能です。
  • ◻(白抜きの正方形)- プロパティはスタイル設定可能でも動的でもありません。つまり、プロパティは静的です。割り当てられた値は、APLドキュメントがインフレートされるときに1回だけ評価されます。

イベントプロパティはイベントハンドラーとも呼ばれ、次の記号が適用されます。

  • ►(塗りつぶされた三角形の再生記号)- イベントハンドラー内で、APLコマンドがデフォルトで通常モードで実行されることを示します。通常モードの詳細については、「APLコマンド」の通常モードを参照してください。
  • ▷(白抜きの三角形の再生記号)- イベントハンドラー内で、APLコマンドがデフォルトで高速モードで実行されることを示します。高速モードの詳細については、「APLコマンド」の高速モードを参照してください。

プロパティ名

シンボルの後にはプロパティの名前が続きます。プロパティ名に下線が付いている場合は、値を割り当てる必要があります。

値の型

プロパティがStringArrayなどの特定の型の値を想定している場合、その型がプロパティ名の後に表示されます。

値または値セット

一部のプロパティは、単一の値または指定された値セットからの値を受け入れます。このような場合、プロパティ定義には、選択できる値または値セットの一覧が表示されます。複数の値から選択できる場合は、通常、独自の値が割り当てられていないときに自動的に適用されるデフォルト値があります。値セットのデフォルト値には下線が引かれています。

次の一覧は、後の画像に示す3ページ目のセクションC.16にある、VectorGraphicコンポーネントのプロパティ定義の例を示しています。

  • このtypeプロパティは必須プロパティであり、常に「VectorGraphic」という文字列に設定する必要があります。白抜きの正方形の記号(◻)は、このプロパティが静的であることを示しています。つまり、動的でもスタイル設定可能でもありません。
  • 塗りつぶされた正方形(◼)で示されているように、sourceプロパティは動的ですが、スタイル設定可能ではありません。その値には文字列またはURL文字列が想定されています。デフォルト値はありません。
  • scaleプロパティの塗りつぶされた三角形(▲)の記号は、scaleプロパティが動的でスタイル設定可能であることを示しています。その値は、「none」、「fill」、「best-fill」、「best-fit」のいずれかの文字列であることが想定されています。未設定の場合、このプロパティのデフォルト値は「none」に設定されます。
  • onLoadイベントプロパティは、APLコマンドオブジェクトの配列を受け取ります。これらについては、セクションE.1に詳しく説明されています。このイベントハンドラー内では、APLコマンドは常に高速モードで実行されます。高速モードは白抜きの三角形の再生記号(▷)で示されます。
APL早見表3ページ、セクションC.16

APL早見表のプロパティ定義を参照すれば、APLドキュメントの詳細を覚えたり調べたりしなくても、スキーマに準拠したVectorGraphicコンポーネントをAPLドキュメントに追加できます。次のコード例は、スキーマ準拠のVectorGraphicコンポーネントを示しています。

{
    "type": "VectorGraphic",
    "scale": "best-fit",
    "align": "left",
    "source": "https://my.server/my-avg-graphic-source.json",
    "onFail": [
        {
            "type": "SetValue",
            "property": "source",
            "value": "https://my.server/my-avg-graphic-fallback.json"
        }
    ]
}


このページは役に立ちましたか?

最終更新日: 2025 年 12 月 02 日