Show:

ia.CartesianSpace Class

Extends ia.EventDispatcher
Defined in: ia\geom\CartesianSpace.js:1
Module: ia

Maps a data space to a pixel space and vice versa.

The data space is defined by a {@link ia.BoundingBox}.

The pixel space is defined by the canvasX, canvasY, canvasWidth and canvasHeight properties.

Pixel coords are relative to the top left corner of the view. Data coords are relative to the bottom left corner of the view.

The data space may be adjusted to maintain its aspect ratio by setting the value of maintainAspectRatio to true.

Constructor

ia.CartesianSpace

(
  • [canvasX=0]
  • [canvasY=0]
  • [canvasWidth=0]
  • [canvasHeight=0]
)

Defined in ia\geom\CartesianSpace.js:1

Parameters:

  • [canvasX=0] Number optional

    The x-coord of the pixel space.

  • [canvasY=0] Number optional

    The y-coord of the pixel space.

  • [canvasWidth=0] Number optional

    The width of the pixel space.

  • [canvasHeight=0] Number optional

    The height of the pixel space.

Methods

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.

adjustBBox

(
  • bb
)

Defined in ia\geom\CartesianSpace.js:352

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

Parameters:

adjustY

(
  • bb
)

Defined in ia\geom\CartesianSpace.js:396

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

Parameters:

commitChanges

()

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

getBBox

() ia.BoundingBox

Defined in ia\geom\CartesianSpace.js:111

Gets the bounding box.

Returns:

ia.BoundingBox: The bounding box.

getDataBBox

(
  • rect
)
ia.BoundingBox

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

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

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

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

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

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

getPixelHeight

(
  • y
)
Number

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

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

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

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

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

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

removeListener

(
  • obj
)

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

Removes all event listeners for the given object.

Parameters:

  • obj Object

    The object.

setBBox

(
  • bBox
)

Defined in ia\geom\CartesianSpace.js:122

Sets the bounding box.

Parameters:

Properties

canvasHeight

Number

Defined in ia\geom\CartesianSpace.js:67

The pixel height.

Default: 0

canvasWidth

Number

Defined in ia\geom\CartesianSpace.js:58

The pixel width.

Default: 0

canvasX

Number

Defined in ia\geom\CartesianSpace.js:40

The pixel x-position.

Default: 0

canvasY

Number

Defined in ia\geom\CartesianSpace.js:49

The pixel y-position.

Default: 0

maintainAspectRatio

Boolean

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

maxZoom

Number

Defined in ia\geom\CartesianSpace.js:85

The maximum extent.

Default: -1

minZoom

Number

Defined in ia\geom\CartesianSpace.js:76

The minimum extent.

Default: -1