ChartExpert API リファレンス

このエントリーをはてなブックマークに追加

English here.

ChartExpertの使い方

使い方は簡単、URIにchart:///show を指定してコマンド文字列をIntentで送信するだけです。

Intent intent = new Intent(
    Intent.ACTION_VIEW,
    Uri.parse("chart:///show"));
intent.putExtra(
    "content",
    "_client=ChartExpert Demo\n" +
    "_version=1\n" +
    "sample.y=20,22,25,30,28\n" +
    "sample.x=0,1,2,5,6\n" +
    "chart.type=line\n" +
    "chart.dataset=sample\n" +
    "chart.title=Sample Chart"
    );
startActivity(intent);

リターンコードを取得するには (ver.1.1以降)

startActivityForResult()を使用してリターンコードを取得することができます。

使用例

private static final int CHARTEXPERT_REQUEST_CODE = 0;
private static final int CHARTEXPERT_RESULT_SUCCESS = Activity.RESULT_OK;
private static final int CHARTEXPERT_RESULT_CANCELED = Activity.RESULT_CANCELED;
private static final int CHARTEXPERT_RESULT_OLDER_CLIENT = Activity.RESULT_FIRST_USER + 0;
private static final int CHARTEXPERT_RESULT_NEWER_CLIENT = Activity.RESULT_FIRST_USER + 1;
private static final int CHARTEXPERT_RESULT_SYNTAX_ERROR = Activity.RESULT_FIRST_USER + 4;

private void startChartExpert() {
    Intent intent = new Intent(
        Intent.ACTION_VIEW,
        Uri.parse("chart:///show"));
    intent.putExtra("content", コマンド文字列);
    startActivityForResult(intent, CHARTEXPERT_REQUEST_CODE);
}
public void onActivityResult(int requestCode, int resultCode, Intent data) {
    if ( requestCode == CHARTEXPERT_REQUEST_CODE ) {
        String msg;
        switch ( resultCode ) {
        case CHARTEXPERT_RESULT_SUCCESS :
            msg = "RESULT_SUCCESS";
            break;
        case CHARTEXPERT_RESULT_CANCELED :
            msg = "RESULT_CANCELED";
            break;
        case CHARTEXPERT_RESULT_OLDER_CLIENT :
            msg = "RESULT_OLDER_CLIENT";
            break;
        case CHARTEXPERT_RESULT_NEWER_CLIENT :
            msg = "RESULT_NEWER_CLIENT";
            break;
        case CHARTEXPERT_RESULT_SYNTAX_ERROR :
            msg = "RESULT_SYNTAX_ERROR";
            break;
        default :
            msg = "Unknown result code.";
        }
        Toast.makeText(this, msg, Toast.LENGTH_LONG).show();
    }
}

CHARTEXPERT_RESULT_SUCCESS (= Activity.RESULT_OK = -1)

ChartExpertは常にBackボタンで元のActivityに戻るため、この値は返りません。将来の使用のために予約されています。

CHARTEXPERT_RESULT_CANCELED (= Activity.RESULT_CANCELED = 0)

ChartExpertは常にBackボタンで元のActivityに戻るため、成功するとこの値が返ります。

CHARTEXPERT_RESULT_OLDER_CLIENT (= Activity.RESULT_FIRST_USER + 0 = 1)

_versionで指定した値が、ChartExpertの対応する最小値よりも小さい場合にこの値が返ります。

CHARTEXPERT_RESULT_NEWER_CLIENT (= Activity.RESULT_FIRST_USER + 1 = 2)

_versionで指定した値が、ChartExpertの対応する最大値よりも大きい場合にこの値が返ります。

CHARTEXPERT_RESULT_SYNTAX_ERROR (= Activity.RESULT_FIRST_USER + 4 = 5)

コマンド文字列にエラーがある場合にこの値が返ります。

コマンドリファレンス

文法

以下のコマンドを、1行に1つずつ、改行文字を区切りとして指定します。
指定順は任意です。

  • _client=<NAME>
  • _version=<VERSION>
  • <CKEY>.title=<TITLE>
  • <CKEY>.type=<TYPE>
  • <CKEY>.dataset=<DKEY1>[,<DKEY2>[...]]
  • <CKEY>.colortheme=<COLORTHEME>
  • <CKEY>.position=<POSITION>
  • <DKEY>.y=<Y>
  • <DKEY>.x=<X>
  • <DKEY>.label=<LABEL>
  • <DKEY>.ylabel=<YLABEL>
  • <DKEY>.xlabel=<XLABEL>
  • <DKEY>.yaxis=<YMIN>,<YMAX>[,<YSTEP>]
  • <DKEY>.xaxis=<XMIN>,<XMAX>[,<XSTEP>]
  • <DKEY>.color=<COLOR>

用語

CKEY : チャートキー

グラフを識別するためのキーです。グラフの設定コマンドの前につけて使います。使用前の宣言などは不要です。
CKEYとDKEYに同じ名前を使用しても構いません。別の名前として区別されます。

DKEY : データセットキー

データセットを識別するためのキーです。データセットの設定コマンドの前につけて使います。使用前の宣言などは不要です。
CKEYとDKEYに同じ名前を使用しても構いません。別の名前として区別されます。

リファレンス

_client=<NAME> : クライアント名の指定

グラフ表示を依頼するアプ リケーションの名前を指定します。
省略できません。
1つだけ指定が可能です。

例:

_client=からログ

_version=<VERSION> : APIバージョンの指定

データセットのChart Expert API バージョンを指定します。現在は1と2が指定可能です。
省略できません。
1つだけ指定が可能です。

例:

_version=1

<CKEY>.title=<TITLE> : グラフタイトルの指定

