// o---------------------------------------------------------------------------------o
// | This file is part of the RGraph package - you can learn more at: |
// | |
// | https://www.rgraph.net/license.html |
// | |
// | RGraph is dual-licensed under the Open Source GPL license. That means that it's |
// | free to use and there are no restrictions on what you can use RGraph for! |
// | If the GPL license does not suit you however, then there's an inexpensive |
// | commercial license option available. See the URL above for more details. |
// o---------------------------------------------------------------------------------o
//
// Having this here means that the RGraph libraries can be included in any order, instead of you having
// to include the common core library first.
//
// Define the RGraph global variable
RGraph = window.RGraph || {isrgraph:true,isRGraph: true,rgraph:true};
RGraph.Drawing = RGraph.Drawing || {};
//
// The constructor. This function sets up the object.
//
RGraph.Drawing.Rect = function (conf)
{
var id = conf.id,
x = conf.x,
y = conf.y,
width = conf.width,
height = conf.height;
// id, x, y, w, h
this.id = id;
this.canvas = document.getElementById(this.id);
this.context = this.canvas.getContext('2d');
this.colorsParsed = false;
this.canvas.__object__ = this;
this.original_colors = [];
this.coordsText = [];
this.firstDraw = true; // After the first draw this will be false
//
// This defines the type of this shape
//
this.type = 'drawing.rect';
//
// This facilitates easy object identification, and should always be true
//
this.isRGraph = true;
this.isrgraph = true;
this.rgraph = true;
//
// This adds a uid to the object that you can use for identification purposes
//
this.uid = RGraph.createUID();
//
// This adds a UID to the canvas for identification purposes
//
this.canvas.uid = this.canvas.uid ? this.canvas.uid : RGraph.createUID();
//
// Some example background properties
//
this.properties =
{
marginTop: 35, // Used for clipping
marginBottom: 35, // Used for clipping
marginLeft: 35, // Used for clipping
marginRight: 35, // Used for clipping
colorsStroke: 'rgba(0,0,0,0)',
colorsFill: 'red',
shadow: false,
shadowColor: 'gray',
shadowOffsetx: 3,
shadowOffsety: 3,
shadowBlur: 5,
text: null,
highlightStroke: 'black',
highlightFill: 'rgba(255,255,255,0.7)',
tooltips: null,
tooltipsEffect: 'slide',
tooltipsCssClass: 'RGraph_tooltip',
tooltipsCss: null,
tooltipsEvent: 'onclick',
tooltipsHighlight: true,
tooltipsCoordsPage: false,
tooltipsValign: 'top',
tooltipsPersistent: false,
tooltipsFormattedPoint: '.',
tooltipsFormattedThousand: ',',
tooltipsFormattedDecimals: 0,
tooltipsFormattedUnitsPre: '',
tooltipsFormattedUnitsPost: '',
tooltipsFormattedListType: 'ul',
tooltipsFormattedListItems: null,
tooltipsPointer: true,
tooltipsPointerOffsetx: 0,
tooltipsPointerOffsety: 0,
tooltipsPositionStatic: true,
clearto: 'rgba(0,0,0,0)',
clip: null
}
//
// Add the reverse look-up table for property names
// so that property names can be specified in any case.
//
this.properties_lowercase_map = [];
for (var i in this.properties) {
if (RGraph.isString(i)) {
this.properties_lowercase_map[i.toLowerCase()] = i;
}
}
//
// A simple check that the browser has canvas support
//
if (!this.canvas) {
alert('[DRAWING.RECT] No canvas support');
return;
}
//
// This can be used to store the coordinates of shapes on the graph
//
this.coords = [[
Math.round(x),
Math.round(y),
width,
height
]];
//
// Create the dollar object so that functions can be added to them
//
this.$0 = {};
// Easy access to properties and the path function
var properties = this.properties;
this.path = RGraph.pathObjectFunction;
//
// "Decorate" the object with the generic effects if the effects library has been included
//
if (RGraph.Effects && typeof RGraph.Effects.decorate === 'function') {
RGraph.Effects.decorate(this);
}
//
// A setter method for setting graph properties. It can be used like this: obj.set('colorsStroke', '#666');
//
// @param name string The name of the property to set
// @param value mixed The value of the property
//
this.set = function (name)
{
var value = typeof arguments[1] === 'undefined' ? null : arguments[1];
// Ensure the correct capitalisation
if (typeof name === 'string') {
name = this.properties_lowercase_map[name.toLowerCase()] || name;
}
// Set the colorsParsed flag to false if the colors
// property is being set
if (
name === 'colorsFill'
|| name === 'colorsStroke'
|| name === 'highlightStroke'
|| name === 'highlightFill'
) {
this.colorsParsed = false;
}
// the number of arguments is only one and it's an
// object - parse it for configuration data and return.
if (arguments.length === 1 && typeof arguments[0] === 'object') {
for (i in arguments[0]) {
if (typeof i === 'string') {
this.set(i, arguments[0][i]);
}
}
return this;
}
properties[name] = value;
return this;
};
//
// A getter method for retrieving graph properties. It can be used like this: obj.get('colorsStroke');
//
// @param name string The name of the property to get
//
this.get = function (name)
{
// Ensure the correct capitalisation
name = this.properties_lowercase_map[name.toLowerCase()] || name;
return properties[name];
};
//
// Draws the rectangle
//
this.draw = function ()
{
//
// Fire the onbeforedraw event
//
RGraph.fireCustomEvent(this, 'onbeforedraw');
//
// Install clipping
//
// MUST be the first thing that's done after the
// beforedraw event
//
if (!RGraph.isNullish(this.properties.clip)) {
RGraph.clipTo.start(this, this.properties.clip);
}
// Translate half a pixel for antialiasing purposes - but only if it hasn't been
// done already
//
// MUST be the first thing done!
//
if (!this.canvas.__rgraph_aa_translated__) {
this.context.translate(0.5,0.5);
this.canvas.__rgraph_aa_translated__ = true;
}
//
// Stop this growing uncntrollably
//
this.coordsText = [];
//
// Parse the colors. This allows for simple gradient syntax
//
if (!this.colorsParsed) {
this.parseColors();
// Don't want to do this again
this.colorsParsed = true;
}
//
// Draw the rect here
//
this.path('b');
if (properties.shadow) {
this.path(
'sc % sx % sy % sb %',
properties.shadowColor,
properties.shadowOffsetx,
properties.shadowOffsety,
properties.shadowBlur
);
}
this.path(
'r % % % % f %',
this.coords[0][0], this.coords[0][1], this.coords[0][2], this.coords[0][3],
properties.colorsFill
);
// No shadow to stroke the rectangle
RGraph.noShadow(this);
this.path('s %', properties.colorsStroke);
//
// Add custom text thats specified
//
RGraph.addCustomText(this);
//
// This installs the event listeners
//
RGraph.installEventListeners(this);
//
// End clipping
//
if (!RGraph.isNullish(this.properties.clip)) {
RGraph.clipTo.end();
}
//
// Fire the onfirstdraw event
//
if (this.firstDraw) {
this.firstDraw = false;
RGraph.fireCustomEvent(this, 'onfirstdraw');
this.firstDrawFunc();
}
//
// Fire the draw event
//
RGraph.fireCustomEvent(this, 'ondraw');
return this;
};
//
// Used in chaining. Runs a function there and then - not waiting for
// the events to fire (eg the onbeforedraw event)
//
// @param function func The function to execute
//
this.exec = function (func)
{
func(this);
return this;
};
//
// The getObjectByXY() worker method
//
this.getObjectByXY = function (e)
{
if (this.getShape(e)) {
return this;
}
};
//
// Not used by the class during creating the graph, but is used by event handlers
// to get the coordinates (if any) of the selected bar
//
// @param object e The event object
// @param object OPTIONAL You can pass in the bar object instead of the
// function using "this"
//
this.getShape = function (e)
{
var mouseXY = RGraph.getMouseXY(e),
mouseX = mouseXY[0],
mouseY = mouseXY[1];
for (var i=0,len=this.coords.length; i<len; i++) {
var coords = this.coords[i];
var left = coords[0],
top = coords[1],
width = coords[2],
height = coords[3];
if ( mouseX >= left
&& mouseX <= (left + width)
&& mouseY >= top
&& mouseY <= (top + height)
&& (this.properties.clip ? RGraph.clipTo.test(this, mouseX, mouseY) : true)
) {
if (RGraph.parseTooltipText && properties.tooltips) {
var tooltip = RGraph.parseTooltipText(properties.tooltips, 0);
}
return {
object: this,
x: left,
y: top,
width: width,
height: height,
dataset: 0,
index: 0,
sequentialIndex: 0,
tooltip: typeof tooltip === 'string' ? tooltip : null
};
}
}
return null;
};
//
// Each object type has its own Highlight() function which highlights the appropriate shape
//
// @param object shape The shape to highlight
//
this.highlight = function (shape)
{
if (typeof properties.highlightStyle === 'function') {
(properties.highlightStyle)(shape);
} else {
RGraph.Highlight.rect(this, shape);
}
};
//
// This allows for easy specification of gradients
//
this.parseColors = function ()
{
// Save the original colors so that they can be restored when the canvas is reset
if (this.original_colors.length === 0) {
this.original_colors.colorsFill = RGraph.arrayClone(properties.colorsFill);
this.original_colors.colorsStroke = RGraph.arrayClone(properties.colorsStroke);
this.original_colors.highlightStroke = RGraph.arrayClone(properties.highlightStroke);
this.original_colors.highlightFill = RGraph.arrayClone(properties.highlightFill);
}
//
// Parse various properties for colors
//
properties.colorsFill = this.parseSingleColorForGradient(properties.colorsFill);
properties.colorsStroke = this.parseSingleColorForGradient(properties.colorsStroke);
properties.highlightStroke = this.parseSingleColorForGradient(properties.highlightStroke);
properties.highlightFill = this.parseSingleColorForGradient(properties.highlightFill);
};
//
// Use this function to reset the object to the post-constructor state. Eg reset colors if
// need be etc
//
this.reset = function ()
{
};
//
// This parses a single color value
//
this.parseSingleColorForGradient = function (color)
{
if (!color) {
return color;
}
if (typeof color === 'string' && color.match(/^gradient\((.*)\)$/i)) {
// Allow for JSON gradients
if (color.match(/^gradient\(({.*})\)$/i)) {
return RGraph.parseJSONGradient({object: this, def: RegExp.$1});
}
var parts = RegExp.$1.split(':'),
grad = this.context.createLinearGradient(0,0,this.canvas.width,0),
diff = 1 / (parts.length - 1);
grad.addColorStop(0, RGraph.trim(parts[0]));
for (var j=1,len=parts.length; j<len; ++j) {
grad.addColorStop(j * diff, RGraph.trim(parts[j]));
}
}
return grad ? grad : color;
};
//
// Using a function to add events makes it easier to facilitate method chaining
//
// @param string type The type of even to add
// @param function func
//
this.on = function (type, func)
{
if (type.substr(0,2) !== 'on') {
type = 'on' + type;
}
if (typeof this[type] !== 'function') {
this[type] = func;
} else {
RGraph.addCustomEventListener(this, type, func);
}
return this;
};
//
// This function runs once only
// (put at the end of the file (before any effects))
//
this.firstDrawFunc = function ()
{
};
//
// A worker function that handles Bar chart specific tooltip substitutions
//
this.tooltipSubstitutions = function (opt)
{
return {
index: 0,
dataset: 0,
sequentialIndex: 0,
value: null
};
};
//
// This allows for static tooltip positioning
//
this.positionTooltipStatic = function (args)
{
var obj = args.object,
e = args.event,
tooltip = args.tooltip,
index = args.index,
canvasXY = RGraph.getCanvasXY(obj.canvas);
// Position the tooltip in the X direction
args.tooltip.style.left = (
canvasXY[0] // The X coordinate of the canvas
+ this.coords[0][0] + (this.coords[0][2] / 2) // The X coordinate of the rect
- (tooltip.offsetWidth / 2) // Subtract half of the tooltip width
+ obj.properties.tooltipsOffsetx // Add any user defined offset
) + 'px';
args.tooltip.style.top = (
canvasXY[1] // The Y coordinate of the canvas
- tooltip.offsetHeight // The height of the tooltip
+ obj.properties.tooltipsOffsety // Add any user defined offset
+ this.coords[0][1] // The X coordinate of the rect
- 10 // An arbitrary amount
) + 'px';
};
//
// Objects are now always registered so that the chart is redrawn if need be.
//
RGraph.register(this);
//
// This is the 'end' of the constructor so if the first argument
// contains configuration data - handle that.
//
RGraph.parseObjectStyleConfig(this, conf.options);
};