Note

All code samples below refer to the skuid object.

In the v2 API, this object is not directly accessible when working within a browser console—or when referring to another Skuid page runtime.

If you are experiencing issues, use the skuid.runtime API to target the appropriate page context.

skuid.runtime¶

Used to establish a Skuid page context when working with API version 2. Each Skuid page API—listed in this API reference’s table of contents—is available with the page objects returned by these functions.

Functions¶

skuid.runtime.getPageMap()¶

Returns:	An object containing all Skuid pages within the current page, each as a separate object. Skuid pages will be listed as separate objects by their page name and their page ID.
Return type:	Object

skuid.runtime.getPageList()¶

Returns:	An array containing all Skuid pages within the current page, with each page as a separate index
Return type:	Array

skuid.runtime.getPage(pageNameOrId)¶

Arguments:	pageNameOrId (string) – The name or ID of the page to retrieve as context.
Returns:	The Skuid page and its various APIs
Return type:	Object