Show:

ia.CanvasBase Class

Extends ia.CartesianSpace
Defined in: ia\charts\CanvasBase.js:1
Module: ia

ia.CanvasBase defines the basic layout behavior of chart or map.

Constructor

ia.CanvasBase

(
  • id
)

Defined in ia\charts\CanvasBase.js:1

Parameters:

  • id String

    The id.

Methods

_addListeners

() private

Defined in ia\charts\CanvasBase.js:264

Adds the listeners.

_createCanvas

() HTML Canvas private

Defined in ia\charts\CanvasBase.js:247

Creates a new canvas.

Returns:

HTML Canvas: The canvas.

_mouseEventHandler

(
  • event
)
private

Defined in 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

Defined in ia\charts\CanvasBase.js:411

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

Parameters:

  • event TouchEvent

    Dispatched by the mouse.

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
)

Defined in 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

()

Defined in ia\charts\CanvasBase.js:590

Clears the canvas.

clear

()

Defined in ia\charts\CanvasBase.js:601

Clears the foreground 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

()

Defined in ia\charts\CanvasBase.js:678

Ends a map drag.

exportData

(
  • txt
)

Defined in ia\charts\CanvasBase.js:549

Exports as an image in a new page.

Parameters:

  • txt String

    Any text to go with image.

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

Defined in 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[]

Defined in 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

()

Defined in ia\charts\CanvasBase.js:702

Hides the chart.

mouseCoords

() ia.Point

Defined in ia\charts\CanvasBase.js:535

Returns the cursor position in data units.

Returns:

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

removeLayers

()

Defined in 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

()

Defined in ia\charts\CanvasBase.js:579

Clears and renders the map.

setBBox

(
  • bBox
)

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

Sets the bounding box.

Parameters:

show

()

Defined in ia\charts\CanvasBase.js:718

Shows the chart.

startDrag

()

Defined in ia\charts\CanvasBase.js:667

Starts a map drag.

toggle

()

Defined in ia\charts\CanvasBase.js:691

Toggles the chart visibility.

Properties

animationMode

Boolean

Defined in ia\charts\CanvasBase.js:105

Animation mode.

Default: false

backgroundContainer

JQUERY Element

Defined in ia\charts\CanvasBase.js:178

Containers the map canvas.

canvas

HTML Canvas

Defined in ia\charts\CanvasBase.js:122

The canvas.

canvas

HTML Canvas

Defined in ia\charts\CanvasBase.js:138

The foreground canvas for drawing elements on top of the map/chart.

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

container

JQUERY Element

Defined in ia\charts\CanvasBase.js:162

The container that holds the object.

context

HTML Canvas Context

Defined in ia\charts\CanvasBase.js:130

The canvas context.

context

HTML Canvas Context

Defined in ia\charts\CanvasBase.js:146

The foreground context for drawing elements on top of the map/chart.

datatip

ia.ChartTip

Defined in ia\charts\CanvasBase.js:154

The data tip.

embeddedInGoogleMaps

Boolean

Defined in ia\charts\CanvasBase.js:229

Indicates if embedded in google maps.

Default: false

foregroundContainer

JQUERY Element

Defined in ia\charts\CanvasBase.js:194

Containers selection / highlight canvas.

id

String

Defined in ia\charts\CanvasBase.js:114

The id.

isDraggable

Boolean

Defined in ia\charts\CanvasBase.js:238

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

Default: false

isVisible

Boolean

Defined in ia\charts\CanvasBase.js:202

The chart visibility.

Default: true

layerContainer

JQUERY Element

Defined in 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

Defined in 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

Defined in ia\charts\CanvasBase.js:211

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

Default: 0

mouseY

Number

Defined in ia\charts\CanvasBase.js:220

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

Default: 0