Please turn on JavaScript. To find out how to do this visit the WebWise JavaScript guide.

An Item is an "event" on a Track.

Constructor

An Item cannot be directly instantiated. Instead the addItem method of glow.widgets.Timetable.Track must be used.

Properties

data

The Item's arbitrary data store

Type
Object

Description

This can be used to attach any arbitrary data to the Item, without the possibility of conflicting with the Item's designed properties.

Example

myItem.data.moreInfoUrl = "someUrl"; // used in the Item templare to provide a link to a "more info" page.
element

The HTML element that represents the item in the Timetable.

Type
glow.dom.Nodelist
end

The Item's end point

Type
Date | Number
id

The Item's id

Type
String
start

The Item's start point

Type
Date | Number
title

The Item's title

Type
String
track

The Item's parent Track

Methods

getContent

Gets the actual content of the Item for the Timetable to display

Synopsis

myItem.getContent();

Returns

glow.dom.NodeList

getFooter

Gets the actual content of if the Track footer (if any) for the Timetable to display

Synopsis

myItem.getFooter();

Returns

glow.dom.NodeList

getHeader

Gets the actual content of if the Track header (if any) for the Timetable to display

Synopsis

myItem.getHeader();

Returns

glow.dom.NodeList

inRange

Returns true if the Item overlaps the range with the given start and end points

Synopsis

myItem.inRange();

Returns

Boolean

Example

var item = myTrack.addItem("Item", 1, 2);

if (item.inRange(0, 1.5)) {
  // code here runs
}

if (item.inRange(3, 4)) {
  // code here doesn't run
}
setItemTemplate

Sets the Default Item template for the Timetable

Synopsis

myItem.setItemTemplate(template);

Parameters

template
Type
String | glow.dom.NodeList | function

The template to use

Returns

this

Documentation generated by JsDoc Toolkit 2.1.0 on Mon Jul 20 2009 14:55:32 GMT+0100 (BST)

BBC © 2014 The BBC is not responsible for the content of external sites. Read more.

This page is best viewed in an up-to-date web browser with style sheets (CSS) enabled. While you will be able to view the content of this page in your current browser, you will not be able to get the full visual experience. Please consider upgrading your browser software or enabling style sheets (CSS) if you are able to do so.