Show:

ia.BoxChart Class

Extends ia.ChartBase
Defined in: ia\charts\BoxChart.js:1
Module: ia

Box Chart.

Constructor

ia.BoxChart

(
  • id
)

Defined in ia\charts\BoxChart.js:1

Parameters:

  • id String

    The id of the chart.

Methods

_addListeners

() private

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:264

Adds the listeners.

_calculateXAxisLabels

(
  • minValue
  • maxValue
  • noLabels
  • axisSize
  • labelPadding
)
String private

Inherited from ia.ChartBase: ia\charts\ChartBase.js:869

Calculates the x-axis labels. Keeps reducing the number of labels till they dont overlap.

Parameters:

  • minValue Number

    The min value.

  • maxValue Number

    The max value.

  • noLabels Number

    The number of labels.

  • axisSize Number

    The pixel area reserved for all the labels.

  • labelPadding Number

    The label padding.

Returns:

String: The list of labels.

_calculateYAxisLabels

(
  • minValue
  • maxValue
  • noLabels
  • axisSize
  • labelSize
)
String private

Inherited from ia.ChartBase: ia\charts\ChartBase.js:1063

Calculates the y-axis labels. Keeps reducing the number of labels till they dont overlap.

Parameters:

  • minValue Number

    The min value.

  • maxValue Number

    The max value.

  • noLabels Number

    The number of labels.

  • axisSize Number

    The pixel area reserved for all the labels.

  • labelSize Number

    The pixel area reserved for each individual label.

Returns:

String: The list of labels.

_createCanvas

() HTML Canvas private

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:247

Creates a new canvas.

Returns:

HTML Canvas: The canvas.

_dropXLabels

(
  • labels
  • axisSize
  • labelPadding
)
String private

Inherited from ia.ChartBase: ia\charts\ChartBase.js:926

Removes labels from xAxisLabels if they overlap.

Parameters:

  • labels String

    The labels.

  • axisSize Number

    The pixel area reserved for all the labels.

  • labelPadding Number

    The label padding.

Returns:

String: The list of labels.

_dropYLabels

(
  • labels
  • axisSize
  • labelHeight
)
String private

Inherited from ia.ChartBase: ia\charts\ChartBase.js:1115

Removes labels from yAxisLabels if they overlap.

Parameters:

  • labels String

    The labels.

  • axisSize Number

    The pixel area reserved for all the labels.

  • labelHeight Number

    The label height.

Returns:

String: The list of labels.

_getLabelHeight

(
  • text
  • labelPadding
  • lineHeight
  • availableSpace
  • The
)
private

Inherited from ia.ChartBase: ia\charts\ChartBase.js:726

Gets the label height for the given text.

Parameters:

  • text String

    The text.

  • labelPadding Number

    The label padding.

  • lineHeight Number

    The text line height.

  • availableSpace Number

    The available space for the label.

  • The Number

    height.

_getLabelWidth

(
  • text
  • labelPadding
  • The
)
private

Inherited from ia.ChartBase: ia\charts\ChartBase.js:691

Gets the label width for the given text.

Parameters:

  • text String

    The text.

  • labelPadding Number

    The label padding.

  • The Number

    width.

_getLooseLabels

(
  • minValue
  • maxValue
  • noLabels
)
String private

Inherited from ia.ChartBase: ia\charts\ChartBase.js:1209

Gets loose labels. The min and max value may change

Parameters:

  • minValue Number

    The min value.

  • maxValue Number

    The max value.

  • noLabels Number

    The number of labels.

Returns:

String: The list of labels.

_getMaxLabelHeight

(
  • labels
  • labelPadding
  • The
)
private

Inherited from ia.ChartBase: ia\charts\ChartBase.js:745

Gets the maximum label height from a list of labels.

Parameters:

  • labels String

    The labels.

  • labelPadding Number

    The label padding.

  • The Number

    width.

_getMaxLabelWidth

(
  • labels
  • labelPadding
  • The
)
private

Inherited from ia.ChartBase: ia\charts\ChartBase.js:706

Gets the maximum label width from a list of labels.

Parameters:

  • labels String

    The labels.

  • labelPadding Number

    The label padding.

  • The Number

    width.

_getNoLines

(
  • text
  • lineWidth
  • The
)
private

Inherited from ia.ChartBase: ia\charts\ChartBase.js:765

Gets the number of lines a piece of text will take up given the line width.

