Display Ad Group (DAG) Class

// Create a new DAG object
var myDAG = new DAG("Position1") ;

myDAG.GetAdsFromCookie(null, true) ;

// Receive cookie for DispPos1 into object myDAG with time out of 100/4=25 seconds
// Then display the retrieved ad after receiving
MyDAG.cc_task = "MyDag.PutAd(0)" ; 
myDAG.ReceiveAdCookie ("DispPos1", null, "myDAG", 100) ;

// Receive cookie for DispPos1 into object myDAG with time out of 100/4=25 seconds
myDAG = new DAG(DispPos1) ;
var url="http://YourDomain/YourPath/ad.pl?pos=DispPos1&dsp=dim&agn=AdGrp1&sel=rnd"
myDAG.ReqAdCookie(url)
myDAG.ReceiveAdCookie (null, false, "myDAG", 100) ;

// Receive cookie for DispPos1 into object myDAG with time out of 100/4=25 seconds
myDAG = new DAG(DispPos1) ;
myDAG.WriteCCElem() ;
var url="http://YourDomain/YourPath/ad.pl?pos=DispPos1&dsp=dim&agn=AdGrp1&sel=rnd"
myDAG.ReqAdCookie(url)
myDAG.ReceiveAdCookie (null, false, "myDAG", 100) ;

This function is equivalent to the html tags below

In addition, put_obj property is initialized by the object of layer/div containers.

WriteContainer method must be called during initial loading of the document, since it writes the containers using document.write().

If another container already on the browser is going to be used, then do not use this function. Instead, initialize the property put_obj with the object of desired container.

myDAG.WriteContainer("<P>This is the initial content</p>") ;

myDAG.Object().style.border = "thin solid" ;

myDAG.PutContent("<H1>Hello</h1><P>How are you doing?</p>") ;
...
myDAG.PutContent(myDAG.ag.ads[2].RedHtml()) ;

// Get the redirected content of the second ad in the list appended by a BR tag.
myDAG.put_head = "" ;
myDAG.put_foot = "<BR>" ;
myDag.GetSelAd(1) ;

If adi is defined, it must be an integer pointing to an ad in the array this.ag.ads[]. That ad is selected and displayed.

If adi is not defined, then the value of put_mode property is used to select an ad from the underlying ad group.

The property put_lasti contains the index of the last put ad (except for DAG_PUT_MODE_ALL).

The value of put_head property is always concatenated to the beginning of the content of the selected ads. The value of put_foot property is always appended to the end of the content of the selected ads.

// Display the second ad in the list
myDag.PutAd(1) ;
// Display the original content of a randomly selected ad
myDag.put_mode = DAG_PUT_MODE_WRAND ;
myDag.PutAd(null, true) ;
// Display all of the ads in the list, separate them by a horizontal ruler
myDag.put_mode = DAG_PUT_MODE_ALL ;
myDag.put_foot = "<HR>" ;
myDag.PutAd() ;

// Periodically display the ads in forward sequence starting from the ad with index 0.
// Refresh at every 20 seconds
myDag.put_mode = DAG_PUT_MODE_FSEQ ;
myDag.put_lasti = -1 ;
myDag.put_period = 20000 ;
myDag.PutAdPer("myDag") ;

myDag.Object().style.position = "absolute" ; 
myDag.left = 100 ; // 100 pixels from left
myDag.top = 10 ; // 10 pixels from up
myDag.width = 400 ; // 400 pixels in width
myDag.height = "auto" ; // automatic height
myDag.visible = true ; // Make it visible
myDag.RefreshVisual() ; // Apply the settings 

docXScroll() * sxr + windWidth() * wxr + MouseX * mxr - widthOfBox * axr + xoff ;

sxr property: is the scrolling compensation parameter. When set to 0, no compensation takes place. When set to 1, full scrolling compensation is done.

wxr property: is horizontal window anchor parameter. When set to 0, container goes to the left. When set to 1, container goes to right.

mxr property: is horizontal mouse pointer anchor parameter. When set to 0, no mouse anchor is used. When set to 1, the container is aligned to the mouse pointer.

