Interface VastIcon

VastIcon. For more info please take a look at the VAST specification

Hierarchy

  • VastIcon

Properties

duration? height? htmlResource? iFrameResource? iconClickThrough? iconClickTracking? iconViewTracking? left? offset? program? pxratio? staticResource? top? width? xPosition? yPosition?

Properties

Optional duration

duration?: number

The duration the icon should be displayed unless ad is finished playing.

Optional height

height?: number

Pixel height of the icon.

Optional htmlResource

htmlResource?: string

The URI to a static creative file to be used as the icon.

Optional iFrameResource

iFrameResource?: string

The URI to a static creative file to be used as the icon.

Optional iconClickThrough

iconClickThrough?: string

A URI to the industry program page opened when a viewer clicks the icon.

Optional iconClickTracking

iconClickTracking?: string[]

Array of URIs to the tracking resource files to be called when a click corresponding to the id attribute (if provided) occurs.

Optional iconViewTracking

iconViewTracking?: string[]

Array of URIs for the tracking resource files to be called when the icon creative is displayed

Optional left

left?: number

Pixel left offset of the icon.

Optional offset

offset?: number

The time of delay from when the associated linear creative begins playing to when the icon should be displayed.

Optional program

program?: string

The program represented in the icon (e.g. "AdChoices").

Optional pxratio

pxratio?: number

The pixel ratio for which the icon creative is intended. The pixel ratio is the ratio of physical pixels on the device to the device-independent pixels. An ad intended for display on a device with a pixel ratio that is twice that of a standard 1:1 pixel ratio would use the value "2." Default value is "1.".

Optional staticResource

staticResource?: string

The URI to a static creative file to be used as the icon.

Optional top

top?: number

Pixel top offset of the icon.

Optional width

width?: number

Pixel width of the icon.

Optional xPosition

xPosition?: string | number

The x-coordinate of the top, left corner of the icon asset relative to the ad display area. Values of "left" or "right" also accepted and indicate the leftmost or rightmost available position for the icon asset.

Optional yPosition

yPosition?: string | number

The y-coordinate of the top left corner of the icon asset relative to the ad display area. Values of "top" or "bottom" also accepted and indicate the topmost or bottom most available position for the icon asset

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc