Show:

ia.ComparisonPlotLayer Class

Extends ia.PlotLayer
Defined in: ia\charts\layers\ComparisonPlotLayer.js:1
Module: ia

The base class for comparison plot layers.

Constructor

ia.ComparisonPlotLayer

()

Defined in ia\charts\layers\ComparisonPlotLayer.js:1

Methods

_addToSelection

(
  • id
)
private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:785

Adds an id to the selection.

Parameters:

  • id String

    The id of the item.

_clearCanvas

(
  • c
  • ctx
)
private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:973

Clears a canvas.

Parameters:

  • c HTML Canvas

    The canvas to clear.

  • ctx HTML Canvas Context

    Its context.

_clearHighlightGraphics

() private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:986

Clears the highlight canvas.

_clearLabelGraphics

() private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:1008

Clears the label canvas.

_clearLayerGraphics

() private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:1023

Clears the layer canvases.

_clearSelectionGraphics

() private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:997

Clears the selection canvas.

_dispatchItemEvent

(
  • event
  • isHit
  • item
)
private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:590

The hit logic for items in the layer.

Parameters:

  • event ia.MapMouseEvent

    A ia.MapMouseEvent.

  • isHit Boolean

    Indicates if the item was hit.

  • item Object

    The item that was hit.

_drawItem

(
  • item
  • ctx
)
private

Inherited from ia.PlotLayer but overwritten in ia\charts\layers\ComparisonPlotLayer.js:145

Does the actual drawing.

Parameters:

  • item Object

    The item.

  • ctx HTML Canvas Context

    The context to render to.

_getCorrelation

() Object private

Inherited from ia.PlotLayer: ia\charts\layers\PlotLayer.js:583

Get correlation information.

Returns:

Object: An object (o) with the properties o.correlationCoeff, o.rSquare, o.gradient, o.intercept or null.

_hitTest

(
  • event
)
private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:500

Runs a hit test on the layer.

Parameters:

_itemEventHandler

(
  • event
)
private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:656

Handles default selection / highlight functionality.

Parameters:

  • event ia.ItemEvent

    An ia.ItemEvent dispatched by this layer.

_mapEventHandler

(
  • event
)
private

Inherited from ia.LayerBase but overwritten in ia\charts\layers\ItemLayer.js:475

Handles when to carry out hit tests.

Parameters:

_removeFromSelection

(
  • id
)
private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:772

Removes an id from the selection.

Parameters:

  • id String

    The id of the item.

_renderItem

(
  • item
)
private

Inherited from ia.PlotLayer but overwritten in ia\charts\layers\ComparisonPlotLayer.js:120

Renders the item to the given context.

Parameters:

  • item Object

    The item.

_setItemShape

(
  • item
)
private

Inherited from ia.PlotLayer but overwritten in ia\charts\layers\ComparisonPlotLayer.js:78

Sets an items dimensions.

Parameters:

  • item Object

    The item.

_setLabelStyle

() private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:419

Sets the label style.

_triggerRenderSelection

() private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:875

Triggers a selection render. Prevents over rendering which results in a frozen browser.

addCanvases

()

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:233

Adds drawing canvases for the layer when the layer is shown. This method was introduced to fix a bug a chrome when multiple canvases were affecting rendering. It basically reduces the number of unused canvases which are taking up memory.

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.

clear

()

Inherited from ia.LayerBase but overwritten in ia\charts\layers\ItemLayer.js:950

Clears all canvases in the layer.

clearHighlight

()

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:932

Clears all highlights.

clearItems

()

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:465

Clears the item list.

clearSelection

()

Inherited from ia.ItemLayer but overwritten in ia\charts\layers\ComparisonPlotLayer.js:113

Clears all selections.

createCanvas

() HTML Canvas

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:336

Creates a new canvas.

Returns:

HTML Canvas: The canvas.

dispatchEvent

(
  • event
)

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

Dispatch an event to the listeners.

Parameters:

  • event Object

    The event object.

getColorData

() Id:"eh11", name:"polwarth", value:2345, associate1:25

Inherited from ia.PlotLayer: ia\charts\layers\PlotLayer.js:166

Gets a data object for the color.

Returns:

Id:"eh11", name:"polwarth", value:2345, associate1:25: ["eh11"] ["eh12"]{id:"eh12", name:"morningside", value:4347, associate1:45} ["eh13"]{id:"eh13", name:"merchiston", value:2496, associate1:25}

getData

() Id:"eh11", name:"polwarth", value:2345, associate1:25

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:392

Gets a data object for the layer.

Returns:

Id:"eh11", name:"polwarth", value:2345, associate1:25: ["eh11"] ["eh12"]{id:"eh12", name:"morningside", value:4347, associate1:45} ["eh13"]{id:"eh13", name:"merchiston", value:2496, associate1:25}

getItem

(
  • id
)

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:454

Gets an item with the given id.

Parameters:

  • id String

    The id of the item to get.

getSizeData

() Id:"eh11", name:"polwarth", value:2345, associate1:25