axr property: is the ad container alignment parameter to the anchor point. When set to 0, left point of the container is aligned. When set to 1, right edge of container is aligned.

xoff property: is the horizontal anchor offset.

See the methods DAG.AdBoxRefPoint, DAG.WindAnchorPoint, DAG.ScrollCompensate, and DAG.ChangeAnchorPoint for more information on the parameters and a better interface to define position of the container.

myDag.Object().style.position = "absolute" ; 
myDag.width = 400 ; // 400 pixels in width
myDag.height = "auto" ; // Let height be determined by the browser
myDag.visible = true ; // Make it visible
myDag.RefreshVisual() ; // Apply the settings 
// Container will go to the center of the window horizontally 
// no matter the scrolling is.
myDag.sxr = 1   ; 
myDag.wxr = 0.5 ; 
myDag.mxr = 0   ; 
myDag.xoff = 0  ; 
myDag.axr = 0.5 ; 
document.write("The Left position of the container will be " + 
               myDag.LeftPosition()) ;

docYScroll() * syr + windHeight() * wyr + MouseY * myr - heightOfBox * ayr + yoff ;

syr property: is the scrolling compensation parameter. When set to 0, no compensation takes place. When set to 1, full scrolling compensation is done.

wyr property: is vertical window anchor parameter. When set to 0, container goes to the top. When set to 1, container goes to the bottom of window.

myr property: is vertical mouse pointer anchor parameter. When set to 0, no mouse anchor is used. When set to 1, the container is aligned to the mouse pointer.

ayr property: is the ad container alignment parameter to the anchor point. When set to 0, top point of the container is aligned. When set to 1, the bottom edge of the container is aligned.

yoff property: is the vertical anchor offset.

See the methods DAG.AdBoxRefPoint, DAG.WindAnchorPoint, DAG.ScrollCompensate, and DAG.ChangeAnchorPoint for more information on the parameters and a better interface to define position of the container.

myDag.Object().style.position = "absolute" ; 
myDag.width = 400 ; // 400 pixels in width
myDag.height = "auto" ; // Let height be determined by the browser
myDag.visible = true ; // Make it visible
myDag.RefreshVisual() ; // Apply the settings 
// Container will go to the center of the window vertically 
// no matter the scrolling is.
myDag.syr = 1   ; 
myDag.wyr = 0.5 ; 
myDag.myr = 0  ; 
myDag.yoff = 0  ; 
myDag.ayr = 0.5 ; 
document.write("The Top position of the container will be " + 
               myDag.TopPosition()) ;

The left and the top of the ad box are calculated by calling the methods, LeftPosition and TopPosition.

If pos_pause_refresh property is set to true, position refreshing is paused.

See the methods DAG.AdBoxRefPoint, DAG.WindAnchorPoint, DAG.ScrollCompensate, and DAG.ChangeAnchorPoint for more information on the parameters and a better interface to define position of the container.

myDag.Object().style.position = "absolute" ;
myDag.width = 400 ; // 400 pixels in width
myDag.height = "auto" ; // Let browser determine the height of the box
myDag.visible = true ; // Make it visible
myDag.RefreshVisual() ; // Apply the settings 
// Move container to the upper left corner with scrolling compensation.
myDag.sxr = 1  ; myDag.syr = 1 ;
myDag.wxr = 0  ; myDag.wyr = 0 ;
myDag.mxr = 0  ; myDag.myr = 0 ;
myDag.axr = 0  ; myDag.ayr = 0 ;
myDag.xoff = 0 ; myDag.yoff = 0 ;
myDag.RefreshPosition() ;
...
// User friendly interface: The container follows the mouse, 
// and the mouse pointer is on the center of the container.
myDag.AdBoxRefPoint(DAG_POS_CENTER, DAG_POS_CENTER) ;
myDag.WindAnchorPoint(null, DAG_POS_MOUSE, null,  null, DAG_POS_MOUSE, null) ;
myDag.ScrollCompensate(DAG_POS_NOSCROLL, DAG_POS_NOSCROLL) ;
myDag.RefreshPosition() ;
...
// User friendly interface:
// Move container to the bottom right corner.
myDag.AdBoxRefPoint(DAG_POS_RIGHT, DAG_POS_BOTTOM) ;
myDag.WindAnchorPoint(DAG_POS_RIGHT, null, null,  DAG_POS_BOTTOM, null, null) ;
myDag.ScrollCompensate(DAG_POS_NOSCROLL, DAG_POS_NOSCROLL) ;
myDag.RefreshPosition() ;

