Top - Pixela Help Center/🇯🇵Pixela ヘルプセンター/📈Graph
📈

Graph

投稿済みの Pixel をカレンダーヒートマップの形式で表示させたもの、もしくは、その表示内容に関する設定項目のことを指しています。

関連API

Graph に関連するAPIは全部で9個あり、それらは以下の3種類に分類されます。
  1. Graph の作成・削除、プロパティの更新を行うためのAPI
  1. Graph の表示に関するAPI
  1. Graph に関するその他の情報を取得するためのAPI

1. Graph の作成・削除、プロパティの更新を行うためのAPI

2. Graph の表示に関するAPI

3. Graph に関するその他の情報を取得するためのAPI

特徴

Graph には、以下のようなプロパティがあります。
  • id
  • name
  • unit
  • type
  • color
  • timezone
  • selfSufficient
  • isSecret
  • publishOptionalData
  • purgeCacheURLs

id

その Graph を一意に識別するための識別子です。その User の中で同じ id の Graph を作ることはできません。Pixela のグラフなどを表示させる際に、URLの一部としても使われます。また、後から変更することはできません。
APIドキュメントなどでこれを指し示す場合、しばしば <graphID> などのように表現されます。

name

その Graph の名称が設定されることを想定したプロパティです。ここで設定した内容は GET - /v1/users/<username>/graphs/<graphID>.html などで確認することができます。

unit

その Graph に投稿される数値の単位が設定されることを想定したプロパティです。例えば、 commits pages kilograms などです。ここで設定した内容は GET - /v1/users/<username>/graphs/<graphID>.html などで確認することができます。

type

その Graph に投稿される数値が整数であるか、小数であるかを指定します。 int もしくは float のいずれかのみが指定可能です。また、後から変更することはできません。

color

その Graph に紐付く Pixel を表示させたときの色を指定することができます。 shibafu momiji sora ichou ajisai kuro のいずれかを指定します。それぞれの色を指定したときの実際の色は、以下の画像を参照してください。
カラースキーマごとの配色のサンプルを確認する
shibafu (green)
shibafu (green)
momiji (red)
momiji (red)
sora (blue)
sora (blue)
ichou (yellow)
ichou (yellow)
ajisai (purple)
ajisai (purple)
kuro (black)
kuro (black)

timezone

以下のいずれかの手段によって Graph に Pixel が投稿された場合、その時の現在日時が用いられます。
その現在日時を取得する際に考慮するタイムゾーンを、このプロパティで設定できます。
ここで設定した内容は GET - /v1/users/<username>/graphs/<graphID>.html などで確認することができます。

selfSufficient

increment decrement none のいずれかの値をこのプロパティに設定することができます。このプロパティの活用方法については 📈サイトのページビューを Pixela で計測し可視化する を参照してください。

isSecret

ユーザープロフィールページのグラフ一覧表示において、そのグラフを非表示にするかどうかを指定することができるプロパティです。 true もしくは false を設定します。ただし、 true を設定することでグラフを非表示にすることができるのは、Pixelaサポーター限定の機能です。詳しくは 💝Pixela を支援する特典として限定機能を利用可能にする - Pixela サポータープログラム を参照してください。

publishOptionalData

このプロパティに true を設定することで、各 Pixel に記録されている optionalData を GET - /v1/users/<username>/graphs/<graphID>.html が返す HTML ページ上で閲覧できるようにしたり、グラフのSVG情報に属性として追加させることができます。ただし、 true を設定することでこれらの挙動を有効化できるのは、Pixelaサポーター限定の機能です。詳しくは 💝Pixela を支援する特典として限定機能を利用可能にする - Pixela サポータープログラム を参照してください。
詳細な内容や活用方法については 💬Pixel に付加情報を付与する・表示させる も参照してください。

purgeCacheURLs

Pixela のグラフを GitHub に埋め込む場合、その画像は自動的に GitHub にキャッシュされます。グラフが更新される度にそのキャッシュをクリアさせたい場合にこのプロパティにURLを設定します。詳しくは GitHub に Pixela のグラフを埋め込む を参照してください。

仕様

  • Graph を削除すると、それに紐付く Pixel などの情報もすべて削除されます。

留意事項

  • timezone を明示的に指定しなかった場合、UTCとして扱われます。
  • isSecret プロパティを用いてできることは、あくまで一覧表示内容にそのグラフを含めないようにすることだけです。そのグラフのURLを指定しそのグラフを閲覧することを制限することはできません。

関連リンク