Gets a variety of properties of a specific ad. Since ad properties are changed over time, rerunning this function will return most updated properties. It mostly retrives information from the adConfig, but also from other areas within the EB istelf.

EB.getAdData(properties)

var didUserAlreadyClickthrough = EB.getAdData(["isClickOccur"]).isClickOccur;
console.log("ad has been clicked:", didUserAlreadyClickthrough);

Sets a variety of properties for the ad. Similar to EB.getAdData but for writing instead of reading.

EB.setAdData(properties)

// Save or change data to the ad object.
EB.setAdData({
    myName: "customData"
});

Use CSS "clip" to collapse/resize the given element with the specified dimensions.

EB.clip(elem, top, right, bottom, left)

None/Undefined.

//Clips an element called banner. 
var banner = document.getElementById("banner");
EB.clip(banner, 0, 300, 50, 0);

Removes CSS "clip" style from an element by applying the value rect(auto auto auto auto) to it.

EB.unclip(elem)

None/Undefined.

// Unclips an element called banner. 
var banner = document.getElementById("banner");
EB.unclip(banner);

Generates a string, in the correct format, to be applied to the CSS "clip" property.

EB.getClipTag(top, right, bottom, left)

// Get the correct clipping syntax and assign it to an element.
var myClip = EB.getClipTag(0, 300, 50, 0);

// returns "rect(50px 50px 50px 50px)" document.getElementById("banner").style.clip = myClip;

Indicates whether an element, or list of elements, has a specific class attribute, or list of such classes.

EB.hasClass(elems, classNames, requireAll)

var hasClass = EB.hasClass("banner", "notVisible", false);
if (hasClass) {
    EB.setClass("banner", "isVisible", false);
}

Sets one or more class attributes to one or more HTML elements.

EB.setClass (elems, classNames, shouldReplace)

None/Undefined.

var hasClass = EB.hasClass("banner", "notVisible", false);
if (hasClass) {
 EB.setClass("banner", "isVisible", false);
}

Removes a class attribute from an HTML element.

EB.removeClass(elems, classNames)

None/Undefined.

EB.removeClass("banner", "notVisible");

Retrieve the current value of a custom variable from the ad. Custom variables can be defined in the ad at runtime or in Sizmek Ad Suite (SAS) beforehand. For a list of name of the custom variables, see the Custom Variable Definitions in the build guides.

EB.getCustomVar(varName, def)

Assuming your ad has a custom variable named mdPanelWidth with a value of 600:

var myWidth1 = EB.getCustomVar("mdPanelWidth"); 

// "600" var myWidth2 = EB.getCustomVar("mdPanelWidth", "100");
// "600" - Default value has no effect because the value was already defined. 

Assuming your ad has a custom variable named mdAutoSnapType that has no predefined value:

var mySnap1 = EB.getCustomVar("mdAutoSnapType", 2);
 
// 2 var mySnap2 = EB.getCustomVar("mdAutoSnapType"); 
// undefined

Sets a custom variable. It can either override the current value or only set it when it does not exist (actually setting a default value).

EB.setCustomVar(varName, value, override)

None/Undefined.

Assuming your ad has a custom variable named mdCloseButtonShow with a value of true:

EB.setCustomVar("mdCloseButtonShow", false);
 // Does nothing because default value was already set to true. 

var show = EB.getCustomVar("mdCloseButtonShow"); 
// true 

EB.setCustomVar("mdCloseButtonShow", false, true);
// Use the override. 

var show = EB.getCustomVar("mdCloseButtonShow"); 
// false 

Returns an object with detailed information about the size and position of an element.

EB.getElementMetrics(element)

// get the page relative and viewport relative position of the "adContainer" 
element
var metrics = EB.getElementMetrics("adContainer");
var pageRelativeLeft = metrics.pageRelative.left;
var viewPortRelativeLeft = metrics.viewPortRelative.left;

Returns the highest number usable as a z-index by all browsers (except Firefox 2 and Safari 3). Some browsers can go higher, but this is the highest number that all browsers can use.

// set element style to highest available z-Index.
var element = document.getElementById("closeButton");
element.style.zIndex = EB.getHighestZIndex();

Injects an element to the DOM, according to the specified JSON object that represents the element attributes/children. The injection is done according to the specified method (injectionMethod) and using the specified element (refElem) as reference.

EB.inject(obj, injectionMethod, refElem) 

var tag = {
    tagName: "div",
    attributes: {
        dir: "ltr",
        id: "newDivTag",
        style: {
            display: "inline",
            position: "absolute",
            width: "100%"
        }
    },
    children: [{
        tagName: "iframe",
        attributes: {
            allowfullscreen: true,
            height: 1,
            id: "newIframeTag",
            style: {
                width: "1px",
                height: "1px"
            }
        }
    }]
};
//add tag to the page and append it to a div with an id "adContainer" 

var el = document.getElementById("adContainer");
EB.inject(tag, EBG.Adaptors.InjectionMethod.APPEND, el);

Retrieves top left coordinate (positioning) for the resource. Position is relative to the creative iFrame window.

EB.getPositioningByElement(element)

var el = document.getElementById("adContainer");
var elementPosition = EB.getPositioningByElement(el); 

// returns Object e.g. {X: 367, Y: -32}. 

Retrieves top left coordinate (positioning) for the resource. Position is relative to the creative iFrame window.

EB.getPositioningById(elementId)

var position = EB.getPositioningById("adContainer");

// returns Object e.g. {X: 367, Y: -32}

Removes an element from the page or DOM.

EB.removeElement(elementId)

None/Undefined.

EB.removeElement("adContainer");

Determines the orientation of the creative iFrame window (not the parent page window) - either portrait (tall) or landscape (wide) aspect ratio.

This method gets a specific style property of a DOM element.

EB.getStyle(elem, style, inline)

var el = document.getElementById("adContainer");
var style = EB.getStyle(el, "position", false);

// returns the position style (e.g. "absolute") of the adContainer element.

Sets the style property of the specified element with given style property object. If the element does not accept a specified style property, the method will try to find a matching browser-prefixed equivalent to set instead. For the prefix-matching to work, use camelCase or InitialCaps property names, not kebab-case.

EB.setStyle(elem, style, usePrefix)

// Set width and height style to an element called adContainer. 

var el = document.getElementById("adContainer");
EB.setStyle(el, {
    width: "100px",
    height: "50px"
}, false);

Similar to EB.setStyle, but allows you to pass an array of elements to set the same style to.

EB.setStyleToElems(elems, style)

// set the same styles to multiple elements. 

var el = document.getElementById("adContainer");
var el2 = document.getElementById("video");
EB.setStyleToElems([el, el2], {
    width: "200px",
    height: "50px"
}, false);

Gets the width and height of the creative iFrame. Note that inside the iFrame, viewport size, page size, and window size are all the same.

This method tells whether a specific custom interaction has been configured to close ad parts (collapse all panels).

MDX2.0

Sizmek Ad Suite (SAS)

EB.willCloseAdParts(interactionName)

//Trigger an animation, but only if the interaction will not close the panel if 

(!EB.willCloseAdParts("myInteraction") {
        startMyAnim();
    }