docs

ad-animation

Package Contents

SpritePlayer

• .onComplete : function
• .onLoop : function
• .sprite : Graphic.Sprite
• .loop : boolean | number
• .frame : number
• .targetFrame : number
• .speed : number
• .play()
• .pause()
• .stop()
• .clear()
• .render()
• .reverse()
• .forward()

TweenPromise

• .to(target, time, vars) ⇒ Promise
• .from(target, time, vars) ⇒ Promise
• .fromTo(target, time, fromVars, toVars) ⇒ Promise

ad-assets

Package Contents

ad-canvas

Package Contents

CanvasBlendMode

• .NONE : string
• .UNDER : string
• .SOURCE_IN : string
• .SOURCE_OUT : string
• .SOURCE_ATOP : string
• .DEST_IN : string
• .DEST_OUT : string
• .DEST_ATOP : string
• .XOR : string
• .COPY : string
• .ADD : string
• .DARKEN : string
• .LIGHTEN : string
• .OVERLAY : string
• .MULTIPLY : string
• .SCREEN : string
• .DODGE : string
• .BURN : string
• .HARD : string
• .SOFT : string
• .DIFFERENCE : string
• .EXCLUSION : string
• .HUE : string
• .SATURATION : string
• .COLOR : string
• .LUMINOSITY : string

CanvasBlur

• .set(obj)

CanvasCircle

• new CanvasCircle(circObj)
• .x : number
• .y : number
• .width : number
• .radius : number
• .rotation : number
• .alpha : number
• .scale : number
• .scaleX : number
• .scaleY : number
• .blendMode : number
• .visible : boolean
• .transformOrigin : string
• .fill : string
• .strokeFill : string
• .strokeWidth : number
• .strokeCap : string
• .strokeJoin : string
• .strokePosition : string
• .strokeDashSize : number
• .strokeDashGap : number
• .strokeDashOffset : number
• .shadowColor : string
• .shadowBlur : number
• .shadowAngle : number
• .shadowDistance : number
• .id : string

CanvasColoring

• .hue(obj)
• .saturation(obj)
• .contrast(obj)
• .tint(obj)
• .transform(obj)
• .invert(obj)

CanvasDisplaceChannel

• .RED : number
• .GREEN : number
• .BLUE : number
• .ALPHA : number

CanvasDisplacementMap

• new CanvasDisplacementMap(imgObj)
• .source : CanvasDrawer | UICanvas | canvas
• .map : CanvasDrawer | UICanvas | canvas
• .target : CanvasDrawer | UICanvas | canvas
• .x : number
• .y : number
• .scaleX : number
• .scaleY : number
• .channelX : CanvasDisplaceChannel | number
• .channelY : CanvasDisplaceChannel | number
• .draw()

CanvasDrawer

• new CanvasDrawer(arg)
• .canvas : UICanvas
• .ctx
• .clearCanvas : boolean
• .qualityScale : number
• .elements : object
• .elementsLength : number
• .width : number
• .height : number
• .removeElement(target)
• .removeAllElements()
• .clear()
• .update()

CanvasElement

• new CanvasElement()

CanvasImage

• new CanvasImage(imgObj)
• .x : number
• .y : number
• .width : number
• .sourceX : number
• .sourceY : number
• .sourceW : number
• .sourceH : number
• .height : number
• .rotation : number
• .alpha : number
• .scale : number
• .scaleX : number
• .scaleY : number
• .blendMode : number
• .visible : number
• .transformOrigin : string
• .shadowColor : string
• .shadowBlur : number
• .shadowAngle : number
• .shadowDistance : number
• .id : string

CanvasLineTo

• .MOVE : string
• .LINE : string
• .QUAD : string
• .BEZIER : string
• .ARC : string

CanvasPath

• new CanvasPath(pathObj)
• .x : number
• .y : number
• .rotation : number
• .alpha : number
• .scale : number
• .scaleX : number
• .scaleY : number
• .blendMode : number
• .visible : boolean
• .length : number
• .transformOrigin : string
• .fill : string
• .strokeFill : string
• .strokeWidth : number
• .strokeCap : string
• .strokeJoin : string
• .strokePosition : string
• .strokeDashSize : number
• .strokeDashGap : number
• .strokeDashOffset : number
• .shadowColor : string
• .shadowBlur : number
• .shadowAngle : number
• .shadowDistance : number
• .id : string
• .width : number
• .height : number

CanvasRect

