DigiGuide Logo

Home » Development Area » DigiGuide Script » API Index » API Contents

Summary

API Documentation for the DigiGuide Script System 2.0.

DigiGuide 8.3 contains 2 versions of the DigiGuide Script System. This documentation relates to version 2.0.

2.0 is much more type sensitive than previous versions. Many functions and properties would coerce values to and from Strings. 2.0, where it says, expects the type given.

DigiGuide 8.4 uses the Mozilla JavaScript engine 1.7. Read more at the links below:

http://developer.mozilla.org/en/docs/JavaScript

http://developer.mozilla.org/en/docs/Main_Page


Remarks

A marker template consists of the following process;

StepDescription
var template = new MarkerTemplate( "favourite", 1, true );Create a new template giving it a name, ID and whether the user is allowed to create Markers with it.
template.addSearchTerm( ":favourite" );Add a search term so people can search for all Markers using this template.
template.addKeyCommand( "ToggleFavourite", "onToggleFavourite" );Add a keyboard command so people can bind keyboard shortcuts to it or add toolbar buttons for it.
Add event handlersDefine event handlers for the template events such as onSetInitialDefaults, onProgrammeMenuShow, onInterfaceUpdate, onAlert.
app.getMarkerManager().addTemplate( template );Add the MarkerTemplate into the system so it can be used by DigiGuide.

View the API Index

(Last updated: July 04, 2008 15:18:10)