Differences

This shows you the differences between two versions of the page.

--- JavaScript_for_Automation [2016/02/22 11:51]
ComplexPoint [Assigning names to values and expressions:]
+++ JavaScript_for_Automation [2017/03/05 20:54]
peternlewis [Forum]
@@ Line 1: / Line 1: @@
 ====== Using JavaScript for Automation (JXA) with Keyboard Maestro ======
-=====Executing JavaScript from KM – which action ?=====
+===== Which Execute JavaScript Should You Use? =====
 JavaScript, once a language which ran only in web browsers, can now be used in a variety of environments. From Keyboard Maestro you can:
 . Run it in Chrome or Safari web pages ('browser JavaScript'), or
-. (in OS X Yosemite onwards) run it in Apple's osascript environment, for automating applications. ('JavaScript for Automation', or JXA, sometimes JSA in Apple's documentation).
+. Run it in Apple's osascript environment, for automating applications. ('JavaScript for Automation', or JXA, sometimes JSA in Apple's documentation), or
+. Run it in Custom HTML Prompt windows.
 [[https://developer.apple.com/library/mac/releasenotes/InterapplicationCommunication/RN-JavaScriptForAutomation/Articles/Introduction.html|JavaScript for Automation]] (JXA) is a more flexible alternative to AppleScript, with a richer set of default libraries for some basics like regexes and URL handling. Its equivalent of AppleScript 'records' is more forgiving and much easier to use. JXA is the same fast JavaScript Core language that Safari uses, but it is running in an osascript context:
@@ Line 19: / Line 20: @@
 the result will be a listing of all the pre-defined names in JXA's osascript environment.
-We can either run this directly from from one of KM's 'Execute a JavaScript for Automation' actions, or use an osascript command in an Execute Shell Script action.
+We can either run this directly from from one of Keyboard Maestro's 'Execute a JavaScript for Automation' actions, or use an osascript command in an Execute Shell Script action.
 {{:undefined:jxaactionthis.png?400|}}{{:undefined:jxashellactionthis.png?400|}}
@@ Line 27: / Line 28: @@
 {{:chromwinkeys.png?400|}}{{:undefined:jssafariactiondocument.png?400|}}
-Keyboard Maestro's 'Execute a JavaScript in Safari' and 'Execute a JavaScript in Google Chrome' actions are for interacting with web pages, whereas JXA is for automating OS X and OS X Applications.
+Keyboard Maestro’s [[action:Execute a JavaScript in Safari|Execute a JavaScript in Safari]] and [[action:Execute a JavaScript in Google Chrome|Execute a JavaScript in Google Chrome]] actions are for interacting with web pages, the [[action:Execute a JavaScript in Custom Prompt|Execute a JavaScript in Custom Prompt]] action is for interacting with Custom HTML Prompts, whereas JXA is for automating OS X and OS X Applications via the [[action:Execute a JavaScript For Automation|Execute a JavaScript For Automation]] action.
 =====The basics – AppleScript and JavaScript for Automation side by side=====
@@ Line 35: / Line 36: @@
 The simplest scripts evaluate an expression and return its value.
-**NB** KM Maestro can only make use of values returned as (or converted to) a string – a KM variable is always a string of some kind. This means that:
+**NB** Keyboard Maestro can only make use of values returned as (or converted to) a string – a Keyboard Maestro variable is always a string of some kind. This means that:
 - If the result of an evaluation is not a string (or something simple like a number, that can automatically be converted to a string), the action may puzzle you by appearing to produce no result.
 - It's a good idea to test your action code first in (El Capitan or Yosemite) Script Editor, which shows all results, whatever their type, including error messages.
-The following all return the same number to KM (in string format, and at a slightly higher level of precision – more decimal points – from JavaScript).
+The following all return the same number to Keyboard Maestro (in string format, and at a slightly higher level of precision – more decimal points – from JavaScript).
 ^ AppleScript    ^ JXA  ^
@@ Line 61: / Line 62: @@
 | <code applescript>count of documents of application "TextEdit"    </code> | <code javascript>Application("TextEdit").documents.length    </code> |
-====Assigning names to values and expressions:====
+====Assigning names to functions and procedures:====
 If we often need to calculate the [[https://en.wikipedia.org/wiki/Golden_ratio|Golden Ratio]], we can attach a name to its computation, and reuse it by that name. Nameable computations are called 'handlers' in AppleScript, and 'functions' in JavaScript.
-===Named 'handlers' and functions===
+===Named AS 'handlers' and JS functions===
 ^ AppleScript    ^ JXA  ^
@@ Line 238: / Line 239: @@
 .concat(["gamma", "delta"])
 // ["alpha", "beta", "gamma", "delta"]</code>|
-^ AppleScript join (user-defined)  ^ JavaScript join (built in) ^
+^ AppleScript join() (user-defined)  ^ JavaScript join() (built in) ^
 |<code applescript>join(" -> ", {"Sun", "Mon", "Tue"})
@@ Line 253: / Line 254: @@
 // "Sun -> Mon -> Tue
@@ Line 263: / Line 260: @@
 //  of JavaScript arrays
 </code>|
 ====Indexing by name – AS records and JS objects====
 to follow ...
-====Structuring computations – branching, repetition, and nested composition====
+====Structuring scripts – branching, nesting, mapping, filtering and reducing====
 to follow ...
@@ Line 273: / Line 272: @@
 to follow ...
+=====Accessing Keyboard Maestro Variables=====
+You can access Keyboard Maestro variables (7.1+) from JXA scripts using the Keyboard Maestro Engine application.
+<code javascript>
+var kme = Application("Keyboard Maestro Engine");
+kme.getvariable('Var');
+kme.setvariable('Var', { to: "Hello World!" });
+</code>
+JXA can get a list of all variables as described on the [forum](https://forum.keyboardmaestro.com/t/using-km-variables-in-yosemite-javascript-for-applications-jxa/889) and those methods also provide more convoluted ways to access variables for versions prior to 7.1.
 =====The Automation interface=====
@@ Line 303: / Line 314: @@
 to follow ...
+===== See Also =====
+----
+=== Actions ===
+* [[action:Execute a JavaScript For Automation|Execute a JavaScript For Automation]]
+* [[action:Execute a JavaScript in Custom Prompt|Execute a JavaScript in Custom Prompt]]
+* [[action:Execute a JavaScript in Google Chrome|Execute a JavaScript in Google Chrome]]
+* [[action:Execute a JavaScript in Safari|Execute a JavaScript in Safari]]
+* [[:Actions|See all Actions]]
+----
+==== Forum ====
+- [[https://forum.keyboardmaestro.com/t/using-km-variables-in-yosemite-javascript-for-applications-jxa/889|Using KM variables in Yosemite Javascript for Applications (JXA)]]
+- [[https://forum.keyboardmaestro.com/t/how-to-change-safari-web-inspector-font/3655|How to Change Safari Web Inspector Font]]
+- [[https://forum.keyboardmaestro.com/tags/jxa|Keyboard Maestro Forum topics about JavaScript for Automation]]

Keyboard Maestro Wiki

User Tools

Site Tools

Differences

Page Tools