📈

Graph

2021/12/30 21:322022/1/7 21:32

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

特徴

には、以下のようなプロパティがあります。

そのを一意に識別するための識別子です。そのの中で同じのを作ることはできません。Pixela のグラフなどを表示させる際に、URLの一部としても使われます。また、後から変更することはできません。

APIドキュメントなどでこれを指し示す場合、しばしばなどのように表現されます。

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

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

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

そのに紐付く Pixel を表示させたときの色を指定することができます。のいずれかを指定します。それぞれの色を指定したときの実際の色は、以下の画像を参照してください。

カラースキーマごとの配色のサンプルを確認する

以下のいずれかの手段によってにが投稿された場合、その時の現在日時が用いられます。

その現在日時を取得する際に考慮するタイムゾーンを、このプロパティで設定できます。

ここで設定した内容は GET - /v1/users/<username>/graphs/<graphID>.html などで確認することができます。

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

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

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

詳細な内容や活用方法については 💬Pixel に付加情報を付与する・表示させるも参照してください。

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

プロパティを用いてできることは、あくまで一覧表示内容にそのグラフを含めないようにすることだけです。そのグラフのURLを指定しそのグラフを閲覧することを制限することはできません。