myDag.Object().style.position = "absolute" ; 
myDag.width = 400 ; // 400 pixels in width
myDag.height = 300 ; // 300 pixels in height
myDag.visible = true ; // Make it visible
myDag.RefreshVisual() ; // Apply the settings 

// Container goes to bottom center of the screen no matter the scrolling is.
myDag.AdBoxRefPoint(DAG_POS_CENTER, DAG_POS_BOTTOM) ;
myDag.WindAnchorPoint(DAG_POS_CENTER, null, null,  DAG_POS_BOTTOM, null, null) ;
myDag.ScrollCompensate(DAG_POS_NOSCROLL, DAG_POS_NOSCROLL) ;
myDag.pos_per = 100 ; // Refresh the position 10 times in 1 second.
myDag.RefreshPositionPer("myDag") ;

...
myDag.RefreshPositionPer("myDag") ;
...
myDag.StopTimer(1) ;

This method determines the alignment reference point on the ad container box. The defined reference point will be aligned to the anchor point on the window. For example, if you define the up-left corner of the box as the reference point, and the center of the window as the anchor point, then the up-left corner of the box is going to be aligned to the center of the window after a RefreshPosition method call.

You can use the predefined values for xr and yr

xr (yr) abbreviation	value	Meaning
DAG_POS_LEFT DAG_POS_TOP	0	Align to the left (top) edge of the box
DAG_POS_QUART	0.25	Align to quarter distance (of the width) right from the left edge Align to quarter distance (of the height) bottom from the top edge
DAG_POS_CENTER	0.5	Align to the center of the box
DAG_POS_3QUART	0.75	Align to quarter distance (of the width) left from the right edge Align to quarter distance (of the height) up from the bottom edge
DAG_POS_RIGHT DAG_POS_BOTTOM	1	Align to the right (bottom) edge of the box

Note that the alignment reference point is defined with respect to the width and height of the box. Thus xr and yr are ratios rather than distance in pixels. If you want to define the alignment point on the box in terms of absolute distances, then assign to the xoff and yoff parameters of the object. For example, if you want a reference point 10 pixels horizontally and 50 pixels vertically off the up-left corner, then xoff -= 10 and yoff -= 50 will do that.

// Set the reference point to the center of the box horizontally and
// the bottom of the box vertically.
myDag.AdBoxRefPoint(DAG_POS_CENTER, DAG_POS_BOTTOM) ;
// Set the reference point some offset left-up from left-top corner.
myDag.AdBoxRefPoint(-0.01, -0.01) ;

This method defines an anchor point on the window to which the reference point of the ad box will be aligned. The anchor point can be defined in terms of the window dimensions, the mouse pointer position and absolute distances in pixels.

wxr (wyr) ratio defines the anchor point in terms of window width (height). You can use the predefined values for wxr and wyr

wxr (wyr) abbreviation	value	Meaning
DAG_POS_LEFT DAG_POS_TOP	0	Anchor to the left (top) edge of the window
DAG_POS_QUART	0.25	Anchor to the quarter distance (of the width) right from the left edge of window. Anchor to the quarter distance (of the height) bottom from the top edge of the window.
DAG_POS_CENTER	0.5	Anchor to the the center of the window
DAG_POS_3QUART	0.75	Anchor to the quarter distance (of the width) left from the right edge of the window. Anchor to the quarter distance (of the height) up from the bottom edge of the window.
DAG_POS_RIGHT DAG_POS_BOTTOM	1	Anchor to the the right (bottom) edge of the window.

