Open Flash Chart Version 2 – JSON File Definition

Y Axis (both left and right) Attributes Objects

NOTE: Items in bold red represent patches that may or may not be added to OFC-2.

Defines the attributes for the Y Axis of the chart. This includes the Y Axis itself, the horizontal grid lines, tick marks and the labels. Formatting of the Y Axis Labels in OFC2 is provided via the “label_style” objects.

This is an example for the LEFT Y Axis using the current automatic label generation:

“y_label__label_style”:”12,#DD3030”,

"y_axis":{"min":0, "max":5, "stroke":2, "tick-height":3,

“colour”:”#784016”, “offset”:true, “grid-colour”:”#F5E1AA”,

"3d":0, "steps":1

},

This is an example for the LEFT Y Axis using the current method of providing an array of strings for the labels:

“y_label__label_style”:”12,#DD3030”,

"y_axis":{"min":0, "max":5, "stroke":2, "tick-height":3,

“colour”:”#784016”, “offset”:true, “grid-colour”:”#F5E1AA”,

"3d":0, "steps":1,

"labels": [“Jan”, “Feb”, “Mar”, “Apr”, “May” ] },

},

This is an example for the LEFT Y Axis using the patch that allows further definition of the labels:

“y_label__label_style”:”12,#DD3030”,

"y_axis":{"min":0, "max":5, "stroke":2, "tick-height":3,

“colour”:”#784016”, “offset”:true, “grid-colour”:”#F5E1AA”,

"3d":0, "steps":1,

"labels":{"rotate":”vertical”, ”size”:10, ”steps”:1, “visible-steps”:3,

"labels":[“Jan”, {text:“Feb”, “size”:12, “colour”:”#FF0000”},

“Mar”, “Apr”, “May” ] },

},

This is an example for the RIGHT Y Axis (the definition is exactly the same as for “y_axis” and “y_label__label_style”):

“y_label_2__label_style”:”10,#30DD30”,

"y_axis_right":{"min":0, "max":5, "stroke":2, "tick-height":3,

“colour”:”#784016”, “offset”:true, “grid-colour”:”#F5E1AA”,

"3d":0, "steps":1,

"labels":{"rotate":”vertical”, ”size”:10, ”steps”:1, “visible-steps”:3,

"labels":[“Jan”, {text:“Feb”, “size”:12, “colour”:”#FF0000”},

“Mar”, “Apr”, “May” ] },

},

Y Label Style String Attribute

This is the definition of the “y_label__label_style” top level string attribute. Note that the definition of “y_label_2__label_style” is exactly the same as “y_label__label_style” which is detailed here.

Y Axis Attributes Object

This is the definition of the “y_axis” object. Note that the definition of “y_axis_right” is exactly the same as “y_axis” which is detailed here.

Definition of the the “labels” object within the “y_axis” object.

OBJECT	ATTRIBUTE	VALID VALUES	DEFAULT	NOTES
“labels”
	“colour”	“#RRGGBB” hex string	“#000000”	Defines the color of the label text. Default is black.
	“text”	user defined text	“#val#”	Specifies the default label text for the Y axis labels* ** The #val# magic value allows for inserting the Y value as desired in the label. * Four magic values are available for use with unix timestamps: #date#, #date:___#, #gmdate# and #gmdate:___#.** ** See the date formatting section below
	“size”	6 to n	10	Defines the font size of the label
	“steps”	1 to n	1	Defines number of steps between the labels to be created.
	“rotate”	“vertical”	undefined	Specifies if the label should be rotated vertically or not.
	“show_labels”	true or false	true	Whether or not the labels should be visible
	“labels”	Array of strings and/or objects defining each label	[...]	If no labels are defined then labels will be generated automatically based on the “steps” value with the text being the Y value at each point. * Each label object can override any of the above attributes

Definition of the array of “labels” objects within the “labels” object in the “y_axis” object. The label objects with in the “labels” array can be either just a text string or another object with attributes specified for an individual label. Below is the definition of the attributes that are valid for one of these label objects.

OBJECT	ATTRIBUTE	VALID VALUES	DEFAULT	NOTES
label objects				Label objects that can be in the “labels” array
	“colour”	“#RRGGBB” hex string	“#000000”	Defines the color of the label text. Default is black.
	“size”	6 to n	10	Defines the font size of the label
	“rotate”	“vertical”	undefined	Specifies if the label should be rotated vertically or not.
	“y”	Numeric value	undefined	* Specifies the Y Value where a grid line and label should be displayed.
	“text”	user defined text	“#val#”	Specifies the default label text for the Y axis labels* ** The #val# magic value allows for inserting the Y value as desired in the label. * Four magic values are available for use with unix timestamps: #date#, #date:___#, #gmdate# and #gmdate:___#.** ** See the date formatting section below

Magic Values

Replacement variables can be used in the definition of tool tips and labels so that each one does not have to be individually defined. When the text is actually displayed, the variables below will be replaced with its appropriate value (assuming the variable is valid in the context it is used).

Date Formatting

The user defined date format is implemented to match the formatting performed by the PHP date function. The following table lists the valid format characters and their descriptions.

Any character that is not one of the above format characters is printed as-is.

* Escaping a format character with a backslash so that is passes through and prints is Not Implemented

Examples:

#date:Y-m-d at H:i# would format as 2008-09-18 at 09:46

#date:g:i:s a# would format as 2:14:52 pm

#gmdate:H:i# would format as 02:14