Development/Tutorials/Plasma4/JavaScript/DataEngine

Getting Data

Tutorial Series	JavaScript Plasmoids
Previous	Getting Started: Creating and running your first plasmoid in JavaScript
What's Next	Now Playing: Advanced DataEngine Usage Example
Further Reading	JavaScript Plasmoid API reference

Abstract

Now that you've seen how to create a JavaScript plasmoid, we're going to move on to getting data into it.

Plasma has a data abstraction mechanism called DataEngines. You can ask for a DataEngine by name, request a source from it (again, by name) and you get data back from it, either at fixed intervals or whenever it is updated by the DataEngine internally. The data is a map (which is the same as an object in JavaScript) of string keys to data.

In this example, we'll get the local time from the time engine.

Connecting Engines to plasmoid.dataUpdated

Our contents/code/main.js will have the following content:

layout = new LinearLayout(plasmoid);

label = new Label();
layout.addItem(label);

plasmoid.dataUpdated = function(name, data) {
	label.text = data.Time;
}

dataEngine("time").connectSource("Local", plasmoid, 500);

There are two new things in this plasmoid. We've implemented plasmoid.dataUpdated, and connected a data engine source to it.

If you connect a data engine source to object, when there is an update for that source the method object.dataUpdated is called with two arguments: the name of the source and a map containing the data provided by the source.

In this case, plasmoid.dataUpdated gets called with "Local" as the first argument and the following object as the second argument (on my machine right now):

{
    Timezone_Continent: 'Europe',
    Offset: 3600,
    Timezone: 'Europe/London',
    Time: new Date('Sun May 17 20:06:20 2009 GMT+0100'),
    Timezone_City: 'Guernsey'
}

The last line of the script does the actual connection. We select the "time" data engine and request the "Local" source from it, which provide the local time. We tell it to connect to the plasmoid object and force an update every 500ms (every half a second).

If we left off the last parameter to connectSource (ie: didn't provide an update interval), then the source would be updated when there was new data available. This doesn't make much sense for a clock, where the time is continually changing, so would actually get no updates at all if you did this. However, there are other data engines (such as the "soliddevice" engine) where you only want to be notified when something changed, and in this case you would leave off the update interval.

Connecting Engines to Plasma Interface Elements

A number of Plasma interface elements support connecting DataEngines directly to them. These include:

• Label
• Meter
• TextEdit

With these widgets, one can simply direct the DataEngine to update the widget directly and it will attempt to display the data. So in our example we could also write it as:

layout = new LinearLayout(plasmoid);

label = new Label();
layout.addItem(label);

dataEngine("time").connectSource("Local", label, 500);

While this is not as flexible as implementing plasmoid.dataUpdated, it can be a useful technique.

Connecting Engines to Arbitrary Functions

It is also possible to connect DataEngines to any Javascript function by passing it in as an argument to connectSource. The function can be "in-line" such as in this example:

dataEngine("time").connectSource("Local", function(source, data) { print(source); } )

or reference a function elsewhere in the script as seen here:

function printSourceName(source, data) { print(source); } 

dataEngine("time").connectSource("Local", printSourceName)

Disconnecting Engines

To disconnect a source, use the disconnectSource function from a DataEngine object. disconnectSource is symmetrical to connectSource and takes the name of the source and the target. The only difference is that disconnectSource does not take an optional time parameter as connectSource does.

dataEngine("time").disconnectSource("Local", plasmoid);

Pro tip: plasmaengineexplorer

To find out what engines are available and what sources they provide, run

plasmaengineexplorer

You can choose from any of the installed data engines and request a source, including setting an update interval. Just remember that when you are reading the data in JavaScript, spaces in the keys provided by the sources are replaced by underscores. So each source in the time engine provides a "Timezone Continent" key, but in JavaScript you would access that as data.Timezone_Continent or data["Timezone_Continent"].