• new CanvasRect(rectObj)
• .x : number
• .left : number
• .y : number
• .top : number
• .width : number
• .height : number
• .rotation : number
• .alpha : number
• .opacity : number
• .scale : number
• .scaleX : number
• .scaleY : number
• .blendMode : number
• .visible : number
• .transformOrigin : string
• .fill : string
• .strokeFill : string
• .strokeWidth : number
• .strokeCap : string
• .strokeJoin : string
• .strokePosition : string
• .strokeDashSize : number
• .strokeDashGap : number
• .strokeDashOffset : number
• .shadowColor : string
• .shadowBlur : number
• .shadowAngle : number
• .shadowDistance : number
• .id : string

CanvasShape

• new CanvasShape()

CanvasSprite

• new CanvasSprite()

CanvasText

• new CanvasText(textObj)
• .x : number
• .left : number
• .y : number
• .top : number
• .rotation : number
• .alpha : number
• .opacity : number
• .scale : number
• .scaleX : number
• .scaleY : number
• .blendMode : number
• .visible : boolean
• .transformOrigin : string
• .fontFamily : string
• .fontSize : number
• .lineHeight : number
• .maxWidth : number
• .alignText : string
• .fill : string
• .strokeFill : string
• .strokeWidth : number
• .strokeJoin : string
• .strokePosition : string
• .strokeDashSize : number
• .strokeDashGap : number
• .strokeDashOffset : number
• .shadowColor : string
• .shadowBlur : number
• .shadowAngle : number
• .shadowDistance : number
• .id : string
• .width : number
• .height : number

CanvasTexture

• .makeLinearGradient(args)
• .makeRadialGradient(args)
• .makePattern(args)

CanvasTiling

• .X : string
• .Y : string
• .XY : string
• .NONE : string

CanvasTweener

• .tween : object
• .init(target)
• .start(args)
• .kill()

CanvasUtils

• .getImageData(source)
• .setImageData(target, data)

ad-control

Package Contents

Core

• .init(fbaLoader)
• .loadDynamic()

CssManager

• .init()
• .setDebugLevel(level)
• .setDebugFilter(filter)

Expandable

• .init()
• .collapse()
• .expand()
• .hasUserInteracted() ⇒ boolean

ExpandableDcs

ImageManager

• .addToLoad(file, arg) ⇒ string
• .addLoader(loader)
• .get(imageId) ⇒ Image
• .available(imageId) ⇒ boolean
• .load(callback, onFail)
• .addToDictionary()

SheetManager

• .createGlobalNode(nodeId, styles)
• .addClass(target, className)
• .removeClass(target, className)

ad-dates

Package Contents

DateFormatter

• .setLanguage()
• .addLanguage()
• .getLabels() ⇒ TzDate | Date
• .getNumericSuffixFor() ⇒ String
• .format() ⇒ String

DateManager

• .init()
• .getNow() ⇒ TzDate

DateSchedule

• new DateSchedule(arg)
• .target : TzDate
• .current : object
• .currentDate : TzDate
• .currentLabel : String
• .currentIndex : Number
• .next : object
• .nextDate : TzDate
• .nextLabel : String
• .nextIndex : Number
• .isLive : Boolean
• .isComplete : Boolean
• .addDate(tzDate, label, callback)
• .print() ⇒
• .getDates() ⇒ Array

DateUtils

• .getTimeDifference() ⇒ Object
• .adjust() ⇒ TzDate | Date
• .isPast(date, context) ⇒ boolean

RecurringSchedule

• new RecurringSchedule()
• .currentSchedule : object
• .current : object
• .currentDate : TzDate
• .currentLabel : String
• .print()

Timezone

• .get() ⇒ string

TzDate

• new TzDate()
• .outputTimezone : object | string | number
• .clone() ⇒ TzDate
• .getHoursIn() ⇒ number
• .format() ⇒ String
• .getIn() ⇒ TzDate
• .print() ⇒ string
• .toFullDateTime() ⇒ string
• .toSimpleDate() ⇒ string
• .toDate() ⇒ string
• .toDateTime() ⇒ string
• .toSimpleDateTime() ⇒ string
• .toTime() ⇒ string
• .toSimpleTime() ⇒ string
• .toMeridiem() ⇒ string
• .toShortestTime() ⇒ string

ad-entry

Package Contents

ad-events

Package Contents

FrameRate

• .register(from, handler, fps)
• .unregister(from, handler, fps)
• .pause(arguments)
• .resume(arguments)
• .secondsAsFrames(sec)

Gesture

