A wrapper for Studio API calls, as well as common functions for dynamic integrations.
params.type:String
The type of animation ('canvas','edge','gwd','custom')params.initObj:Object
An object to use for initialization and dynamic parsingparams.isDynamic:Boolean
Apply automatic dynamic parsingparams.onReady:Function
Callback funciton to run after API is initalized.
####USAGE:
FLASH CANVAS (NON-DYNAMIC):
Place spongeapi.js in the assets folder and include it at the top of your HTML document.
<script src="assets/spongeapi.js"></script>
Replace this line:
loader.loadManifest(lib.properties.manifest);
with this line:
spongeapi.init({type:'canvas',initObj:loader});
FLASH CANVAS (DYNAMIC):
Place spongeapi.js in the assets folder and include it at the top of your HTML document. A .js file containing test data may be included for local testing.
<script type="text/javascript" src="test_data.js"></script>
<script src="assets/spongeapi.js"></script>
Same as Non-Dynamic setup, with the addition of the 'isDynamic' parameter, set to true.
spongeapi.init({type:'canvas',initObj:loader,isDynamic:true});
EDGE ANIMATE (Dynamic):
-
Click the + in the Scripts sub-panel of the Library, select "Add JS File from Disk...", and add spongeapi.js and the optional test_data.js.
-
Add a new action to the stage for the 'compositionReady' event. (From the Code window, click the + next to the Stage), and add the following code:
spongeapi.init({type:'edge',initObj:sym,isDynamic:true});
GOOGLE WEB DESIGNER (Dynamic):
-
Add spongeapi.js to an assets folder relative to your GWD html document.
-
Open the animation in GWD, and switch to Code View.
-
Paste in the following code anywhere within the <head> tags:
<script type="text/javascript" src="assets/spongeapi.js"></script> -
Switch back to Design View and add an event to the first frame of the timeline. (Action > Custom > Add custom action), and add the following code:
var onReady = function() { spongeapi.initObj.classList.remove('gwd-pause-animation'); } this.classList.add('gwd-pause-animation'); spongeapi.init({type: 'gwd',initObj: this,isDynamic: true,onReady: onReady });
Open a landing page set up in Studio (standard or dynamic)
USAGE:
spongeapi.openLanding('Creative Landing Page')
Open a screen set up in Studio
USAGE:
spongeapi.openScreen('Screen Name')
Retrieve dynamic text property.
USAGE:
spongeapi.getDynamicText('dynamic_text_property')
Retrieve dynamic image url.
USAGE:
spongeapi.getDynamicImage('dynamic_image_property')
Update text & images with dynamic assets & properties matching class names to signal processor properties
Parse the flash library for dynamic images
USAGE:
Auto-parses any element instance names that match dynamic properties.
Parse the flash library for dynamic images
USAGE:
Rename bitmaps in the Flash library to match dynamic item text properties.
Automatically parses any movieclip instances on the main timeline whose name matches a dynamic text item property. These movieclip instances must contain a text instance named "txt".
Place
spongeapi.parseDynamicCanvasText()in handleComplete function, before stage.update(); in Canvas HTML file
Problem: You have a textfield named "ctaTxt" inside a movieclip named "ctaMC", and a dynamic text item property named "dynamic_cta_txt".
Solution: Add the following line on a frame inside the ctaMC:
this.ctaTxt.text = spongeapi.getDynamicText("dynamic_cta_txt");