Parameters:

  • text String

    The text.

  • lineWidth Number

    The line width.

  • The Number

    number of lines.

_getTightLabels

(
  • minValue
  • maxValue
  • noLabels
)
String private

Inherited from ia.ChartBase: ia\charts\ChartBase.js:1244

Gets tight labels. The min and max value are maintained.

Parameters:

  • minValue Number

    The min value.

  • maxValue Number

    The max value.

  • noLabels Number

    The number of labels.

Returns:

String: The list of labels.

_getXAxisLabels

(
  • minValue
  • maxValue
  • noLabels
  • axisSize
  • labelPadding
)
String private

Inherited from ia.ChartBase: ia\charts\ChartBase.js:845

Gets the x-axis labels.

Parameters:

  • minValue Number

    The min value.

  • maxValue Number

    The max value.

  • noLabels Number

    The number of labels.

  • axisSize Number

    The pixel area reserved for all the labels.

  • labelPadding Number

    The label padding.

Returns:

String: The list of labels.

_getYAxisLabels

(
  • minValue
  • maxValue
  • noLabels
  • axisSize
  • labelSize
)
String private

Inherited from ia.ChartBase: ia\charts\ChartBase.js:1034

Gets the y-axis labels.

Parameters:

  • minValue Number

    The min value.

  • maxValue Number

    The max value.

  • noLabels Number

    The number of labels.

  • axisSize Number

    The pixel area reserved for all the labels.

  • labelSize Number

    The pixel area reserved for each individual label.

Returns:

String: The list of labels.

_mouseEventHandler

(
  • event
)
private

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:290

Responsible for handling mouse events and then dispatching the relevant map event.

Parameters:

  • event MouseEvent

    Dispatched by the mouse.

_touchEventHandler

(
  • event
)
private

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:411

Responsible for handling touch events and then dispatching the relevant map event.

Parameters:

  • event TouchEvent

    Dispatched by the mouse.

_wrapText

(
  • text
  • x
  • y
  • maxWidth
  • lineHeight
)
private

Inherited from ia.ChartBase: ia\charts\ChartBase.js:801

Wraps text given the space available.

Parameters:

  • text String

    The text.

  • x Number

    The x position of the text.

  • y Number

    The y position of the text

  • maxWidth Number

    The available width.

  • lineHeight Number

    The line height.

addEventListener

(
  • eventType
  • fnc
  • obj
)

Inherited from ia.EventDispatcher: ia\events\EventDispatcher.js:15

Add an event listener.

Parameters:

  • eventType String

    The type of event to listen for.

  • fnc Function

    The function to call when the event occurs.

  • obj Object

    An optional parent object.

addLayer

(
  • layer
)

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:611

Adds a layer to the map.

Parameters:

adjustBBox

(
  • bb
)

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:352

Adjusts the bounding box to fit the pixel space whilst maintaining its aspect ratio.

Parameters:

adjustY

(
  • bb
)

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:396

Adjusts the y coords to fit the pixel space whilst maintaining x coords.

Parameters:

clear

()

Inherited from ia.CanvasBase but overwritten in ia\charts\CanvasBase.js:590

Clears the canvas.

commitChanges

()

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:306

A call to commitChanges commits any changes made to canvasWidth, canvasHeight or bBox.

This function exists to allow properties to be changed without continuous updates to the object.

dispatchEvent

(
  • event
)

Inherited from ia.EventDispatcher: ia\events\EventDispatcher.js:50

Dispatch an event to the listeners.

Parameters:

  • event Object

    The event object.

endDrag

()

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:678

Ends a map drag.

exportData

(
  • txt
)

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:549

Exports as an image in a new page.

Parameters:

  • txt String

    Any text to go with image.

getAxisValues

(
  • minValue
  • minValue
  • noValues
)
Number

Inherited from ia.ChartBase: ia\charts\ChartBase.js:1181

Returns the given number of equally spaced values along an axis.

Parameters:

  • minValue Number

    The min value.

  • minValue Number

    The max value.

  • noValues Number

    The number of values.

Returns:

Number: A list of values.

getBBox

() ia.BoundingBox

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:111

Gets the bounding box.

Returns:

ia.BoundingBox: The bounding box.

getDataBBox

(
  • rect
)
ia.BoundingBox

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:234

Converts a rectangle (pixel units) to a bBox (data units).

Parameters:

Returns:

ia.BoundingBox: A bBox (data units).

getDataHeight

(
  • dimension
)
Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:292