グラフのタイトルを指定します。
省略した場合は、タイトルなしとみなします。
CKEYごとに、1つまで指定できます。

例:

体重.title=体重

<CKEY>.type=<TYPE> : グラフ種類の指定

<TYPE> には、line, vbar, scatter, pie のいずれかを指定してください。
省略できません。
CKEYごとに、1つまで指定できます。

例:

体重.type=line

<CKEY>.dataset=<DKEY1>[,<DKEY2>[,...]]: データセットの指定

グラフのデータセットを指定します。
<DKEYn>には、定義されたデータセットのキーを指定してください。カンマで区切って複数指定して、複合グラフをつくることもできます。
ただし、グラフ種類がpieの場合は複合グラフにはできません。複合グラフの場合のx,xlabelは<DKEY1>のものが使われます。
省略できません。
CKEYごとに、1つまで指定できます。

例:

体重.dataset=line:体重

<CKEY>.colortheme=<COLORTHEME> : グラフの配色テーマの指定

グラフの配色テーマを指定します。
<COLORTHEME>には、morning, daytime, evening, nightを指定可能です。ver.1.1以降ではさらに spring, summer, fall, winter も指定可能です。
省略すると daytime が指定されたものとみなします。
CKEYごとに、1つまで指定できます。

例:

体重.colortheme=daytime

<CKEY>.position=<POSIITON>: 初期位置の指定

グラフの初期位置を指定します。
<POSITION>には, first, lastのいずれかを指定可能です。firstはグラフの先頭、lastはグラフの最後尾にそれぞれ初期位置を設定します。
省略すると firstが指定されたものとみなします。
CKEYごとに、1つまで指定できます。

例:

体重.position=last

<DKEY>.y=<Y> : yデータの指定

yデータを、カンマ区切りの実数値で指定します。カンマの間に数値を置かない場合は「数値なし」として扱われます。
yデータは、通常はy座標として使われますが、グラフの種類によって意味は変わります。
すべてのグラフ種類で指定必須です。
DKEYごとに、1つまで指定できます。

例:

体重.y=62.5,63.1,62.7,,62.3

<DKEY>.x=<X> : xデータの指定

xデータを、カンマ区切りの実数値で指定します。カンマの間に数値を置かない場合は「数値なし」として扱われます。
xデータは、通常x座標として使われますが、グラフの種類によって意味は変わります。
省略すると、0, 1, 2, 3, …, (yデータ数 – 1)が指定されたものとみなします。
DKEYごとに、1つまで指定できます。

例:

体重.x=0,1,2,3,4

<DKEY>.label=<LABEL> : データラベルの指定

データに添えられるラベルを、カンマ区切りの文字列で指定します。カンマの間に文字列を置かない場合は「ラベルなし」として扱われます。
省略した場合は、すべて「ラベルなし」を指定されたものとみなします。
DKEYごとに、1つまで指定できます。

例:

体重.label=62.5,63.1,62.7,,62.3

<DKEY>.ylabel=<YLABEL> : yラベルの指定

y軸に等間隔で添えられるyラベルを、カンマ区切りの文字列で指定します。カンマの間に文字列を置かない場合は「ラベルなし」として扱われます。
省 略した場合は、すべて「ラベルなし」を指定されたものとみなします。
DKEYごとに、1つまで指定できます。

例:

アンケート.ylabel=悪い,やや悪い,普通,やや良い,良い

<DKEY>.xlabel=<XLABEL> : xラベルの指定

x 軸に等間隔で添えられるxラベルを、カンマ区切りの文字列で指定します。カンマの間に文字列を置かない場合は「ラベルなし」として扱われます。
省 略した場合は、すべて「ラベルなし」を指定されたものとみなします。
DKEYごとに、1つまで指定できます。

例:

体重.xlabel=Jul/15,16,17,18,19

<DKEY>.yaxis=<YMIN>,<YMAX>[,<YSTEP>] : y軸の範囲および目盛り間隔の指定

y 軸の最小値、最大値、目盛り間隔を、実数値で指定します。
省 略した場合は、yデータの値域から自動的に決定されます。
DKEYごとに、1つまで指定できます。

例:

体重.yaxis=0,10,0.5

<DKEY>.xaxis=<XMIN>,<XMAX>[,<XSTEP>] : x軸の範囲および目盛り間隔の指定

x 軸の最小値、最大値、目盛り間隔を、実数値で指定します。
省略した場合は、0,(yデータの個数-1),1が指定されたものと見なします。
DKEYごとに、1つまで指定できます。

例:

体重.xaxis=1,7,1

<DKEY>.color=<COLOR> : グラフの色指定 (_version=2)

グラフの色を指定します。<COLOR>には、red, orange, yellow, lightgreen, green, blue, purple, violetのいずれか、または#RRGGBBの形式の16進数で直接指定します。名前で指定した場合、実際の色はcolorthemeによって変わります。
省略した場合は、blue, red, lightgreen, purple, orange, green, violet, yellowの順で自動的に選ばれます。
DKEYごとに、1つまで指定できます。

例:

体重.color=orange
体重.color=#A0B073

バージョンごとのコマンド対応表

ChartExpertのバージョン 1.0 1.0 1.1以上 1.1以上
_version 1 2 1 2
<CKEY>.title エラー
<CKEY>.type エラー
<CKEY>.dataset エラー
<CKEY>.colortheme エラー
<CKEY>.position エラー
<DKEY>.y エラー
<DKEY>.x エラー
<DKEY>.label エラー
<DKEY>.xlabel エラー
<DKEY>.ylabel エラー
<DKEY>.xaxis エラー
<DKEY>.yaxis エラー
<DKEY>.color エラー エラー 非対応(無視)
© 2017 samurai-apps. All rights reserved. Powered by WordPress Entries RSS Comments RSS