Show:

ia.FeatureLegend Class

Extends ia.DiscreteLegend
Defined in: ia\ui\FeatureLegend.js:1
Module: ia

A class for rendering a set of legend classes as a html table.

Constructor

ia.FeatureLegend

(
  • id
)

Defined in ia\ui\FeatureLegend.js:1

Parameters:

  • id String

    The id of the legend.

Methods

._dispatchItemEvent

() private

Inherited from ia.DiscreteLegend: ia\ui\DiscreteLegend.js:378

Dispatches item events.

_addMouseEvents

(
  • obj
)
private

Inherited from ia.DiscreteLegend: ia\ui\DiscreteLegend.js:253

Adds mouse events to the passed jquery object.

Parameters:

  • obj JQUERY Element

    The jquery object.

_triggerRender

() private

Defined in ia\ui\FeatureLegend.js:121

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

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.

clearHighlight

()

Inherited from ia.DiscreteLegend but overwritten in ia\ui\FeatureLegend.js:77

Clears all highlights.

clearSelection

()

Inherited from ia.DiscreteLegend but overwritten in ia\ui\FeatureLegend.js:110

Clears all selections.

dispatchEvent

(
  • event
)

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

Dispatch an event to the listeners.

Parameters:

  • event Object

    The event object.

hide

()

Inherited from ia.DiscreteLegend: ia\ui\DiscreteLegend.js:482

Hides the legend.

highlight

(
  • id
)

Inherited from ia.DiscreteLegend but overwritten in ia\ui\FeatureLegend.js:69

Highlights the legend class that contains the given id.

Parameters:

  • id String

    The id of the item.

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.DiscreteLegend but overwritten in ia\ui\FeatureLegend.js:42

Renders the legend.

renderCategoric

(
  • classes
)

Inherited from ia.DiscreteLegend: ia\ui\DiscreteLegend.js:139

Renders the categoric legend classes.

Parameters:

  • classes ia.Legend

    The legend classes.

renderLegend

(
  • classes
)

Inherited from ia.DiscreteLegend: ia\ui\DiscreteLegend.js:150

Renders the passed legend classes.

Parameters:

  • classes ia.Legend

    The legend classes.

renderNumeric

(
  • classes
)

Inherited from ia.DiscreteLegend: ia\ui\DiscreteLegend.js:128

Renders the numeric legend classes.

Parameters:

  • classes ia.Legend

    The legend classes.

select

(
  • id
)

Inherited from ia.DiscreteLegend but overwritten in ia\ui\FeatureLegend.js:84

Selects.

Parameters:

  • id String

    The id of the item.

show

()

Inherited from ia.DiscreteLegend: ia\ui\DiscreteLegend.js:492

Shows the legend.

unselect

(
  • id
)

Inherited from ia.DiscreteLegend but overwritten in ia\ui\FeatureLegend.js:97

Unselects.

Parameters:

  • id String

    The id of the item.

Properties

colorPalette

ia.ColorPalette

Defined in ia\ui\FeatureLegend.js:26

Specifies a color palette for the legend.

container

JQUERY Element

Inherited from ia.DiscreteLegend: ia\ui\DiscreteLegend.js:66

The container that holds the object.

geography

ia.Geography

Defined in ia\ui\FeatureLegend.js:34

A geography object.

highlightColor

String

Inherited from ia.DiscreteLegend: ia\ui\DiscreteLegend.js:58

The item highlight color.

id

String

Inherited from ia.DiscreteLegend: ia\ui\DiscreteLegend.js:33

The id.

interactive

Boolean

Inherited from ia.DiscreteLegend: ia\ui\DiscreteLegend.js:100

Indicates if the legend is interactive.

Default: true

isLegendComponent

Boolean

Inherited from ia.DiscreteLegend: ia\ui\DiscreteLegend.js:82

Indicates this is a legend component.

Default: true

layout

String

Inherited from ia.DiscreteLegend: ia\ui\DiscreteLegend.js:109

The layout of the legend.

Default: "vertical"

scrollBox

ia.ScrollBox

Inherited from ia.DiscreteLegend: ia\ui\DiscreteLegend.js:91

Indicates if theres a scrollbox attached.

Default: true

selectionColor

String

Inherited from ia.DiscreteLegend: ia\ui\DiscreteLegend.js:50

The item selection color.

style

Object

Inherited from ia.DiscreteLegend: ia\ui\DiscreteLegend.js:41

The style.

Default: {fillStyle:'#EFEFEF', strokeStyle:'#cccccc', lineWidth:'0.5', lineJoin:'miter'}

thematic

ia.Thematic

Inherited from ia.DiscreteLegend: ia\ui\DiscreteLegend.js:74

Specifies a thematic for the legend.