mxr (myr) ratio defines the anchor point in terms of mouse pointer horizontal (vertical) position. You can use the predefined values for mxr and myr

mxr (myr) abbreviation	value	Meaning
DAG_POS_NOMOUSE	0	No mouse position is used for anchor point calculation
DAG_POS_MOUSE	1	The position of the mouse pointer is added to the window anchor point.

xoff (yoff) value defines the offset from the window plus mouse anchor position.

Note that 3 values are added up to find the final anchor point.

// Anchor point on the upper left corner of the window
myDag.WindAnchorPoint(DAG_POS_LEFT, DAG_POS_NOMOUSE, 0,
                      DAG_POS_TOP, DAG_POS_NOMOUSE, 0) ;

// Change anchor point to 10 pixels right and 30 pixels top off the current position
myDag.WindAnchorPoint(null, null, 10, null, null, -30) ;

// Set the anchor point as the mouse pointer: 
myDag.WindAnchorPoint(DAG_POS_LEFT, DAG_POS_MOUSE, 0,
                      DAG_POS_TOP, DAG_POS_MOUSE, 0) ;

// Horizontally follow the mouse, vertically stick near to bottom 
myDag.WindAnchorPoint(DAG_POS_LEFT, DAG_POS_MOUSE, 0,
                      DAG_POS_3QUART, DAG_POS_NOMOUSE, 0) ;

The xr (yr) is zero, then no horizontal (vertical) scrolling compensation is done. The ad box scrolls with the document. If xr is one, full scroll compensation is done. The ad box will keep its position with respect to the anchor point.

You can use the predefined values for xr and yr

xr (yr) abbreviation	value	Meaning
DAG_POS_SCROLL	0	No scroll compensation
DAG_POS_NOSCROLL	1	Full scroll compensation

// No scroll horizontally or vertically 
myDag.ScrollCompensate(DAG_POS_NOSCROLL, DAG_POS_NOSCROLL) ;

// Enable  vertical scrolling
myDag.ScrollCompensate(null, DAG_POS_SCROLL) ;

// Sroll slower than than the document horizontally and 
// faster than the document vertically
myDag.ScrollCompensate(0.5, -0.5) ;

This method changes the anchor point and the reference point of the box without changing the current position of the ad box. This is done by adjusting the parameters xoff and yoff accordingly. For example, when you want to implement a drag and drop operation, you change the anchor point from window to mouse but you do not want the user to experience any annoying box movements.

// Change anchor point to center of the window and 
// reference to the upper left corner of the box
myDag.ChangeAnchorPoint(DAG_POS_CENTER, DAG_POS_NOMOUSE, 0, DAG_POS_LEFT,
                        DAG_POS_CENTER, DAG_POS_NOMOUSE, 0, DAG_POS_TOP) ;

// Enable drag and drop
myDag.DDStatus(true, "myDAG") ;
// Refresh the position sufficiently fast
myDag.pos_per = 50 ; // Refresh the position 20 times in 1 second.
myDag.RefreshPositionPer("myDag") ;
// Or better bind it to the mouse move event
gehMMove.NewHandler ("myDag.RefreshPosition();") ;

Name of the display ad group. If you set this property to the name of the display position, and the name of the DAG object variable is "dag"+name, then you do not have to supply a varname argument to some methods (such as RefreshPositionPer method). If the DAG object is loaded to the browser from the DynAds delivery engine, then the name of the variable and the name property of the object is set with respect to these guidelines.

The name property can be assigned during the object creation time or explicitly after the object is created.

The name property is used to generate names for the container elements, cookie communication IMG elements and guessing the name of the variable for some functions.
The name of the container will be "div"+name or "lay"+name.
The name of the cookie IMG element will be "cimg"+name.
The name of the variable is guessed as "dag"+name

// If display position name is "MainPage468x60" then 
// the name property is assigned while creating the class object
dagMainPage468x60 = new DAG("MainPage468x60") ;
// Equivalently
dagMainPage468x60 = new DAG() ;
dagMainPage468x60.name = "MainPage468x60" ;

The ad selection method.