jqplot.core.js

this.show = false

Wether to display the axis on the graph.

this.tickRenderer = $.jqplot.AxisTickRenderer

A class of a rendering engine for creating the ticks labels displayed on the plot, See $.jqplot.AxisTickRenderer.

this.tickOptions = {}

Options that will be passed to the tickRenderer, see $.jqplot.AxisTickRenderer options.

this.labelRenderer = $.jqplot.AxisLabelRenderer

A class of a rendering engine for creating an axis label.

this.labelOptions = {}

Options passed to the label renderer.

this.label = null

Label for the axis

this.showLabel = true

true to show the axis label.

this.min = null

minimum value of the axis (in data units, not pixels).

this.max = null

maximum value of the axis (in data units, not pixels).

this.autoscale = false

DEPRECATED the default scaling algorithm produces superior results.

this.pad = 1.2

Padding to extend the range above and below the data bounds.  The data range is multiplied by this factor to determine minimum and maximum axis bounds.  A value of 0 will be interpreted to mean no padding, and pad will be set to 1.0.

this.padMax = null

Padding to extend the range above data bounds.  The top of the data range is multiplied by this factor to determine maximum axis bounds.  A value of 0 will be interpreted to mean no padding, and padMax will be set to 1.0.

this.padMin = null

Padding to extend the range below data bounds.  The bottom of the data range is multiplied by this factor to determine minimum axis bounds.  A value of 0 will be interpreted to mean no padding, and padMin will be set to 1.0.

this.ticks = []

1D [val, val, ...] or 2D [[val, label], [val, label], ...] array of ticks for the axis.  If no label is specified, the value is formatted into an appropriate label.

this.numberTicks

Desired number of ticks.  Default is to compute automatically.

this.tickInterval

number of units between ticks.  Mutually exclusive with numberTicks.

this.renderer = $.jqplot.LinearAxisRenderer

A class of a rendering engine that handles tick generation, scaling input data to pixel grid units and drawing the axis element.

this.rendererOptions = {}

renderer specific options.  See $.jqplot.LinearAxisRenderer for options.

this.showTicks = true

Wether to show the ticks (both marks and labels) or not.  Will not override showMark and showLabel options if specified on the ticks themselves.

this.showTickMarks = true

Wether to show the tick marks (line crossing grid) or not.  Overridden by showTicks and showMark option of tick itself.

this.showMinorTicks = true

Wether or not to show minor ticks.  This is renderer dependent.

this.drawMajorGridlines = true

True to draw gridlines for major axis ticks.

this.drawMinorGridlines = false

True to draw gridlines for minor ticks.

this.drawMajorTickMarks = true

True to draw tick marks for major axis ticks.

this.drawMinorTickMarks = true

True to draw tick marks for minor ticks.  This is renderer dependent.

this.useSeriesColor = false

Use the color of the first series associated with this axis for the tick marks and line bordering this axis.

this.borderWidth = null

width of line stroked at the border of the axis.  Defaults to the width of the grid boarder.

this.borderColor = null

color of the border adjacent to the axis.  Defaults to grid border color.

this.scaleToHiddenSeries = false

True to include hidden series when computing axes bounds and scaling.

this.syncTicks = null

true to try and synchronize tick spacing across multiple axes so that ticks and grid lines line up.  This has an impact on autoscaling algorithm, however.  In general, autoscaling an individual axis will work better if it does not have to sync ticks.

this.tickSpacing = 75

Approximate pixel spacing between ticks on graph.  Used during autoscaling.  This number will be an upper bound, actual spacing will be less.

this.show = false

Wether to display the legend on the graph.

this.location = 'ne'

Placement of the legend.  one of the compass directions: nw, n, ne, e, se, s, sw, w

this.labels = []

Array of labels to use.  By default the renderer will look for labels on the series.  Labels specified in this array will override labels specified on the series.

this.showLabels = true

true to show the label text on the legend.

this.showSwatches = true

true to show the color swatches on the legend.

this.placement = "insideGrid"

”insideGrid” places legend inside the grid area of the plot.  “outsideGrid” places the legend outside the grid but inside the plot container, shrinking the grid to accomodate the legend.  “inside” synonym for “insideGrid”, “outside” places the legend ouside the grid area, but does not shrink the grid which can cause the legend to overflow the plot container.

this.xoffset = 0

DEPRECATED.  Set the margins on the legend using the marginTop, marginLeft, etc. properties or via CSS margin styling of the .jqplot-table-legend class.

this.yoffset = 0

DEPRECATED.  Set the margins on the legend using the marginTop, marginLeft, etc. properties or via CSS margin styling of the .jqplot-table-legend class.

this.border

css spec for the border around the legend box.

this.background

css spec for the background of the legend box.

this.textColor

css color spec for the legend text.

this.fontFamily

css font-family spec for the legend text.

this.fontSize

css font-size spec for the legend text.

this.rowSpacing = '0.5em'

css padding-top spec for the rows in the legend.

this.rendererOptions = {}

renderer specific options passed to the renderer.

