YahooUserInterfaceのAPIの見方が分かってきた その2

JavaScript

YahooUserInterfaceのAPIの見方について

YahooUserInterfaceのAPIの見方が分かってきたの続き。こっちもYahoo.widget.CalendarのAPIを例にとってみる。サイドバーの部分でだいぶ詳しく説明したから、こっちはあっさりと説明する。

メイン部分の構成について

  • 最初に
  • Constructor
  • Properties
  • Methods
  • Events
  • Configuration Attributes

サイドバーの部分でだいぶ説明したので、「最初に」の部分と「Constructor」の部分だけ説明する。サイドバーの部分で説明したようにProperties,Methods,Events,Configuration Attributesの部分にはスーパークラスから継承した項目が含まれてる。下の図のように各項目の一番下に青く囲ってある部分があるはず。ちなみにYahoo.widget.Calendarにはスーパークラスが無いので、この青く囲ってある部分は無い。

「最初に」

「最初に」っていう項目はないんだけど、メイン部分の一番上の部分の説明。まず最初にこのクラスの名前、スーパークラス、サブクラスについて書いてある。それに加えてこのクラスの簡単な説明が入ってる。

「Constructor」

このクラスを作るためのコンストラクタについての説明。今回のCalenderクラスは次のように定義されている。

YAHOO.widget.Calendar ( id , container , config )


各引数についての説明は省くけど、このクラスをインスタンス化する場合、次のようにすれば良いことが分かる。

cal = new YAHOO.widget.Calendar ( id , container , config );

あとがき 注意点

一応一通りAPIの見方を説明した。注意して欲しいのは、全てのYahooUserInterfaceのAPIドキュメントがこのルールに基づいて同じように書かれてないという点。微妙に統一されてない点がいくつかあった。これはAPIドキュメントだけの話じゃなくて、プログラム内についても同じ。これほど大規模なライブラリなので、作ってる人が違うんだろう。