API Docs for:
Show:

Title Class

Module: core
Parent Module: multigraph

Title is a Jermiane model that controls Graph Titles.

Constructor

Title

(
  • text
  • graph
)

Parameters:

Methods

initializeGeometry

(
  • graphicsContext
)
chainable

Determines the geometry of the Title's text.

Parameters:

  • graphicsContext Object

render

() private

Renders the Graph Title. Overridden by implementations in graphics drivers.

render

(
  • context
)
chainable

Provided by the canvas module.

Defined in src/graphics/canvas/graph_title.js:11

Renders the title using the Canvas driver.

Parameters:

  • context HTMLCanvasObject

render

(
  • paper
  • set
)
chainable

Provided by the raphael module.

Defined in src/graphics/raphael/graph_title.js:39

Renders the title using the Raphael driver.

Parameters:

  • paper Paper
  • set Set

Properties

anchor

Point

A coordinate pair which gives the relative location of the Title's anchor point.

base

Point

A coordinate pair which gives the location of the Title's base point, relative to its Graph's plot or padding box - determined by the frame attribute.

border

Integer

The width of the border to be drawn around the title in pixel; use a value of 0 to not draw a border.

bordercolor

RGBColor

Color for the Title's border.

color

RGBColor

Background color for the Title's region.

cornerradius

Integer deprecated

Determines whether the corners of the title appear rounded. If cornerradius is 0, which is the default, the corners are drawn square. If cornerradius > 0, then the corners are rounded off using circles whose radius is cornerradius pixels.

font-size

String

The font-size of the title. Currently is a constant.

frame

String

Determines if the Title is positioned relative to the Graphs plot or padding box.

graph

Graph

Pointer to the Title's parent Graph Jermaine model.

opacity

Number

Opacity of the Title's region.

padding

Integer

The width of the padding between the Title's text and its border in pixels; use a value of 0 to not draw the padding.

position

Point

A coordinate pair of pixel offsets for the base point.

text

Text

The text of the title.