• .add/addEventListener(target, name, handler)
• .remove/removeEventListener(target, name, handler)
• .disable(target)
• .disableChildren(target)
• .enable(target)
• .enableChildren(target)

GestureEvent

• .OVER : string
• .OUT : string
• .MOVE : string
• .PRESS : string
• .RELEASE : string
• .CLICK : string
• .DRAG : string
• .DRAG_START : string
• .DRAG_STOP : string
• .SWIPE : string
• .Event(name, mouseGlobalX, mouseGlobalY, mouseLocalX, mouseLocalY, elementX, elementY, distanceX, distanceY, velocityX, velocityY)
• .stop(event)

UIEvent

• .ENABLED : string
• .RESIZE : string
• .SLIDER_UPDATE : string

ad-external

Package Contents

• Device

• new Device()
• .agentString : string
• .brand : string
• .product : string
• .type : string
• .os : string
• .osVersion : string
• .browser : string
• .browserVersion : string
• .pixelRatio : string
• .orientation : string
• .dimensions : object
• .init()

ad-geom

Package Contents

Matrix2D

• new Matrix2D()
• .clear()
• .rotate(radians) ⇒ Matrix2D
• .rotate(x, y) ⇒ Matrix2D
• .skew(ax, ay) ⇒ Matrix2D
• .translate(x, y) ⇒ Matrix2D
• .getCss() ⇒ String
• .getX() ⇒ Number
• .getY() ⇒ Number
• .setFromCss(matrixString)

Matrix3D

• new Matrix3D()
• .clear()
• .rotateX(radians) ⇒ Matrix3D
• .rotateY(radians) ⇒ Matrix3D
• .rotateY(radians) ⇒ Matrix3D
• .rotate(x, y) ⇒ Matrix3D
• .skew(ax, ay) ⇒ Matrix3D
• .translate(x, y, z) ⇒ Matrix3D
• .getCss() ⇒ String
• .getX() ⇒ Number
• .getY() ⇒ Number
• .getY() ⇒ Number
• .setFromCss(matrixString)

ParentTransform

• new ParentTransform()
• .update(callback) ⇒ Array

SimpleNoise2D

• new SimpleNoise2D()
• .get(x, y) ⇒ Vector2D

Vector2D

• new Vector2D(x, y)
• .add(v) ⇒ Vector2D
• .sub(v) ⇒ Vector2D
• .dist(v) ⇒ number
• .mult(s)
• .div(s) ⇒ Vector2D
• .limit(s) ⇒ Vector2D
• .length() ⇒ Number
• .normalize() ⇒ Vector2D
• .clone() ⇒ Vector2D
• .degreeToVector() ⇒ Vector2D
• .random(degreeIncrement) ⇒ Vector2D

ad-global

ad-legacy

ad-load

Package Contents

Loader

• new Loader(target, arg)
• .add(arg)
• .load()
• .getAllContent() ⇒ array
• .getAllContentRaw() ⇒ array
• .getLoader(id) ⇒ Loader

LoaderUtils

• .createXMLHttpRequest() ⇒ XMLHttpRequest
• .getFileName(url) ⇒ string
• .getFontName(url) ⇒ string
• .getFileType(url) ⇒ string
• .getFullUrl(prepend, file, platformGetUrl) ⇒ string
• .getUrlPrepend(path) ⇒ string
• .getParamsFromData(query) ⇒ string

DataLoader

• new DataLoader(target, arg)
• .load()

FontLoader

• new FontLoader(target, arg)
• .load()

ImageLoader

• new ImageLoader(target, arg)
• .load()

InlineLoader

• new InlineLoader(target, arg)
• .load()

ad-particles

Package Contents

Emitter

• new Emitter()
• .tween
• .init(canvasElement, setting)
• .set(key, val, triggerChange)
• .get(key) ⇒ number | string | object | array
• .setProperties(obj)
• .addCustomBehavier(type, func)
• .removeCustomBehavier(type, func)
• .emit()
• .stopEmitting()
• .empty()
• .pause()
• .resume()
• .to(duration, props)
• .createParticles(amount)
• .addModel(modelObj)
• .removeModel(id)

Particle

• new Particle()
• .update()
• .getAnimationStyle()
• .render()
• .applyForce()
• .isDead() ⇒ boolean
• .checkWorld(w)
• ._checkBorder(axis, val)

ParticleModel

• new ParticleModel()

Graphic.Shape

• new Shape()

Graphic.Image

• new Image()

Graphic.Circle

