Every Klip must follow a standard structure expected by the Klipfolio Dashboard application as shown here, followed by more detailed description below:
<klip>
<!-- XML parameters block -->
<parameterName1>value</parameterName1>
<parameterName2>value</parameterName2>
...
<!-- Stylesheet block -->
<style>
...
</style>
<!-- JavaScript block [optional] -->
<klipscript>
...
</klipscript>
</klip>
The XML parameters block holds the settings that generally apply to the entire Klip, such as its title, version, refresh rate, and whether or not to display the columns' titles, just to name a few. The settings in this block are static and are applied when the Klip is loaded. We will be discussing a number of parameters in this document.
If you'd like to jump ahead, you can find the complete list of the XML parameters in Appendix B, Supported XML Parameters at the end of this document.
The stylesheet block contains the instructions for what parts of the incoming data to display in the Klip and how to display them. Using the standard CSS syntax, you specify "what parts of the incoming data to display" as selectors by identifying the XML tags from which to extract data, and "how to display them" is set using Klipfolio Dashboard's custom CSS properties:
selector {
property_1: value1;
property_2: value2;
}
All of the custom style properties that can be used in the Klips are listed in Appendix A, Supported CSS Properties at the end of this document.
Scripting can be used when you want to implement functions that are not covered by the XML and stylesheet options, such as adding custom menus to the Klip or handling a login process. A complete list of APIs available for use can be found online at http://developer.klipfolio.com/api/.
We will not delve extensively into scripting in this document; however, it is worth noting that you must have the onRefresh() function at a minimum if you have the <klipscript> block in your Klip at all.