Converts a height from pixel units to data units.

Parameters:

  • dimension Number

    A height (pixel units).

Returns:

Number: A height (data units).

getDataPoint

(
  • p
)
ia.Point

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:221

Converts a point from pixel units to data units.

Parameters:

Returns:

ia.Point: A point (data units).

getDataWidth

(
  • dimension
)
Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:278

Converts a width from pixel units to data units.

Parameters:

  • dimension Number

    A width (pixel units).

Returns:

Number: A width (data units).

getDataX

(
  • x
)
Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:252

Converts an x-coord from pixel units to data units.

Parameters:

  • x Number

    An x-coord (pixel units).

Returns:

Number: An x-coord (data units).

getDataY

(
  • y
)
Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:265

Converts a y-coord from pixel units to data units.

Parameters:

  • y Number

    A y-coord (pixel units).

Returns:

Number: A y-coord (data units).

getLayer

(
  • id
)
ia.LayerBase

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:650

Gets the map layer with the given id.

Parameters:

  • id String

    The layer id.

Returns:

ia.LayerBase: The layer, or undefined.

getLayers

() ia.LayerBase[]

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:623

Gets the map layers.

Returns:

ia.LayerBase[]: The layers in the map.

getPixelHeight

(
  • y
)
Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:206

Converts a height from data units to pixel units.

Parameters:

  • y Number

    A height (data units).

Returns:

Number: A height (pixel units).

getPixelPoint

(
  • p
)
ia.Point

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:135

Converts a point from data units to pixel units.

Parameters:

Returns:

ia.Point: A point (pixel units).

getPixelRect

(
  • bb
)
ia.Rectangle

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:147

Converts a bounding box (data units) to a rectangle (pixel units).

Parameters:

Returns:

ia.Rectangle: A rectangle (pixel units).

getPixelWidth

(
  • x
)
Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:191

Converts a width from data units to pixel units.

Parameters:

  • x Number

    A width (data units).

Returns:

Number: A width (pixel units).

getPixelX

(
  • x
)
Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:163

Converts an x-coord from data units to pixel units.

Parameters:

  • x Number

    An x-coord (data units).

Returns:

Number: An x-coord (pixel units).

getPixelY

(
  • y
)
Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:177

Converts a y-coord from data units to pixel units.

Parameters:

  • y Number

    A y-coord (data units).

Returns:

Number: A y-coord (pixel units).

hide

()

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:702

Hides the chart.

mouseCoords

() ia.Point

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:535

Returns the cursor position in data units.

Returns:

ia.Point: The cursor position (data units).

removeLayers

()

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:634

Removes all layers from the map.

removeListener

(
  • obj
)

Inherited from ia.EventDispatcher: ia\events\EventDispatcher.js:30

Removes all event listeners for the given object.

Parameters:

  • obj Object

    The object.

render

()

Inherited from ia.CanvasBase but overwritten in ia\charts\BoxChart.js:16

Clears and renders the chart.

renderAxes

(
  • xMin
  • xMax
  • yMin
  • yMax
)

Inherited from ia.ChartBase: ia\charts\ChartBase.js:256

Renders the grid and adjusts the bounding box.

Parameters:

  • xMin Number

    The min value along the x axis.

  • xMax Number

    The max value along the x axis.

  • yMin Number

    The min value along the y axis.

  • yMax Number

    The max value along the y axis.

setBBox

(
  • bBox
)

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:122

Sets the bounding box.

Parameters:

show

()

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:718

Shows the chart.

startDrag

()

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:667

Starts a map drag.

toggle

()

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:691

Toggles the chart visibility.

Properties

animationMode

Boolean

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:105

Animation mode.

Default: false

backgroundContainer

JQUERY Element

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:178

Containers the map canvas.

canvas

HTML Canvas

Inherited from ia.CanvasBase but overwritten in ia\charts\CanvasBase.js:122

The canvas.

canvasHeight

Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:67

The pixel height.

Default: 0

canvasWidth

Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:58

The pixel width.

Default: 0

canvasX

Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:40

The pixel x-position.

Default: 0

canvasY

Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:49

The pixel y-position.

Default: 0

centerXAxisLabels

Boolean

Inherited from ia.ChartBase: ia\charts\ChartBase.js:205

Center the x axis labels.

Default: false

centerYAxisLabels

Boolean

Inherited from ia.ChartBase: ia\charts\ChartBase.js:214

Center the y axis labels.

Default: false

container

