Show:

ia.Panel Class

Extends ia.Widget
Defined in: ia\widgets\Panel.js:1
Module: ia

Creates a panel widget.

Constructor

ia.Panel

(
  • id
  • title
)

Defined in ia\widgets\Panel.js:1

Parameters:

  • id String

    The id for the widget.

  • title String

    The widget title.

Methods

_build

() private

Defined in ia\widgets\Panel.js:64

Builds the panel.

_size

() private

Defined in ia\widgets\Panel.js:429

Resizes the panel elements when the panel size or header text have changed. This is the only way at the moment to make sure the content doesnt overflow its container.

addCssClass

(
  • cssClass
)

Inherited from ia.Widget: ia\widgets\Widget.js:422

Adds a css class to the widget.

Parameters:

  • cssClass String

    The class to add eg. "ia-title-text".

append

(
  • obj
)

Defined in ia\widgets\Panel.js:373

Appends an element to the panel content area.

Parameters:

  • obj JQUERY Element

    The jquery object.

appendToFooter

(
  • obj
)

Defined in ia\widgets\Panel.js:384

Appends an element to the panel footer area.

Parameters:

  • obj JQUERY Element

    The jquery object.

closeable

(
  • isCloseable
)

Defined in ia\widgets\Panel.js:261

Sets or gets if its closeable.

Parameters:

  • isCloseable Boolean

    true/false.

closeFunction

(
  • p
)

Defined in ia\widgets\Panel.js:282

The close function.

Parameters:

exportable

(
  • isExportable
)

Defined in ia\widgets\Panel.js:293

Sets or gets if its exportable.

Parameters:

  • isExportable Boolean

    true/false.

exportFunction

()

Defined in ia\widgets\Panel.js:314

The export function.

hasSettings

(
  • hasSettings
)

Defined in ia\widgets\Panel.js:233

Sets or gets if it has settings.

Parameters:

  • hasSettings Boolean

    true/false.

height

(
  • value
)

Inherited from ia.Widget: ia\widgets\Widget.js:99

Get/Set the height.

Parameters:

  • value Number

    The value (% or px for images).

hide

()

Inherited from ia.Widget: ia\widgets\Widget.js:294

Hides the widget.

maximize

()

Inherited from ia.Widget: ia\widgets\Widget.js:190

Maximizes the component.

onclick

(
  • fnc
  • target
)

Inherited from ia.Widget: ia\widgets\Widget.js:380

Set the function to call when the widget is clicked.

Parameters:

  • fnc Function

    Can be a javascript function or a src containing a link or a function such as "javascript:iaToggle(dataExplorer)".

  • target String

    The url target - used in conjunction with the onclick event. "blank" for a new window or tab, "self" for the current page, top for the topmost frame container, or "parent" for the parent of the current frame container. Default is "blank".

popup

(
  • isPopup
)

Defined in ia\widgets\Panel.js:207

Sets or gets if its a popup - closes on a click outside the panel.

Parameters:

  • isPopup Boolean

    true/false.

resize

()

Defined in ia\widgets\Panel.js:353

Resizes the panel.

resizeable

(
  • isResizeable
)

Defined in ia\widgets\Panel.js:321

Sets or gets if its resizeable.

Parameters:

  • isResizeable Boolean

    true/false.

resizeFunction

(
  • p
)

Defined in ia\widgets\Panel.js:342

The resize function.

Parameters:

restore

()

Inherited from ia.Widget: ia\widgets\Widget.js:179

Restores to the current x, y, width, height.

setDimensions

(
  • x
  • y
  • width
  • height
  • xAnchor
  • yAnchor
)

Inherited from ia.Widget: ia\widgets\Widget.js:161

Sets the dimensions.

Parameters:

  • x Number

    The x position.

  • y Number

    The y position.

  • width Number

    The width

  • height Number

    The height.

  • xAnchor String

    The anchor x - 'left' or 'right'.

  • yAnchor String

    The anchor y - 'top' or 'bottom'.

setPosition

(
  • x
  • y
  • xAnchor
  • yAnchor
)

Inherited from ia.Widget: ia\widgets\Widget.js:218

Sets the position.

Parameters:

  • x Number

    The x position.

  • y Number

    The y position.

  • xAnchor String

    The anchor x - 'left' or 'right'.

  • yAnchor String

    The anchor y - 'top' or 'bottom'.

setSize

(
  • width
  • height
)

Inherited from ia.Widget: ia\widgets\Widget.js:200

Sets the dimensions.

Parameters:

  • width Object

    The width.

  • height Object

    The height.

settingsFunction

()

Defined in ia\widgets\Panel.js:254

The settings function.

show

()

Inherited from ia.Widget: ia\widgets\Widget.js:284

Shows the widget.

text

(
  • text
)

Defined in ia\widgets\Panel.js:416

Sets the content text.

Parameters:

  • text String

    The text.

title

(
  • text
)

Defined in ia\widgets\Panel.js:395

Sets the title text.

Parameters:

  • text String

    The text.

toggle

()

Inherited from ia.Widget: ia\widgets\Widget.js:274

Toggles the visibility.

tooltip

(
  • tip
)

Inherited from ia.Widget: ia\widgets\Widget.js:341

Sets the tooltip.

Parameters:

  • tip String

    The tooltip text.

update

(
  • c
)

Defined in ia\widgets\Panel.js:447

Updates the component configuration.

Parameters:

updateWidget

(
  • c
)

Inherited from ia.Widget: ia\widgets\Widget.js:433

Updates the widget configuration.

Parameters:

visible

(
  • vis
)

Inherited from ia.Widget: ia\widgets\Widget.js:304

Sets or gets the visibility.

Parameters:

  • vis Boolean

    The visibility.

width

(
  • value
)

Inherited from ia.Widget: ia\widgets\Widget.js:85

Get/Set the width.

Parameters:

  • value Number

    The value (% or px for images).

x

(
  • value
)

Inherited from ia.Widget: ia\widgets\Widget.js:57

Get/Set the x location.

Parameters:

  • value Number

    The value (%).

xAnchor

(
  • value
)

Inherited from ia.Widget: ia\widgets\Widget.js:133

Get/Set the anchor x.

Parameters:

  • value Number

    The value

y

(
  • value
)

Inherited from ia.Widget: ia\widgets\Widget.js:71

Get/Set the y location.

Parameters:

  • value Number

    The value (%).

yAnchor

(
  • value
)

Inherited from ia.Widget: ia\widgets\Widget.js:147

Get/Set the anchor x.

Parameters:

  • value Number

    The value

zIndex

(
  • value
)

Inherited from ia.Widget: ia\widgets\Widget.js:113

Get/Set the z index.

Parameters:

  • value Number

    The value

Properties

container

JQUERY Element

Inherited from ia.Widget: ia\widgets\Widget.js:22

The container that holds the object.

content

JQUERY Element

Defined in ia\widgets\Panel.js:48

The panel content container.

contentText

JQUERY Element

Defined in ia\widgets\Panel.js:56

Allows text to be placed in the panel content.

header

JQUERY Element

Defined in ia\widgets\Panel.js:32

The panel header.

id

String

Inherited from ia.Widget: ia\widgets\Widget.js:39

The id.

Default: ""

name

String

Inherited from ia.Widget: ia\widgets\Widget.js:48

The name.

Default: ""

rescale

Boolean

Inherited from ia.Widget: ia\widgets\Widget.js:30

Resale.

Default: true