• new Circle(size, style)

Graphic.Rect

• new Rect(width, height, style)

Graphic.Sprite

• new Sprite(image, size, style, spriteSetting)

ad-polyfills

Package Contents

ad-ui

Package Contents

TextFormat

• .INLINE : string
• .INLINE_CLAMP : string
• .INLINE_FIT : string
• .INLINE_FIT_CLAMP : string
• .PARAGRAPH : string
• .PARAGRAPH_CLAMP : string
• .PARAGRAPH_FIT : string
• .PARAGRAPH_FIT_CLAMP : string

TextSplitType

• .LINES : string
• .WORDS : string
• .CHARACTERS : string

UIBorder

• new UIBorder(arg)
• .size
• .color

UIButton

• new UIButton()
• .togglable : boolean
• .bg : element
• .icon : array
• .state : element
• .onClick()
• .onOver()
• .onOut()
• .toString() ⇒ string
• ._onClick()
• ._onOver()
• ._onOut()

UICanvas

• new UICanvas(id, target, css)
• .context2d : canvas
• .context3d : canvas
• .toString() ⇒ string

UIComponent

• new UIComponent()
• .x : number
• .y : number
• .enabled : boolean
• .showing : boolean
• .width : number
• .height : number
• .hide()
• .show()
• .setCss()
• .addChild()
• .inspect()
• .toString()

UIDiv

• new UIDiv()
• .parent : element
• .toString()

UIFlex

• new UIFlex()
• .flexDirection : string
• .justifyContent : string
• .flexWrap : string
• .alignItems : string

UIGroup

• new UIGroup(arg)

UIImage

• new UIImage()
• .source : string
• .retina : boolean
• .ratio : string
• .aspectRatio : boolean

UISlider

• new UISlider()
• .bg : element
• .loaded : element
• .track : element
• .handle : element
• .hitState : element
• .percent : number
• .dragging : boolean
• .U.onUpdate
• .U.toString()
• .U._onUpdate()

UISplitText

• new UISplitText(arg)
• .wordSpacing : number

UISvg

• new UISvg()
• .source : string
• .width : number
• .height : number

UITextField

• new UITextField()
• .alignText : string | Align
• .fontSize : number
• .minFontSize : number
• .fontFamily : string
• .format : string | TextFormat
• .leading : number
• .spacing : number
• .bufferText : number | array
• .text : string
• .smoothing : boolean
• .resetToDefault(arguments)
• .setDefault()

ad-useragent

Package Contents

• agentString : string
• pixelRatio : string
• getOrientation() ⇒ string
• getDimensions() ⇒ object
• report()
• getBrand() ⇒ string
• getProduct() ⇒ string
• getOS() ⇒ string
• getOSVersion() ⇒ string
• isOS() ⇒ boolean
• isBrowser(name) ⇒ boolean
• getBrowser() ⇒ string
• getBrowserVersion() ⇒ string
• isDevice(type) ⇒ boolean
• getDevice() ⇒ string
• isDualGestureIE() ⇒ boolean

ad-utils

Package Contents

ArrayUtils

• .combine(arr1, arr2)
• .copy(array)
• .insertAt(array, index, arguments)
• .removeAt(array, index)
• .remove(array, item)
• .shuffle(array)
• .contains(array, item)

ColorUtils

• .toRgba(color, alpha)
• .toRgbaString(color, alpha)
• .hue(obj)
• .saturation(obj)
• .contrast(obj)
• .tint(obj)
• .transform(obj) ⇒ string | object
• .invert(obj)

DcsUtils

• .addVideoMetrics(player, message)
• .addYouTubeVideoMetrics(player)

ImageUtils

• .fitImageAtCoordinate(target, originX, originY, source)

LocationUtils

• .getGPSData(callbackSuccess, callbackFail)

MathUtils

• .toRadians(degree)
• .toDegrees(radian)
• .random(a, b, increment)
• .randomBoolean(weight)
• .rel(a0, a1, b0, b1, bX)
• .inRange(val, a, b) ⇒ boolean
• .isNumber(num)
• .toNumber(str)
• .restrict()
• .getAnglePoint() ⇒ array
• .getAngle()
• .getDistance() ⇒ number

MonetUtils

MotionUtils

• .setSpeedLimits(negX, posX, negY, posY)
• .setSpeedMultiplier(multi)
• .activate(callback)
• .deactivate()
• .callibrate()

ObjectUtils

