Class actuate.report.HTML5Chart.Renderer

A container for a Highchart renderer object. Directly accesses the Highchart's rendering layer to draw primitive shapes like circles, rectangles, paths or text directly. The renderer represents a wrapper object for SVG in modern browsers and VML in older versions of Microsoft Internet Explorer.
Member of: actuate.report.HTML5Chart.

Class Summary
Constructor Attributes	Constructor Name and Description
	actuate.report.HTML5Chart.Renderer() Generates a new Renderer object to manage the Highchart rendering options for a actuate.report.HTML5Chart.ClientChart.

Field Summary
Field Attributes	Field Name and Description
<static>	symbols An extendable collection of functions for defining symbol paths.

Method Summary
Method Attributes	Method Name and Description
<static>	arc(x, y, r, innerR, start, end) Draw and return an arc
<static>	buildText(textNode) Parse a simple HTML string into SVG tspans
<static>	button(text, x, y, callback, normalState, hoverState, pressedState) Create a button with preset states
<static>	circle(x, y, r) Draw and return an SVG circle
<static>	clipRect(id, x, y, width, height) Define a clipping rectangle
<static>	color(color, elem, prop) Take a color and return it if it's a string, make it a gradient if it's a gradient configuration object.
<static>	createElement(nodeName) Create a wrapper for an SVG element
<static>	createSpanNode()
<static>	crispLine(points, width) Make a straight line crisper by not spilling out to neighbour pixels
<static>	destroy() Destroys the renderer and its allocated members.
<static>	draw() Dummy function for use in canvas renderer
<static>	fontMetrics(fontSize) Utility to return the baseline offset and total line height from the font size
<static>	g(name) Create a group
<static>	html(str, x, y) Create HTML text node.
<static>	image(src, x, y, width, height) Display an image
<static>	init(container, width, height, forExport) Initialize the SVGRenderer
<static>	isHidden() Detect whether the renderer is hidden.
<static>	label(str, x, y, shape, anchorX, anchorY, baseline, className, className) Add a label, a text item that can hold a colored or gradient background as well as a border and shadow.
<static>	path(path) Draw a path
<static>	rect(x, y, width, height, r, strokeWidth) Draw and return a rectangle
<static>	setSize(width, height, animate) Resize the box and re-align all aligned elements
<static>	setSpanText(span, text)
<static>	symbol(symbol, x, y, radius, options, options) Draw a symbol out of pre-defined shape paths from the namespace 'symbol' object.
<static>	text(str, x, y, useHTML) Add text to the SVG object

Class Detail

actuate.report.HTML5Chart.Renderer()

Generates a new Renderer object to manage the Highchart rendering options for a actuate.report.HTML5Chart.ClientChart.

Field Detail

<static> symbols

An extendable collection of functions for defining symbol paths.

Method Detail

<static> arc(x, y, r, innerR, start, end)

Draw and return an arc

Parameters:
{Number} x: X position
{Number} y: Y position
{Number} r: Radius
{Number} innerR: Inner radius like used in donut charts
{Number} start: Starting angle
{Number} end: Ending angle

<static> buildText(textNode)

Parse a simple HTML string into SVG tspans

Parameters:
{Object} textNode: The parent text SVG node

<static> button(text, x, y, callback, normalState, hoverState, pressedState)

Create a button with preset states

Parameters:
{String} text
{Number} x
{Number} y
{Function} callback
{Object} normalState
{Object} hoverState
{Object} pressedState

<static> circle(x, y, r)

Draw and return an SVG circle

Parameters:
{Number} x: The x position
{Number} y: The y position
{Number} r: The radius

<static> clipRect(id, x, y, width, height)

Define a clipping rectangle

Parameters:
{String} id
{Number} x
{Number} y
{Number} width
{Number} height

<static> color(color, elem, prop)

Take a color and return it if it's a string, make it a gradient if it's a gradient configuration object. Prior to Highstock, an array was used to define a linear gradient with pixel positions relative to the SVG. In newer versions we change the coordinates to apply relative to the shape, using coordinates 0-1 within the shape. To preserve backwards compatibility, linearGradient in this definition is an object of x1, y1, x2 and y2.

Parameters:
{Object} color: The color or config object
elem
prop

<static> createElement(nodeName)

Create a wrapper for an SVG element

Parameters:
{Object} nodeName

<static> createSpanNode()

<static> crispLine(points, width)

Make a straight line crisper by not spilling out to neighbour pixels

Parameters:
{Array} points
{Number} width

<static> destroy()

Destroys the renderer and its allocated members.

<static> draw()

Dummy function for use in canvas renderer

<static> fontMetrics(fontSize)

Utility to return the baseline offset and total line height from the font size

Parameters:
fontSize

<static> g(name)

Create a group

Parameters:
{String} name: The group will be given a class name of 'highcharts-{name}'. This can be used for styling and scripting.

<static> html(str, x, y)

Create HTML text node. This is used by the VML renderer as well as the SVG renderer through the useHTML option.

Parameters:
{String} str
{Number} x
{Number} y

<static> image(src, x, y, width, height)

Display an image

Parameters:
{String} src
{Number} x
{Number} y
{Number} width
{Number} height

<static> init(container, width, height, forExport)

Initialize the SVGRenderer

Parameters:
{Object} container
{Number} width
{Number} height
{Boolean} forExport

<static> isHidden()

Detect whether the renderer is hidden. This happens when one of the parent elements has display: none. #608.

<static> label(str, x, y, shape, anchorX, anchorY, baseline, className, className)

Add a label, a text item that can hold a colored or gradient background as well as a border and shadow.

Parameters:
{string} str
{Number} x
{Number} y
{String} shape
{Number} anchorX: In case the shape has a pointer, like a flag, this is the coordinates it should be pinned to
{Number} anchorY
{Boolean} baseline: Whether to position the label relative to the text baseline, like renderer.text, or to the upper border of the rectangle.
{String} className: Class name for the group
className

<static> path(path)

Draw a path

Parameters:
{Array} path: An SVG path in array form

<static> rect(x, y, width, height, r, strokeWidth)

Draw and return a rectangle

Parameters:
{Number} x: Left position
{Number} y: Top position
{Number} width
{Number} height
{Number} r: Border corner radius
{Number} strokeWidth: A stroke width can be supplied to allow crisp drawing

<static> setSize(width, height, animate)

Resize the box and re-align all aligned elements

Parameters:
{Object} width
{Object} height
{Boolean} animate

<static> setSpanText(span, text)

Parameters:
span
text

<static> symbol(symbol, x, y, radius, options, options)

Draw a symbol out of pre-defined shape paths from the namespace 'symbol' object.

Parameters:
{Object} symbol
{Object} x
{Object} y
{Object} radius
{Object} options
options

<static> text(str, x, y, useHTML)

Add text to the SVG object

Parameters:
{String} str
{Number} x: Left position
{Number} y: Top position
{Boolean} useHTML: Use HTML to render the text

Classes

Class actuate.report.HTML5Chart.Renderer