properties scroll

identifier
1. identifier is used to write down notes of animations, actions and anything we find important to make note of
    identifier is a visual reference
2. identifier also provides a quick overview of the function structure flow
STRUCTURE: function (e) { javascript before - init - callback - javascript after }

selector | target link
set the link target by selector, either target a specific object or select document as global target
NOTE: use of   document   as selector will automatically disable tags on the selector (=non-string)
•••• var: string   |   •••• var: non-string ( document )

selector | target window
set the window target by selector, either target a specific object or select window as global target
IMPORTANT: use of   window   as selector internally converts to body, html         window = body,html
•••• var: string

PARAMETERS:

axis
set on which axis scroll will occur
setting this input to   xy   or yx   will also determine the sequence of queue - if the property   queue   is set to   true
•••• var: string

queue
set mode of operation, either in queue, in sequence (=true) , or at the same time (=false)
NOTE: the property axis needs to be set to   xy   or   yx    for queue to operate in sequence
•••• var: non-string

animation | duration
duration is the time for the scroll to complete
•••• var: non-string

animtion | easing
set an easing effect for the scroll
easing effect will add non-linear movement to animation (scroll), movement like acceleration, bounce, elastic etc
     the full list of easing effects is:
     back-in, back-out, back-inout
     bounce-in, bounce-out, bounce-inout
     circ-in, circ-out, circ-inout
     cubic-in, cubic-out, cubic-inout
     elas-in, elas-out, elas-inout
     expo-in, expo-out, expo-inout
     quad-in, quad-out, quad-inout
     quart-in, quart-out, quart-inout
     quint-in, quint-out, quint-inout
     sine-in, sine-out, sine-inout
     swing, linear
     NOTE: for a reference on easing effect see here
•••• var: string

offset
offset the scroll position
•••• var: non-string

mouse-wheel
set a mode to control   mouse-wheel motion   vs   scroll animation
this property prevents erratic behavior when mouse-wheel event occurs while a scroll animation is in progress
the available modes are:
not used/false = the function is not used
break           = the scroll animation is stopped and continues into manual mouse-wheel scroll
disable         = disable mouse-wheel while scroll animation is running
•••• var: string

prevent | stop
animation will stop on an event occurrence if set to   true
•••• var: non-string

prevent | lock
if lock is set to   true   a next event occurrence will not execute if scroll is already animated, the animation will first complete
•••• var: non-string

event
set which event type will trigger the scroll   (click, mouseover, mouseout etc)
•••• var: string

CALLBACK:

callback | before
add a function before scroll begins
the callback function in full range is beyond the scope of this manual
for an in depth on callback and run on call see here
   • fn: onBefore: function(e, anchor, $target) { }
   anchor   = returns current anchor - target
   $target = returns current target window

callback | after
add a function after scroll ends
the callback function in full range is beyond the scope of this manual
for an in depth on callback and run on call see here
   • fn: onAfter: function(anchor) { }
   anchor   = returns current anchor - target

callback | after first
add a function after the first scroll, if   queue   is set to true
the callback function in full range is beyond the scope of this manual
for an in depth on callback and run on call see here
   • fn: onAfterFirst: function(anchor) { }
   anchor   = returns current anchor - target

-----

filter | include
set specific target anchor to filter by selector -   include   selected only
NOTE: target the anchor to filter - ie. use   WB inside anchor   option
•••• var: string

filter | exclude
set specific target anchor to filter by selector -   exclude   selected
NOTE: target the anchor to filter - ie. use   WB inside anchor   option
•••• var: string

hash
hash target link appears in browser address bar if set to   true
•••• var: non-string

PREBLOCK:

preblock | prevent active
this property can be used to prevent the active scroll mark from activating (a preblock overlay)
this property needs to comply to the following rule to work correct
   RULE: the first marker needs to be set manual
   WHY?: the onAfter property is used to check the last active marker against the current marker
   it is not possible to know the first active mark before the first onAfter executes
   therefore set the first active marker here manual
•••• var: string

preblock | run on call
create an   easy tools | preblock   overlay and call it with this property to activate before and remove after scroll occurs
the   run on call   of the   easy tools | preblock   is the value for this property
NOTE: set the   run on load mode   of the preblock overlay to   run on call
NOTE: if this property is enabled the above prevent | stop property is surpassed (=true)
see example here

-----

run on load
run on load enables or disables this module to run on page load

run on call
run on call is the function name we can give this current function
we can call this function to occur ie. by using a    callback | function
for an in depth on callback and run on call see here

code modification | target link is class
setting this property to   true   will adjust tagging a class to a Webbuilder Image object
use this ie. if specific links need to target a specific window and a Webbuilder Image object is used
example:
identifier                      : my scroll notes
selector | target link          : .myClass
selector | target window        : #Layer1
axis                            : xy
add the class for the Image object(s) used in the   HTML   -   inside tag   or   Inside anchor   -   class = 'myClass'
see example 4 here
•••• var: non-string

code modification | function add
add additional scroll functions - ie.   ,margin:true, over:10 etc
NOTE: code start with a comma

code modification | variable
add a function variable ie. Call_Scroll_1(myVariable)
this function is beyond the scope of this manual   see here

code modification | javascript | after
add javascript, further enhancing this function by adding custom code
this function is beyond the scope of this manual   see here

code modification | javascript | before
add javascript, further enhancing this function by adding custom code
this function is beyond the scope of this manual   see here