Wether to draw the legend before the series or not.  Used with series specific legend renderers for pie, donut, mekko charts, etc.

this.marginTop = null

CSS margin for the legend DOM element.  This will set an element CSS style for the margin which will override any style sheet setting.  The default will be taken from the stylesheet.

this.marginRight = null

CSS margin for the legend DOM element.  This will set an element CSS style for the margin which will override any style sheet setting.  The default will be taken from the stylesheet.

this.marginBottom = null

CSS margin for the legend DOM element.  This will set an element CSS style for the margin which will override any style sheet setting.  The default will be taken from the stylesheet.

this.marginLeft = null

CSS margin for the legend DOM element.  This will set an element CSS style for the margin which will override any style sheet setting.  The default will be taken from the stylesheet.

this.escapeHtml = false

True to escape special characters with their html entity equivalents in legend text.  “<” becomes &lt; and so on, so html tags are not rendered.

this.text = text

text of the title;

this.show = true

whether or not to show the title

this.fontFamily

css font-family spec for the text.

this.fontSize

css font-size spec for the text.

this.textAlign

css text-align spec for the text.

this.textColor

css color spec for the text.

this.renderer = $.jqplot.DivTitleRenderer

A class for creating a DOM element for the title, see $.jqplot.DivTitleRenderer.

this.rendererOptions = {}

renderer specific options passed to the renderer.

this.escapeHtml = false

True to escape special characters with their html entity equivalents in title text.  “<” becomes &lt; and so on, so html tags are not rendered.

this.show = true

whether or not to draw the series.

this.xaxis = 'xaxis'

which x axis to use with this series, either ‘xaxis’ or ‘x2axis’.

this.yaxis = 'yaxis'

which y axis to use with this series, either ‘yaxis’ or ‘y2axis’.

this.renderer = $.jqplot.LineRenderer

A class of a renderer which will draw the series, see $.jqplot.LineRenderer.

this.rendererOptions = {}

Options to pass on to the renderer.

this.label = ''

Line label to use in the legend.

this.showLabel = true

true to show label for this series in the legend.

this.color

css color spec for the series

this.negativeColor

css color spec used for filled (area) plots that are filled to zero and the “useNegativeColors” option is true.

this.lineWidth = 2.5

width of the line in pixels.  May have different meanings depending on renderer.

this.lineJoin = 'round'

Canvas lineJoin style between segments of series.

this.lineCap = 'round'

Canvas lineCap style at ends of line.

this.linePattern = 'solid'

line pattern ‘dashed’, ‘dotted’, ‘solid’, some combination of ‘-’ and ‘.’ characters such as ‘.-.’ or a numerical array like [draw, skip, draw, skip, ...] such as [1, 10] to draw a dotted line, [1, 10, 20, 10] to draw a dot-dash line, and so on.

this.shadowAngle = 45

Shadow angle in degrees

this.shadowOffset = 1.25

Shadow offset from line in pixels

this.shadowDepth = 3

Number of times shadow is stroked, each stroke offset shadowOffset from the last.

this.shadowAlpha = '0.1'

Alpha channel transparency of shadow.  0 = transparent.

this.breakOnNull = false

Wether line segments should be be broken at null value.  False will join point on either side of line.

this.markerRenderer = $.jqplot.MarkerRenderer

A class of a renderer which will draw marker (e.g. circle, square, ...) at the data points, see $.jqplot.MarkerRenderer.

this.markerOptions = {}

renderer specific options to pass to the markerRenderer, see $.jqplot.MarkerRenderer.

this.showLine = true

whether to actually draw the line or not.  Series will still be renderered, even if no line is drawn.

this.showMarker = true

whether or not to show the markers at the data points.

this.index

0 based index of this series in the plot series array.

this.fill = false

true or false, whether to fill under lines or in bars.  May not be implemented in all renderers.

this.fillColor

CSS color spec to use for fill under line.  Defaults to line color.

this.fillAlpha

Alpha transparency to apply to the fill under the line.  Use this to adjust alpha separate from fill color.

this.fillAndStroke = false

If true will stroke the line (with color this.color) as well as fill under it.  Applies only when fill is true.

this.disableStack = false

true to not stack this series with other series in the plot.  To render properly, non-stacked series must come after any stacked series in the plot’s data series array.  So, the plot’s data series array would look like:

[stackedSeries1, stackedSeries2, ..., nonStackedSeries1, nonStackedSeries2, ...]

disableStack will put a gap in the stacking order of series, and subsequent stacked series will not fill down through the non-stacked series and will most likely not stack properly on top of the non-stacked series.

this.neighborThreshold = 4

how close or far (in pixels) the cursor must be from a point marker to detect the point.

this.fillToZero = false

true will force bar and filled series to fill toward zero on the fill Axis.

this.fillToValue = 0

fill a filled series to this value on the fill axis.  Works in conjunction with fillToZero, so that must be true.

this.fillAxis = 'y'

