📈
Graph
This equals to an object that the posted Pixels are displayed in the form of a calendar heatmap, or configuration properties related to its display content.
Related API
There are a total of 9 APIs related to , which can be categorized into the following 3 types:
- APIs for creating and deleting and updating their properties
- APIs for displaying
- APIs for retrieving the other information about
1. APIs for creating and deleting and updating their properties
- POST - /v1/users/<username>/graphs
- This is an API for creating a new .
- PUT - /v1/users/<username>/graphs/<graphID>
- This is an API for updating an existing .
- DELETE - /v1/users/<username>/graphs/<graphID>
- This is an API for deleting an existing .
2. APIs for displaying
- GET - /v1/users/<username>/graphs/<graphID>
- This is an API for getting Pixels associated with a as an SVG image in calendar heatmap format.
- Relates:
- GET - /v1/users/<username>/graphs/<graphID>.html
- This is an API that returns an HTML page where you can list various information about the . This API is expected to be requested by a web browser.
- Relates:
3. APIs for retrieving the other information about
- GET - /v1/users/<username>/graphs
- This is an API for retrieving an array of the definition of the registered Graphs.
- GET - /v1/users/<username>/graphs/<graphID>/pixels
- This is an API for retrieving the Pixels are registered to which specified by .
- GET - /v1/users/<username>/graphs/<graphID>/stats
- This is an API for retrieving the statistics of the specified by .
- GET - /v1/users/<username>/graphs/<graphID>/graph-def
- This is an API for retrieving the definition of the specified by .
Properties and features
has the following properties:
This is an identifier for uniquely identifying the . You can’t create a that has the same in a certain . This is also used as part of the URL when you display a Pixela graph. Additionally, you can’t change this property after.
This is a property that is expected to be set a name of the . You can confirm its content by GET - /v1/users/<username>/graphs/<graphID>.html, etc.
This property is expected to be set the unit of the quantity posted to the .
For example, it is , , or . You can confirm its content by GET - /v1/users/<username>/graphs/<graphID>.html, etc.
You need to specify whether the value which is posted to the is an integer or decimal value by setting this property. Additionally, you can’t change this property after.
You can specify the color of Pixels associated with the when it is displayed.
You can specify , , , , , or to this property as its color. How is the color when you specify the each color scheme, please see the following images:
Confirm the color sample of each color scheme
When a is posted to in one of the following ways, using current date at that time.
By setting the property, you can specify the time zone that is considered when getting the current date.
Setting this property to will make this graph a calendar heatmap starting on Monday.
You can specify one of the , , or value to this property.
About how to use this property, please see Measuring and visualizing page views on your website with Pixela.
By setting this property, you can specify whether hide the graph or not on the graphs list on your user profile page. Specifying or to this property.
However, the feature that hides the graph by setting is only available to Pixela Supporters. For more detail, please see Make exclusive features available as a benefit of supporting Pixela - Pixela Supporter Program.
By setting to this property, you can make recorded in each Pixel viewable on the HTML page which GET - /v1/users/<username>/graphs/<graphID>.html returns, and you can have it added as an attribute to a graph’s SVG information.
However, the feature that enables these behaviors by setting is only available to Pixela Supporters. For more detail, please see Make exclusive features available as a benefit of supporting Pixela - Pixela Supporter Program.
About how to use this feature or for more detail, please see Add and display an additional information to Pixel.
When a Pixela graph is embedded on GitHub, the image is cached in GitHub automatically. If you want to clear the cache every updating the graph, you can do it by setting the cached image URL to this property.
Specifications
- When you delete a , all data, such as pixels, associated with it also will be deleted.
Notes
- If you don’t explicitly specify , it’s treated as UTC.
- What by using property is only making the graph removed from a graph list content.
- The only thing you can do with the property is to remove the graph from a graph list content. You can’t prevent access to the graph by specifying URL directly.