Development/Tutorials/Plasma/JavaScript/DataEngine - Revision history

Suy: /* Disconnecting Engines */ connectSource -> disconnectSource

2011-08-06T03:08:10Z

‎Disconnecting Engines: connectSource -> disconnectSource

Neverendingo: Text replace - "" to ""

2011-06-29T20:53:59Z

Text replace - "</code>" to "</syntaxhighlight>"

Neverendingo: Text replace - "`" to ""`


2011-06-29T20:39:33Z
Text replace - "<code bash>" to "<syntaxhighlight lang="bash">"

				
				
				
				
			
			← Older revision
			Revision as of 20:39, 29 June 2011
			
Line 99:
Line 99:
    
  To find out what engines are available and what sources they provide, run   To find out what engines are available and what sources they provide, run
− <code bash> + <syntaxhighlight lang="bash">
  plasmaengineexplorer   plasmaengineexplorer
  </code>   </code>
    
  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 <tt>time</tt> engine provides a "Timezone Continent" key, but in JavaScript you would access that as <tt>data.Timezone_Continent</tt> or <tt>data["Timezone_Continent"]</tt>.   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 <tt>time</tt> engine provides a "Timezone Continent" key, but in JavaScript you would access that as <tt>data.Timezone_Continent</tt> or <tt>data["Timezone_Continent"]</tt>.



Neverendingo: Text replace - "" to ""

2011-06-29T20:35:48Z
Text replace - "<code javascript>" to "<syntaxhighlight lang="javascript">"

				
				
				
				
			
			← Older revision
			Revision as of 20:35, 29 June 2011
			
Line 24:
Line 24:
  Our <tt>contents/code/main.js</tt> will have the following content:   Our <tt>contents/code/main.js</tt> will have the following content:
    
− <code javascript> + <syntaxhighlight lang="javascript">
  layout = new LinearLayout(plasmoid);   layout = new LinearLayout(plasmoid);
    
Line 42:
Line 42:
    
  In this case, <tt>plasmoid.dataUpdated</tt> gets called with <tt>"Local"</tt> as the first argument and the following object as the second argument (on my machine right now):   In this case, <tt>plasmoid.dataUpdated</tt> gets called with <tt>"Local"</tt> as the first argument and the following object as the second argument (on my machine right now):
− <code javascript> + <syntaxhighlight lang="javascript">
  {   {
       Timezone_Continent: 'Europe',        Timezone_Continent: 'Europe',
Line 66:
Line 66:
    
    
− <code javascript> + <syntaxhighlight lang="javascript">
  layout = new LinearLayout(plasmoid);   layout = new LinearLayout(plasmoid);
    
Line 81:
Line 81:
  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:   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:
    
− <code javascript>dataEngine("time").connectSource("Local", function(source, data) { print(source); } )</code> + <syntaxhighlight lang="javascript">dataEngine("time").connectSource("Local", function(source, data) { print(source); } )</code>
    
  or reference a function elsewhere in the script as seen here:   or reference a function elsewhere in the script as seen here:
    
    
− <code javascript>function printSourceName(source, data) { print(source); }   + <syntaxhighlight lang="javascript">function printSourceName(source, data) { print(source); }  
    
  dataEngine("time").connectSource("Local", printSourceName)</code>   dataEngine("time").connectSource("Local", printSourceName)</code>
Line 94:
Line 94:
  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.   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.
    
− <code javascript>dataEngine("time").connectSource("Local", plasmoid);</code> + <syntaxhighlight lang="javascript">dataEngine("time").connectSource("Local", plasmoid);</code>
    
  == Pro tip: plasmaengineexplorer ==   == Pro tip: plasmaengineexplorer ==



Nicolas17: syntax highlighting
2011-06-25T02:38:11Z
syntax highlighting

				
				
				
				
			
			← Older revision
			Revision as of 02:38, 25 June 2011
			
Line 24:
Line 24:
  Our <tt>contents/code/main.js</tt> will have the following content:   Our <tt>contents/code/main.js</tt> will have the following content:
    
− <code> + <code javascript>
  layout = new LinearLayout(plasmoid);   layout = new LinearLayout(plasmoid);
    
Line 42:
Line 42:
    
  In this case, <tt>plasmoid.dataUpdated</tt> gets called with <tt>"Local"</tt> as the first argument and the following object as the second argument (on my machine right now):   In this case, <tt>plasmoid.dataUpdated</tt> gets called with <tt>"Local"</tt> as the first argument and the following object as the second argument (on my machine right now):
− <code> + <code javascript>
  {   {
       Timezone_Continent: 'Europe',        Timezone_Continent: 'Europe',
Line 66:
Line 66:
    
    
− <code> + <code javascript>
  layout = new LinearLayout(plasmoid);   layout = new LinearLayout(plasmoid);
    
Line 81:
Line 81:
  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:   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:
    
− <code>dataEngine("time").connectSource("Local", function(source, data) { print(source); } )</code> + <code javascript>dataEngine("time").connectSource("Local", function(source, data) { print(source); } )</code>
    
  or reference a function elsewhere in the script as seen here:   or reference a function elsewhere in the script as seen here:
    
    
− <code>function printSourceName(source, data) { print(source); }   + <code javascript>function printSourceName(source, data) { print(source); }  
    
  dataEngine("time").connectSource("Local", printSourceName)</code>   dataEngine("time").connectSource("Local", printSourceName)</code>
Line 94:
Line 94:
  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.   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.
    
− <code>dataEngine("time").connectSource("Local", plasmoid);</code> + <code javascript>dataEngine("time").connectSource("Local", plasmoid);</code>
    
  == Pro tip: plasmaengineexplorer ==   == Pro tip: plasmaengineexplorer ==
    
  To find out what engines are available and what sources they provide, run   To find out what engines are available and what sources they provide, run
− <code> + <code bash>
  plasmaengineexplorer   plasmaengineexplorer
  </code>   </code>
    
  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 <tt>time</tt> engine provides a "Timezone Continent" key, but in JavaScript you would access that as <tt>data.Timezone_Continent</tt> or <tt>data["Timezone_Continent"]</tt>.   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 <tt>time</tt> engine provides a "Timezone Continent" key, but in JavaScript you would access that as <tt>data.Timezone_Continent</tt> or <tt>data["Timezone_Continent"]</tt>.



Aseigo at 10:18, 9 June 2011
2011-06-09T10:18:04Z


				
				
				
				
			
			← Older revision
			Revision as of 10:18, 9 June 2011
			
Line 20:
Line 20:
  In this example, we'll get the local time from the time engine.   In this example, we'll get the local time from the time engine.
    
− == Main script == + == Connecting Engines to plasmoid.dataUpdated ==
    
  Our <tt>contents/code/main.js</tt> will have the following content:   Our <tt>contents/code/main.js</tt> will have the following content:
Line 56:
Line 56:
  If we left off the last parameter to <tt>connectSource</tt> (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.   If we left off the last parameter to <tt>connectSource</tt> (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 === + == Connecting Engines to Plasma Interface Elements ==
  A number of Plasma interface elements support connecting DataEngines directly to them. These include:   A number of Plasma interface elements support connecting DataEngines directly to them. These include:
    
Line 77:
Line 77:
  While this is not as flexible as implementing <tt>plasmoid.dataUpdated</tt>, it can be a useful technique.   While this is not as flexible as implementing <tt>plasmoid.dataUpdated</tt>, it can be a useful technique.
    
− === Pro tip: plasmaengineexplorer === + == 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:
  +  
  + <code>dataEngine("time").connectSource("Local", function(source, data) { print(source); } )</code>
  +  
  + or reference a function elsewhere in the script as seen here:
  +  
  +  
  + <code>function printSourceName(source, data) { print(source); } 
  +  
  + dataEngine("time").connectSource("Local", printSourceName)</code>
  +  
  + == 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.
  +  
  + <code>dataEngine("time").connectSource("Local", plasmoid);</code>
  +  
  + == Pro tip: plasmaengineexplorer ==
    
  To find out what engines are available and what sources they provide, run   To find out what engines are available and what sources they provide, run



Dizney: dataEngine isnt a property on plasmoid
2010-02-21T00:34:46Z
dataEngine isnt a property on plasmoid

				
				
				
				
			
			← Older revision
			Revision as of 00:34, 21 February 2010
			
Line 72:
Line 72:
  layout.addItem(label);   layout.addItem(label);
    
− plasmoid.dataEngine("time").connectSource("Local", label, 500); + dataEngine("time").connectSource("Local", label, 500);
  </code>   </code>
    



Aseigo: /* Main script */
2010-02-02T17:35:28Z
‎Main script

				
				
				
				
			
			← Older revision
			Revision as of 17:35, 2 February 2010
			
Line 30:
Line 30:
  layout.addItem(label);   layout.addItem(label);
    
− plasmoid.dataUpdate = function(name, data) { + plasmoid.dataUpdated = function(name, data) {
  	label.text = data.Time;   	label.text = data.Time;
  }   }
    
− plasmoid.dataEngine("time").connectSource("Local", plasmoid, 500); + dataEngine("time").connectSource("Local", plasmoid, 500);
  </code>   </code>
    
− There are two new things in this plasmoid.  We've implemented <tt>plasmoid.dataUpdate</tt>, and connected a data engine source to it. + There are two new things in this plasmoid.  We've implemented <tt>plasmoid.dataUpdated</tt>, and connected a data engine source to it.
    
− If you connect a data engine source to <tt>object</tt>, when there is an update for that source the method <tt>object.dataUpdate</tt> is called with two arguments: the name of the source and a map containing the data provided by the source. + If you connect a data engine source to <tt>object</tt>, when there is an update for that source the method <tt>object.dataUpdated</tt> is called with two arguments: the name of the source and a map containing the data provided by the source.
    
− In this case, <tt>plasmoid.dataUpdate</tt> gets called with <tt>"Local"</tt> as the first argument and the following object as the second argument (on my machine right now): + In this case, <tt>plasmoid.dataUpdated</tt> gets called with <tt>"Local"</tt> as the first argument and the following object as the second argument (on my machine right now):
  <code>   <code>
  {   {
Line 75:
Line 75:
  </code>   </code>
    
− While this is not as flexible as implementing <tt>plasmoid.dataUpdate</tt>, it can be a useful technique. + While this is not as flexible as implementing <tt>plasmoid.dataUpdated</tt>, it can be a useful technique.
    
  === Pro tip: plasmaengineexplorer ===   === Pro tip: plasmaengineexplorer ===



Aseigo at 18:27, 27 November 2009
2009-11-27T18:27:42Z


				
				
				
				
			
			← Older revision
			Revision as of 18:27, 27 November 2009
			
Line 7:
Line 7:
  pre=[[../GettingStarted|Getting Started: Creating and running your first plasmoid in JavaScript]]|   pre=[[../GettingStarted|Getting Started: Creating and running your first plasmoid in JavaScript]]|
    
− next=[[../DataEngine|Now Playing: Advanced DataEngine Usage Example]]| + next=[[../NowPlaying|Now Playing: Advanced DataEngine Usage Example]]|
    
  reading=[[../API|JavaScript Plasmoid API reference]]   reading=[[../API|JavaScript Plasmoid API reference]]



Aseigo at 18:22, 27 November 2009
2009-11-27T18:22:51Z


				
				
				
				
			
			← Older revision
			Revision as of 18:22, 27 November 2009
			
Line 5:
Line 5:
  name=Getting Data|   name=Getting Data|
    
− pre=[[../GettingStarted|Getting Started: Creating and running your first plasmoid in JavaScript]] + pre=[[../GettingStarted|Getting Started: Creating and running your first plasmoid in JavaScript]]|
    
  next=[[../DataEngine|Now Playing: Advanced DataEngine Usage Example]]|   next=[[../DataEngine|Now Playing: Advanced DataEngine Usage Example]]|

@@ Line 94: / Line 94: @@
 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.
-<syntaxhighlight lang="javascript">dataEngine("time").connectSource("Local", plasmoid);</syntaxhighlight>
+<syntaxhighlight lang="javascript">dataEngine("time").disconnectSource("Local", plasmoid);</syntaxhighlight>
 == Pro tip: plasmaengineexplorer ==