• .objectifier
• .get(str, ctxObj)
• .set(str, val, ctxObj)
• .clone(obj) ⇒ object
• .defaults(obj, defaultObj, recursive)

TextUtils

• .addSpaces()(numberOfSpaces) ⇒ string
• .getSpecialCharacter()(requestedCharacter, isCapital) ⇒ string
• .trimStartAndEnd()(target) ⇒ string
• .removeSpaces()(str) ⇒ string
• .pad()(_target, _count) ⇒ string
• .injectBreakTags(str, indexes)

ad-velvet

Package Contents

Velvet

• .capture

• .schedule(schedule)
• .addCustomData(obj)
• .dispatchData()
• .dispatchSchedule()
• .dispatchStart() ⇒ Promise

• .events

• .INIT : string
• .FAIL : string
• .STATIC : string

• .init(slugs, dateSettings, adDimensions, adElement)
• .isPreviewLocation()
• .convertBreaks(str)
• .get(arguments)

ad-video

Package Contents

AlphaVideoPlayer

• new AlphaVideoPlayer()

AudioPlayer

• new AudioPlayer()
• .autoPlay : boolean
• .percent : number
• .source : string
• .load()
• .play()
• .pause()
• .seek(sec)
• .stop()
• .mute()
• .unmute()

CuePoints

• new CuePoints()

VideoControls

• new VideoControls()
• .controlBar : UIControlBar
• .replayOnInteraction : boolean
• .unmuteOnInteraction : boolean

VideoPlayer

• new VideoPlayer()
• .complete : boolean
• .hasPlayed : boolean
• .onComplete : function
• .onFail : function
• .onBuffer : function
• .onProgress : function
• .onReady : function
• .container : UIComponent
• .screen : video
• .autoPlay : boolean
• .currentTime : number
• .duration : number
• .paused : boolean
• .percent : number
• .source : string
• .volume : number
• .muted : boolean
• .forceInline : boolean
• .load()
• .play()
• .pause()
• .seek(sec)
• .stop()
• .mute()
• .unmute()
• .resize(width, height)
• .addCuePoint(time, handler, params)
• .addControls(obj)

YouTubePlayer

• new YouTubePlayer()
• .paused : boolean
• .percent : number
• .currentTime : number
• .complete : boolean
• .onReady : function
• .onComplete : function
• .onFail : function
• .onBuffer : function
• .onProgress : function
• .onPlay : function
• .onAutoPlay : function
• .onStop : function
• .onPause : function
• .container : UIComponent
• .volume : number
• .source : string
• .url : string
• .autoPlay : boolean
• .muted : boolean
• .nativeControls : boolean
• .allowFullScreen : boolean
• .quality : string
• .hide()
• .show()
• .play()
• .pause()
• .seek(sec)
• .stop()
• .mute()
• .unmute()
• .addCuePoint(time, handler, params)

MediaEvent

• .AUTOPLAY : string
• .BUFFER : string
• .COMPLETE : string
• .FAIL : string
• .MUTE : string
• .PAUSE : string
• .PLAY : string
• .PROGRESS : string
• .READY : string
• .STOP : string
• .UNMUTE : string

UIButtonFullScreen

• new UIButtonFullScreen()

UIButtonMute

• new UIButtonMute()

UIButtonPlayPause

• new UIButtonPlayPause()

UIButtonReplay

• new UIButtonReplay()

UIControlBar

• new UIControlBar()
• .constant : boolean
• .showOnPoster : boolean

UITimeDisplay

• new UITimeDisplay()
• .showDuration : boolean

ad-view

Package Contents

Align

• .BOTTOM : string
• .CENTER : string
• .LEFT : string
• .RIGHT : string
• .TOP : string
• .BOTTOM_LEFT : string
• .BOTTOM_RIGHT : string
• .TOP_LEFT : string
• .TOP_RIGHT : string
• .get()
• .set()

Clamp

• .X : string
• .Y : string
• .XY : string
• .set(source, type, buffer)

Effects

• .blur(obj)
• .dropShadow(obj)
• .textDropShadow(obj)
• .glow(obj)
• .linearGradient(obj)
• .radialGradient(obj)

Markup

• .get(selector, parent) ⇒ element | HTMLCollection
• .removeChildren(_target)
• .applyToElements(arg)

Ratio

• .EXACT : string
• .FILL : string
• .FIT : string
• .STRETCH : string

Styles

• .setCss(_target, args)
• .getCss(_target, key)
• .injectStylesheet(nodeId, styles)
• .addClass(target, className)
• .removeClass(target, className)