JavaScript APIでの詳細設定(スマートライセンス・プラン対象)

各メソッドの解説

スマートライセンス・プランご利用のお客様へ、FONTPLUSのWebフォントをもっと有効に活用していただくため、APIを公開いたします。

メソッド一覧

// リロード
FONTPLUS.reload(init);
// コンプリートイベントハンドラー
FONTPLUS.attachCompleteEvent(callback);
// セレクタ指定
FONTPLUS.targetSelector(selector);
// 非同期モード指定
FONTPLUS.async();
// 非同期モード解除
FONTPLUS.start();
// 非同期ロード(指定ロード)
FONTPLUS.load([fontdata, ...], callback, tagid);
// FONTPLUS処理中チェック
FONTPLUS.isloading();
// フォント指定
FONTPLUS.setFonts([fontfamily, ...])

JavaScript API一覧

機能ごとにサンプルページを用意しています。

※詳しくはサンプルページよりソースをご覧ください。

リロードDemo/リロード (true)Demo

Webフォントを適用した箇所をリロードし、再度適用します(例:更新ボタンでWebフォントを再度適用する)。

FONTPLUS.reload(init)

機能文字抽出、サブセット作成の再実行
引数init
備考

引数に入れる値について

  • true 初期化:取得済みのサブセットを破棄した上でリロードを行います
  • false 非初期化(default):取得済みのサブセットを破棄せず、上書きする形でリロードを行います

コンプリートイベントハンドラーDemo

Webフォントの適用が完了したイベントを取得して、JavaScript等で引き続き処理を記述できます。

FONTPLUS.attachCompleteEvent(callback)

機能コンプリートイベント時に呼出すコールバック関数を登録する
引数callback コールバック関数
備考
  • callback(res)
  • res.code
    • 0 正常
    • 1以上 ロード不可フォント数

セレクタ指定Demo

Webフォントの適用をセレクタ単位で指定することができます(例:Twitterの埋め込みタイムライン内のテキストのみを対象にする)。

FONTPLUS.targetSelector(selector)

機能文字を抽出するセレクタの指定。
引数selector セレクタ
備考

検索順

tagid > tagname > jQuery(load時) > querySelectorAll > original

非同期モード設定Demo

FONTPLUS.async()

機能スクリプト実行をロード時に行わない
備考start()で再開する

非同期モード解除Demo

FONTPLUS.start()

機能文字抽出、サブセット作成の実行
備考reload(true)と同等

非同期ロード(指定ロード)Demo

FONTPLUS.load([fontdata, ...], callback, tagid)

機能指定の文字列を指定のフォントでサブセット作成
引数
  • fontdata {'fontname':フォントファミリ名, 'nickname':別名, 'text':文字列}
  • callback コールバック関数
  • tagid @font-faceが記述されたstyleタグID. 未指定時は0番目の別名
備考IEはstyleタグ最大32個(?)の制限あり

FONTPLUS処理中チェックDemo

FONTPLUS.isloading()

機能FONTPLUS処理中チェック
引数なし
戻値
  • true 処理中
  • false 処理終了
備考

フォント指定Demo

FONTPLUS.setFonts([fontfamily, ...])

機能使用するフォントを指定する
引数fontfamilyフォントファミリ名
備考

フォントを指定することで処理時間の短縮が可能

更にスクリプト指定時にnolist=1を追加するとスクリプトサイズの縮小化

http://webfont.fontplus.jp/accessor/script/fontplus.js?jV3JLd2EFRU%3D&nolist=1

注意事項

一定時間ごとにAPIを実行してフォントデータをダウンロードするページを公開すると、閲覧者がそのページを表示している間PVが消費され続けます。複数人がそのページを開いていると、その人数の倍数でPV数が大量に消費されて、ご契約いただいているPV数が短時間で消費され、気づかないうちになくなってしまう恐れがあります。

例えば、Twitterのタイムラインをページ表示するWebアプリでWebフォントを利用することを想定します。
3秒ごとにタイムラインを更新するタイミングでFONTPLUSのAPIをコールし、Webフォントを取得する処理を行います。
すると、1人がそのページにアクセスし、1時間開いたままですと3,600秒÷3秒=1,200PV消費されます。
このページを1,000人が1時間開いたままになると1,200PV×1,000人=1,200,000PVとなり、スマートライセンス・プランの120万PVライセンスが1時間で消費されることになります。
このような利用を想定される場合は、あらかじめ多くのスマートライセンス・プランのPVチケットをご購入いただくか、エンタープライズ・プランをご検討ください。