Inherited from ia.PlotLayer: ia\charts\layers\PlotLayer.js:193

Gets a data object for the size.

Returns:

Id:"eh11", name:"polwarth", value:2345, associate1:25: ["eh11"] ["eh12"]{id:"eh12", name:"morningside", value:4347, associate1:45} ["eh13"]{id:"eh13", name:"merchiston", value:2496, associate1:25}

getVisible

() Boolean

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:132

Gets the visibility of the layer.

Returns:

Boolean: true/false.

getXData

() Id:"eh11", name:"polwarth", value:2345, associate1:25

Inherited from ia.PlotLayer: ia\charts\layers\PlotLayer.js:112

Gets a data object for the x-axis.

Returns:

Id:"eh11", name:"polwarth", value:2345, associate1:25: ["eh11"] ["eh12"]{id:"eh12", name:"morningside", value:4347, associate1:45} ["eh13"]{id:"eh13", name:"merchiston", value:2496, associate1:25}

getYData

() Id:"eh11", name:"polwarth", value:2345, associate1:25

Inherited from ia.PlotLayer: ia\charts\layers\PlotLayer.js:139

Gets a data object for the y-axis.

Returns:

Id:"eh11", name:"polwarth", value:2345, associate1:25: ["eh11"] ["eh12"]{id:"eh12", name:"morningside", value:4347, associate1:45} ["eh13"]{id:"eh13", name:"merchiston", value:2496, associate1:25}

hideTip

()

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:765

Hides the tip.

highlight

(
  • id
)

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:920

Hightlights an item.

Parameters:

  • id String

    The id of the item to highlight.

highlightItem

(
  • item
)

Inherited from ia.ItemLayer but overwritten in ia\charts\layers\PlotLayer.js:502

Highlights the item.

Parameters:

  • item Object

    The item.

hitItem

(
  • item
  • event
)

Inherited from ia.ItemLayer but overwritten in ia\charts\layers\ComparisonPlotLayer.js:161

Runs a hit test on an item.

Parameters:

isSelected

(
  • id
)

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:798

Checks if an id is selected

Parameters:

  • id String

    The id of the item.

loadSource

()

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:119

Loads the source data.

removeCanvases

()

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:292

Removes drawing canvases for the layer when the layer is hidden. This method was introduced to fix a bug a chrome when multiple canvases were affecting rendering. It basically reduces the number of unused canvases which are taking up memory.

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.LayerBase but overwritten in ia\charts\layers\ComparisonPlotLayer.js:46

Renders the data.

renderSelection

()

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:893

Renders the selection canvas.

select

(
  • id
)

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:825

Selects an item.

Parameters:

  • id String

    The id of the item.

selectAll

()

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:811

Selects all the items in the layer.

selectItem

(
  • item
)

Inherited from ia.ItemLayer but overwritten in ia\charts\layers\ComparisonPlotLayer.js:133

Selects the item.

Parameters:

  • item Object

    The item.

setColorData

() Id:"eh11", name:"polwarth", value:2345, associate1:25

Inherited from ia.PlotLayer: ia\charts\layers\PlotLayer.js:179

Sets a data object for the color.

Returns:

Id:"eh11", name:"polwarth", value:2345, associate1:25: ["eh11"] ["eh12"]{id:"eh12", name:"morningside", value:4347, associate1:45} ["eh13"]{id:"eh13", name:"merchiston", value:2496, associate1:25}

setData

(
  • value
)

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:405

Sets a data object for the layer.

Parameters:

  • value Id:"eh11", name:"polwarth", value:2345, associate1:25

    ["eh11"]
    ["eh12"]{id:"eh12", name:"morningside", value:4347, associate1:45}
    ["eh13"]{id:"eh13", name:"merchiston", value:2496, associate1:25}

setMap

(
  • map
  • map
)

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:175

Sets the map and canvas for the layer.

Parameters:

  • map ia.Map

    The map.

  • map HTML Element

    The container.

setSizeData

() Id:"eh11", name:"polwarth", value:2345, associate1:25

Inherited from ia.PlotLayer: ia\charts\layers\PlotLayer.js:206

Sets a data object for the size.

Returns:

Id:"eh11", name:"polwarth", value:2345, associate1:25: ["eh11"] ["eh12"]{id:"eh12", name:"morningside", value:4347, associate1:45} ["eh13"]{id:"eh13", name:"merchiston", value:2496, associate1:25}

setVisible

(
  • value
)

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:143

Sets the visibility of the layer.

Parameters:

  • value Boolean

    true/false.

setXData

(
  • value
)

Inherited from ia.PlotLayer: ia\charts\layers\PlotLayer.js:125

Sets a data object for the x-axis.

Parameters:

  • value Id:"eh11", name:"polwarth", value:2345, associate1:25

    ["eh11"]
    ["eh12"]{id:"eh12", name:"morningside", value:4347, associate1:45}
    ["eh13"]{id:"eh13", name:"merchiston", value:2496, associate1:25}

setYData

(
  • value
)

Inherited from ia.PlotLayer: ia\charts\layers\PlotLayer.js:152