JQUERY Element

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:162

The container that holds the object.

context

HTML Canvas Context

Inherited from ia.CanvasBase but overwritten in ia\charts\CanvasBase.js:130

The canvas context.

datatip

ia.ChartTip

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:154

The data tip.

embeddedInGoogleMaps

Boolean

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:229

Indicates if embedded in google maps.

Default: false

fixedMaxValue

Number

Inherited from ia.ChartBase: ia\charts\ChartBase.js:248

The max value.

fixedMinValue

Number

Inherited from ia.ChartBase: ia\charts\ChartBase.js:240

The min value.

foregroundContainer

JQUERY Element

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:194

Containers selection / highlight canvas.

formatter

ia.Formatter

Inherited from ia.ChartBase: ia\charts\ChartBase.js:232

The formatter.

id

String

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:114

The id.

isDraggable

Boolean

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:238

Indicates if its draggable ie Its a map - used by touch events.

Default: false

isVisible

Boolean

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:202

The chart visibility.

Default: true

layerContainer

JQUERY Element

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:186

The container that holds the layers.

maintainAspectRatio

Boolean

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:94

The data space will often be a different shape to the pixel space it has to fill.

If set to true the data space is adjusted to maintain the aspect ratio.

If set to false the data space stretches to fit the pixel space. This will generally result in the aspect ratio changing (a stretching effect).

Default: false

mapContainer

JQUERY Element

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:170

The container that holds all the divs.

maxZoom

Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:85

The maximum extent.

Default: -1

minZoom

Number

Inherited from ia.CartesianSpace: ia\geom\CartesianSpace.js:76

The minimum extent.

Default: -1

mouseX

Number

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:211

The x coordinate of the mouse (pixel units) relative to the map origin.

Default: 0

mouseY

Number

Inherited from ia.CanvasBase: ia\charts\CanvasBase.js:220

The y coordinate of the mouse (pixel units) relative to the map origin.

Default: 0

orientation

String

Inherited from ia.ChartBase: ia\charts\ChartBase.js:56

The chart orientation.

Default: "vertical"

showBottomBorder

Boolean

Inherited from ia.ChartBase: ia\charts\ChartBase.js:83

Show the bottom border.

Default: false

showBox

Boolean

Inherited from ia.ChartBase: ia\charts\ChartBase.js:65

Show a box around the chart.

Default: false

showLeftBorder

Boolean

Inherited from ia.ChartBase: ia\charts\ChartBase.js:92

Show the left border.

Default: false

showRightBorder

Boolean

Inherited from ia.ChartBase: ia\charts\ChartBase.js:101

Show the right border.

Default: false

showTopBorder

Boolean

Inherited from ia.ChartBase: ia\charts\ChartBase.js:74

Show the top border.

Default: false

showXAxisGrid

Boolean

Inherited from ia.ChartBase: ia\charts\ChartBase.js:178

Show the x axis grid.

Default: true

showXAxisLabels

Boolean

Inherited from ia.ChartBase: ia\charts\ChartBase.js:126

Show the x axis labels.

Default: true

showXAxisTickMarks

Boolean

Inherited from ia.ChartBase: ia\charts\ChartBase.js:152

Show x axis tick marks.

Default: false

showYAxisGrid

Boolean

Inherited from ia.ChartBase: ia\charts\ChartBase.js:187

Show the y axis grid.

Default: true

showYAxisLabels

Boolean

Inherited from ia.ChartBase: ia\charts\ChartBase.js:161

Show the y axis labels.

Default: true

showYAxisTickMarks

Boolean

Inherited from ia.ChartBase: ia\charts\ChartBase.js:196

Show y axis tick marks.

Default: false

useTightLabels

Boolean

Inherited from ia.ChartBase: ia\charts\ChartBase.js:223

Should the chart use tight labels.

Default: false

wrapXAxisLabels

Boolean

Inherited from ia.ChartBase: ia\charts\ChartBase.js:135

Wrap the x axis labels.

Default: false

xAxisLabels

String

Inherited from ia.ChartBase: ia\charts\ChartBase.js:110

X axis labels.

xAxisTitle

String

Inherited from ia.ChartBase: ia\charts\ChartBase.js:144

The x axis title.

yAxisLabels

String

Inherited from ia.ChartBase: ia\charts\ChartBase.js:118

Y axis labels.

yAxisTitle

String

Inherited from ia.ChartBase: ia\charts\ChartBase.js:170

The y axis title.