Either ‘x’ or ‘y’.  Which axis to fill the line toward if fillToZero is true.  ‘y’ means fill up/down to 0 on the y axis for this series.

this.useNegativeColors = true

true to color negative values differently in filled and bar charts.

this.drawGridlines = true

whether to draw the gridlines on the plot.

this.gridLineColor = '#cccccc'

color of the grid lines.

this.gridLineWidth = 1.0

width of the grid lines.

this.background = '#fffdf6'

css spec for the background color.

this.borderColor = '#999999'

css spec for the color of the grid border.

this.borderWidth = 2.0

width of the border in pixels.

this.drawBorder = true

True to draw border around grid.

this.shadow = true

whether to show a shadow behind the grid.

this.shadowAngle = 45

shadow angle in degrees

this.shadowOffset = 1.5

Offset of each shadow stroke from the border in pixels

this.shadowWidth = 3

width of the stoke for the shadow

this.shadowDepth = 3

Number of times shadow is stroked, each stroke offset shadowOffset from the last.

this.shadowColor = null

an optional css color spec for the shadow in ‘rgba(n, n, n, n)’ form

this.shadowAlpha = '0.07'

Alpha channel transparency of shadow.  0 = transparent.

this.renderer = $.jqplot.CanvasGridRenderer

Instance of a renderer which will actually render the grid, see $.jqplot.CanvasGridRenderer.

this.rendererOptions = {}

Options to pass on to the renderer, see $.jqplot.CanvasGridRenderer.

this.animate = false

True to animate the series on initial plot draw (renderer dependent).  Actual animation functionality must be supported in the renderer.

this.animateReplot = false

True to animate series after a call to the replot() method.  Use with caution!  Replots can happen very frequently under certain circumstances (e.g. resizing, dragging points) and animation in these situations can cause problems.

this.axes = {xaxis: new Axis('xaxis'), yaxis: new Axis('yaxis'), x2axis: new Axis('x2axis'), y2axis: new Axis('y2axis'), y3axis: new Axis('y3axis'), y4axis: new Axis('y4axis'), y5axis: new Axis('y5axis'), y6axis: new Axis('y6axis'), y7axis: new Axis('y7axis'), y8axis: new Axis('y8axis'), y9axis: new Axis('y9axis'), yMidAxis: new Axis('yMidAxis')}

up to 4 axes are supported, each with its own options, See Axis for axis specific options.

this.data = []

user’s data.  Data should NOT be specified in the options object, but be passed in as the second argument to the $.jqplot() function.  The data property is described here soley for reference.  The data should be in the form of an array of 2D or 1D arrays like

[ [[x1, y1], [x2, y2],...], [y1, y2, ...] ].

this.dataRenderer

A callable which can be used to preprocess data passed into the plot.  Will be called with 3 arguments: the plot data, a reference to the plot, and the value of dataRendererOptions.

this.dataRendererOptions

Options that will be passed to the dataRenderer.  Can be of any type.

default options that will be applied to all axes. see Axis for axes options.

seriesDefaults: {}, series:[] }

default options that will be applied to all series. see Series for series options.

this.defaultAxisStart = 1

1-D data series are internally converted into 2-D [x,y] data point arrays by jqPlot.  This is the default starting value for the missing x or y value.  The added data will be a monotonically increasing series (e.g.  [1, 2, 3, ...]) starting at this value.

this.fillBetween = { series1: null, series2: null, color: null, baseSeries: 0, fill: true }

Fill between 2 line series in a plot.  Options object: { series1: first index (0 based) of series in fill series2: second index (0 based) of series in fill color: color of fill [default fillColor of series1] baseSeries: fill will be drawn below this series (0 based index) fill: false to turn off fill [default true].  }

this.fontSize

css spec for the font-size attribute.  Default for the entire plot.

this.grid = new Grid()

See Grid for grid specific options.

this.legend = new Legend()

see <$.jqplot.TableLegendRenderer>

this.noDataIndicator = { show: false, indicator: 'Loading Data...', axes: { xaxis: { min: 0, max: 10, tickInterval: 2, show: true }, yaxis: { min: 0, max: 12, tickInterval: 3, show: true } } }

Options to set up a mock plot with a data loading indicator if no data is specified.

this.negativeSeriesColors = $.jqplot.config.defaultNegativeColors

colors to use for portions of the line below zero.

this.series = []

Array of series object options. see Series for series specific options.

this.seriesColors = $.jqplot.config.defaultColors

Ann array of CSS color specifications that will be applied, in order, to the series in the plot.  Colors will wrap around so, if their are more series than colors, colors will be reused starting at the beginning.  For pie charts, this specifies the colors of the slices.

this.sortData = true

false to not sort the data passed in by the user.  Many bar, stacked and other graphs as well as many plugins depend on having sorted data.

this.stackSeries = false

true or false, creates a stack or “mountain” plot.  Not all series renderers may implement this option.

this.title = new Title()

Title object.  See Title for specific options.  As a shortcut, you can specify the title option as just a string like: title: ‘My Plot’ and this will create a new title object with the specified text.