Sets a data object for the y-axis.

Parameters:

  • value Id:"eh11", name:"polwarth", value:2345, associate1:25

    ["eh11"]
    ["eh12"]{id:"eh12", name:"morningside", value:4347, associate1:45}
    ["eh13"]{id:"eh13", name:"merchiston", value:2496, associate1:25}

showTip

(
  • item
  • event
)

Inherited from ia.ItemLayer but overwritten in ia\charts\layers\PlotLayer.js:556

Displays the tip for the passed item

Parameters:

  • item Object

    The map item.

  • event ia.ItemEvent

    An ia.ItemEvent.

tipFunction

(
  • item
)

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:744

Supplies the default text for the layer. This can be replaced with a custom function

Parameters:

  • item Object

    The map item.

unselect

(
  • id
)

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:842

Unselects an item.

Parameters:

  • id String

    The id of the item.

update

()

Inherited from ia.PlotLayer: ia\charts\layers\PlotLayer.js:220

Updates the data.

Properties

animationMode

Boolean

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:247

Animation mode.

Default: false

bBox

ia.BoundingBox

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:66

The bounding box for the layer.

canvas

HTML Canvas

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:50

The canvas associated with this layer.

context

HTML Canvas Context

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:58

The canvas context associated with this layer.

correlationInfo

Object

Inherited from ia.PlotLayer: ia\charts\layers\PlotLayer.js:84

Correlation info.

An object with the properties o.correlationCoeff, o.rSquare, o.gradient, o.intercept or null.

dataChanged

Boolean

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:374

Indicates the data has changed.

Default: false

dataField

String

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:365

Specifies the field of the data provider that provides the values.

Default: "value"

displayAll

Boolean

Defined in ia\charts\layers\ComparisonPlotLayer.js:28

Should all data be displayed.

Default: false

doHitTest

Boolean

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:321

Indicates whether to carry out a hit test.

Default: true

highlightCanvas

HTML Canvas

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:273

The highlight canvas associated with this layer.

highlightColor

String

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:348

The item highlight color.

Default: "#00ff00"

highlightContext

HTML Canvas Context

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:281

The highlight canvas context associated with this layer.

id

String

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:24

The id of the layer.

Default: ""

interactive

Boolean

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:92

Is selection and highlighting switched on.

Default: false

isComparison

Boolean

Defined in ia\charts\layers\ComparisonPlotLayer.js:37

Shortcut to avoid verbose code - referenced in ia.PlotLayer.

Default: true

isLoaded

Boolean

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:83

Indicates whether the layer is loaded.

Default: false

itemArray

Object

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:313

An array containing the layer items.

items

Associative Array

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:305

An associate array containing the layer items.

labelContext

HTML Canvas Context

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:265

The label canvas context associated with this layer.

map

ia.Map

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:42

The map associated with this layer.

name

String

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:33

The name of the layer.

Default: ""

pointSize

Number

Inherited from ia.PlotLayer: ia\charts\layers\PlotLayer.js:103

The point size.

Default: 6

selectionCanvas

HTML Canvas

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:289

The selection canvas associated with this layer.

selectionColor

String

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:339

The item selection color.

Default: "#ff0000"E

selectionContext

HTML Canvas Context

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:297

The selection canvas context associated with this layer.

selectionIds

String

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:357

An array of selected ids.

showCorrelationLine

Boolean

Inherited from ia.PlotLayer: ia\charts\layers\PlotLayer.js:94

Should the correlation line be displayed.

Default: false

showDataTips

Boolean

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:110

Are data tips displayed.

Default: trueE

showInLayerList

Boolean

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:74

Should the layer be displayed ina layer list.

Default: false

showLabels

Boolean

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:101

Show labels.

Default: false

style

Object

Inherited from ia.ItemLayer but overwritten in ia\charts\layers\ComparisonPlotLayer.js:19

The layer style.

Default: {fillStyle:'#ffffff', strokeStyle:'#888888', lineWidth:'2', lineJoin:'round'}

symbol

String

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:256

The label canvas associated with this layer.

Default: ia.Shape.SQUARE

tip

String

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:383

The data tip - used by charts that have fixed tip templates.

Default: ""

xDataField

String

Inherited from ia.PlotLayer: ia\charts\layers\PlotLayer.js:66

Specifies the field of the data provider that provides the x values.

Default: "value"

xMaxValue

Number

Inherited from ia.PlotLayer: ia\charts\layers\PlotLayer.js:42

The max x value.

xMinValue

Number

Inherited from ia.PlotLayer: ia\charts\layers\PlotLayer.js:34

The min x value.

yDataField

String

Inherited from ia.PlotLayer: ia\charts\layers\PlotLayer.js:75

Specifies the field of the data provider that provides the y values.

Default: "value"

yMaxValue

Number

Inherited from ia.PlotLayer: ia\charts\layers\PlotLayer.js:58

The max y value.

yMinValue

Number

Inherited from ia.PlotLayer: ia\charts\layers\PlotLayer.js:50

The min y value.