get the total number of fingers touching the screen
function touchStart(event, passedName) {
fingerCount = event.touches.length;
if (fingerCount === 1) { // check that only one finger was used
startX = event.touches[0].pageX; // get the coordinates of the touch
startY = event.touches[0].pageY;
triggerElementID = passedName; // store the triggering element ID
} else {
touchCancel(event); // more than one finger touched so cancel
}
}
function touchMove(event) {
if (event.touches.length === 1) {
curX = event.touches[0].pageX;
curY = event.touches[0].pageY;
} else {
touchCancel(event);
}
}
function touchEnd(event) {
if (fingerCount === 1 && curX !== 0) { // check to see if more than one finger was used and that there is an ending coordinate
swipeLength = Math.round(Math.sqrt(Math.pow(curX - startX, 2) + Math.pow(curY - startY, 2))); // use the Distance Formula to determine the length of the swipe
if (swipeLength >= minLength) { // if the user swiped more than the minimum length, perform the appropriate action
caluculateAngle();
determineSwipeDirection();
processingRoutine();
touchCancel(event); // reset the variables
} else {
touchCancel(event);
}
} else {
touchCancel(event);
}
}
function touchCancel(event) {
fingerCount = 0; // reset the variables back to default values
startX = 0;
startY = 0;
curX = 0;
curY = 0;
deltaX = 0;
deltaY = 0;
horzDiff = 0;
vertDiff = 0;
swipeLength = 0;
swipeAngle = null;
swipeDirection = null;
triggerElementID = null;
}
function caluculateAngle() {
var X = startX - curX,
Y = curY - startY,
Z = Math.round(Math.sqrt(Math.pow(X, 2) + Math.pow(Y, 2))), //the distance - rounded - in pixels
r = Math.atan2(Y, X); //angle in radians (Cartesian system)
swipeAngle = Math.round(r * 180 / Math.PI); //angle in degrees
if (swipeAngle < 0) {
swipeAngle = 360 - Math.abs(swipeAngle);
}
}
function determineSwipeDirection() {
if ((swipeAngle <= 45) && (swipeAngle >= 0)) {
swipeDirection = 'left';
} else if ((swipeAngle <= 360) && (swipeAngle >= 315)) {
swipeDirection = 'left';
} else if ((swipeAngle >= 135) && (swipeAngle <= 225)) {
swipeDirection = 'right';
} else if ((swipeAngle > 45) && (swipeAngle < 135)) {
swipeDirection = 'down';
} else {
swipeDirection = 'up';
}
}
function processingRoutine() { // actions
var swipedElement = document.getElementById(triggerElementID);
if (swipeDirection === 'left') {
updateText();
if (carousel) {
$(carousel).carousel('next'); // move carousel to display next image
} else {
pushThumbnails("right", customClass); // move thumbnails
}
event.preventDefault(); // cancel normal actions
} else if (swipeDirection === 'right') {
updateText();
if (carousel) {
$(carousel).carousel('prev'); // move carousel to display previous image
} else {
pushThumbnails("left", customClass); // move thumbnails
}
event.preventDefault(); // cancel normal touch actions
}
}
function updateText() { //updates the slide details (name, headline) onSlide
var id = $(customClass + ' .item.active').data('slide-number'); // get the id of the active slide
$(customClass + ' #carousel-text').html($(customClass + ' #slide-content-' + id).html()); // add corresponding text to headline div
$(customClass + " #carousel-selector-" + id).addClass("active"); // add active class to active slide
$(customClass + " .item").each(function (index) {
if (index !== id) {
$(customClass + " #carousel-selector-" + index).removeClass("active"); // remove active class for all items that are not active
}
});
$(customClass + ' .image-counter .active-image-number').text(+id + 1); //change current slide number indicator
}
function pushThumbnails(direction, customClass) { // shifts the group of thumbnails to the direction specified as a paramter (left or otherwise right)
var totalGroups = $(customClass + ' .thumbnails').length,
totalThumbs = 0;
for (var i = 0; i < totalGroups; i++) {
totalThumbs += $(customClass + ' .thumbnails#group-' + i + ' > li').length;
}
var numberOfThumbnails = 3; // set the number of thumbnails that should be displayed for device width and state
if ($('.full-screen').length) {
if ($(window).width() > 615) {
numberOfThumbnails = 4;
}
if ($(window).width() > 1140) {
numberOfThumbnails = 5;
}
if (($(window).width() > 820 && $(window).width() < 979)) {
numberOfThumbnails = 5;
}
} else {
if ($(window).width() > 979) {
numberOfThumbnails = 4;
}
}
var numberOfGroups = Math.ceil(totalThumbs / numberOfThumbnails), // number of groups required
currentSlide = $(customClass + " .thumbnails.active").data('group-number'), // get active slide
comparitor,
leftPosition; // new position of group
if (direction == "left") {
comparitor = 0; // can't move further left than slide 0
leftPosition = "+=100%"; // left
} else {
comparitor = numberOfGroups - 1; // can't move further right than final slide
leftPosition = "-=100%"; // right
}
if (currentSlide != comparitor) {
$(customClass + " .thumbnails").each(function () {
$(customClass + " #group-" + $(this).data('group-number')).animate({
left: leftPosition
}, "slow"); // move thumbnail group
$(customClass + " #group-" + $(this).data('group-number')).removeClass("active"); // remove active class
});
if (direction == "left") {
currentSlide -= 1; // decrement active slide variable
} else {
currentSlide += 1; // increment active slide variable
}
$(customClass + " #group-" + currentSlide).addClass("active"); // add active class
}
}
})(jQuery);
/*! pictureStorylist.jQuery.js */
(function ($) {
// PICTURE STORYLIST CAROUSEL JAVASCRIPT
$.fn.pictureStorylist = function (parameters) {
var settings = $.extend({ // Set parameter defaults
timeInterval: 3000,
changeOnHover: true,
itemClass: "",
containerClass: "",
numberOfThumbsMob: 1,
numberOfThumbsDesk: 4,
targetID: ""
}, parameters),
windowWidth = window.innerWidth,
carouselID = "#" + $(this).attr("id"), // set the target carousel id
split = carouselID.split(settings.targetID), // get the custom class
customClass = "." + split[1];
// var isMobileDevice = ? ? ? ? // This variable needs to be set to true if the user views the page on a tablet or phone (touch device)
// It should be set to false when when a user views the page on a desktop machine. Setting this variable on device width alone is not accurate enough.
// ***** ----- CODE FOR TESTING START ----- *****
// The next 4 lines are for the purpose of testing only - DO NOT INCLUDE THEM IN THE FINAL CODE.
// The are used instead of setting the isMobileDevice variable, when a solution is found, this code can be removed
var isMobileDevice;
if (window.innerWidth < 10) {
isMobileDevice = true;
}
// ***** ----- CODE FOR TESTING END ----- *****
//******************************** SET UP & START CAROUSEL *******************************
// -------- On load ------ //
if (windowWidth > 1023) {
groupThumbnails(customClass, settings); // set number of thumbnails for width of image
}
$(carouselID).carousel({
pause: true,
interval: false
});
//******************************** CAROUSEL ACTIONS ********************************
if (isMobileDevice) { // on mobile device
$(customClass + ' .carousel-control.left').bind('touchstart', function () { // Recognise clicks on previous
$(carouselID).carousel('prev');
});
$(customClass + ' .carousel-control.right').bind('touchstart', function () { // Recognise clicks on next
$(carouselID).carousel('next');
});
} else { // on desktop
$(customClass + ' .carousel-control.left').click(function () { // Recognise clicks on previous
$(carouselID).carousel('prev');
});
$(customClass + ' .carousel-control.right').click(function () { // Recognise clicks on next
$(carouselID).carousel('next');
});
}
preventSlide(customClass, carouselID, settings);
$('.picture-navigator').on('slid.bs.carousel', function () {
$(customClass + ' .carousel-control.right,' + customClass + ' .carousel-control.left').show();
preventSlide(customClass, carouselID, settings);
});
$(window).resize(function() {
groupThumbnails(customClass, settings);
$(customClass + ' .carousel-control.right,' + customClass + ' .carousel-control.left').show();
preventSlide(customClass, carouselID, settings);
});
};
//////////////////////////////////////////////////////////////////////////////
// Picture Storylist/Events Functions
//////////////////////////////////////////////////////////////////////////////
function groupThumbnails(customClass, settings) { // calculates the number of required for each thumbnail group, if this value is different from that displayed, the certain thumbnails are moved from one group to another. This should be called onLoad or when the browser size changes.
var shouldBeDisplayed = getNumberOfItems(settings), // set number of thumbnails for width and mode
totalThumbs = $(customClass + " ." + settings.itemClass).length; // total number of thumbnails
for (var i = 0; i < $(customClass + " ." + settings.containerClass).length; i++) { // every group, totalThumbs arrayCount[0]
var currentlyDisplayed = $(customClass + " ." + settings.containerClass).eq(i).find(" ." + settings.itemClass).length, // number of thumbnails currently displayed
difference = shouldBeDisplayed - currentlyDisplayed;
if (difference > 0) { // there should be more thumbnails per group
for (var j = difference; j > -1; j--) {
var thumbId = (shouldBeDisplayed) - j + (shouldBeDisplayed * i); // id of the extra thumbnail
if (thumbId < totalThumbs) {
var thumnail = $(customClass + " ." + settings.itemClass).eq(thumbId),
newThumnail = thumnail.clone(true); // clone the thumbnail
$(customClass + " ." + settings.itemClass).eq(thumbId).remove(); // remove old thumbnail
$(customClass + " ." + settings.containerClass).eq(i).append(newThumnail); // add new thumbnail to different group
};
}
} else if (difference < 0) { // there should be less thumbnails per group
for (var j = difference; j < 0; j++) {
var thumbId = (shouldBeDisplayed - 1) - j + (shouldBeDisplayed * i); // id of the extra thumbnail
thumnail = $(customClass + " ." + settings.itemClass).eq(thumbId);
newThumnail = thumnail.clone(true); // clone the thumbnail
$(customClass + " ." + settings.itemClass).eq(thumbId).remove(); // remove old thumbnail
$(customClass + " ." + settings.containerClass).eq(i + 1).prepend(newThumnail);
};
}
};
}
function getNumberOfItems(settings) { // get how many thumbnails should be displayed on mobile and desktop
var numberOfThumbnails = settings.numberOfThumbsMob;
if (window.innerWidth > 1023) {
numberOfThumbnails = settings.numberOfThumbsDesk;
}
return numberOfThumbnails;
}
function preventSlide(customClass, carouselID, settings) {
var totalThumbs = $(customClass + " ." + settings.itemClass).length;
var numberOfGroupsShould = Math.ceil( totalThumbs / getNumberOfItems(settings) );
var currentGroup = $(customClass + " .item.active").data("slide-number");
if( currentGroup == (numberOfGroupsShould - 1) ){
$(customClass + ' .carousel-control.right').hide();
}
if( currentGroup == 0 ){
$(customClass + ' .carousel-control.left').hide();
}
if( $(customClass + ' .item.active' + " ." + settings.containerClass + " ." + settings.itemClass).length == 0 ){
$(carouselID).carousel(numberOfGroupsShould - 1);
$(carouselID).carousel('pause');
}
}
})(jQuery);
/*!
* Navigation.js - various navigation-specific functions
* Last updated 13-03-2015 by GH to fix the Sub-Navigation alignment issue
*/
/*
Controls appearance of arrows in the navigation
(when clicked, they should toggle between being horizontal and vertical)
*/
jQuery(".navbar-primary-container .nav li > span").click(function() {
jQuery(this).toggleClass("nav-arrow-open").toggleClass("nav-arrow"); // Changes arrow
jQuery(this).parent().find(".nav").eq(0).slideToggle(); // Opens navigation
});
if (jQuery("li").hasClass("active")) {
jQuery("li.active > span").toggleClass("nav-arrow-open").toggleClass("nav-arrow");
}
/* Sub Navigation Dropdown fix
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~
* If the dropdown hangs off the right hand side of the page, move the starting left position so it will fit against the right-hand-side
*/
// Variable to see if static secondary menu has children - will cause error in following hover function if not checked as it will get left.offset of null.
var staticSecondMenu = $(".navbar-secondary-container").children();
$('.primary.nav > li').hover(function() {
if ($(this).children().length > 3 && staticSecondMenu.length != 0 ) {
var subWidth = $(this).find(".primary-drop .drop-content-a").outerWidth(true) + $(this).find(".primary-drop .drop-content-b").outerWidth(true); // subWidth is the width of the sub-navigation: left column + right column
var navWidth = $(".navbar").outerWidth(true); // navWidth = width of navigation bar div in px
var ulLeft = $(".navbar").offset().left; // ulLeft = left edge of navigation bar in px, measured from the far left of the browser window
var ulRight = parseFloat(ulLeft + navWidth); // ulRight = right edge of navigation (left edge + width), in px, from the far left edge of the browser window
var liLeft = $(this).offset().left; // liLeft = left edge of
element
// Check if the width of the sub-nav drop down is too wide: required width > avaliable width
if (subWidth > ulRight - liLeft) {
var newLeft = navWidth - subWidth;
$(this).find(".primary-drop").css("left", newLeft + "px");
}
}
});
/*
Scrolls browser back to the top of the page when user clicks #toplink elements
*/
$("#topLink").click(function() {
$("html, body").animate({ scrollTop: 0 }, 500);
return false;
});
/*
Closes the share popover, when option is selected or when user clicks off popover
*/
$( ".popover-content > div > a" ).click(function() {
$('#share-trigger-top').popover('hide');
});
$("body").click(function(e) {
if(e.target.className !== "text" && e.target.id !== "share-trigger-top"){
$('#share-trigger-top').popover('hide');
}
});
/*!
* webTicker 2.1.1
* Examples and documentation at:
* http://jonmifsud.com/open-source/jquery/jquery-webticker/
* 2011 Jonathan Mifsud
* Version: 2.1.1 (23-MAY-2013)
* Dual licensed under the Creative Commons and DonationWare licenses:
* http://creativecommons.org/licenses/by-nc/3.0/
* https://github.com/jonmifsud/Web-Ticker/blob/master/licence.md
* Requires:
* jQuery v1.4.2 or later
*
*/
(function( $ ){
var cssTransitionsSupported = (function() {
var s = document.createElement('p').style,
v = ['ms','O','Moz','Webkit'];
if( s['transition'] == '' ) return true;
while( v.length )
if( v.pop() + 'Transition' in s )
return true;
return false;
})();
function scrollitems($strip,moveFirst){
var settings = $strip.data('settings');
if (typeof moveFirst === 'undefined')
moveFirst = false;
if (moveFirst){
moveFirstElement($strip);
}
var options = animationSettings($strip);
$strip.animate(options.css, options.time, "linear", function(){
$strip.css(settings.direction, '0');
scrollitems($strip,true);
});
}
function animationSettings($strip){
var settings = $strip.data('settings');
var first = $strip.children().first();
var distance = Math.abs(-$strip.css(settings.direction).replace('px','').replace('auto','0') - first.outerWidth(true));
var settings = $strip.data('settings');
var timeToComplete = distance * 1000 / settings.speed;
var animationSettings = {};
animationSettings[settings.direction] = $strip.css(settings.direction).replace('px','').replace('auto','0') - distance;
return {'css':animationSettings,'time':timeToComplete};
}
function moveFirstElement($strip){
var settings = $strip.data('settings');
$strip.css('transition-duration','0s').css(settings.direction, '0');
var $first = $strip.children().first();
if ($first.hasClass('webticker-init'))
$first.remove();
else
$strip.children().last().after($first);
}
function css3Scroll($strip,moveFirst){
if (typeof moveFirst === 'undefined')
moveFirst = false;
if (moveFirst){
moveFirstElement($strip);
}
var options = animationSettings($strip);
var time = options.time/1000;
time += 's';
$strip.css(options.css).css('transition-duration',time);
}
function initalize($strip){
var settings = $strip.data('settings');
$strip.width('auto');
//Find the real width of all li elements
var stripWidth = 0;
$strip.children('li').each(function(){
stripWidth += $(this).outerWidth( true );
});
if(stripWidth < $strip.parent().width() || $strip.children().length == 1){
//if duplicate items
if (settings.duplicate){
//Check how many times to duplicate depending on width.
itemWidth = Math.max.apply(Math, $strip.children().map(function(){ return $(this).width(); }).get());
while (stripWidth - itemWidth < $strip.parent().width() || $strip.children().length == 1){
var listItems = $strip.children().clone();
$strip.append(listItems);
stripWidth = 0;
$strip.children('li').each(function(){
stripWidth += $(this).outerWidth( true );
});
itemWidth = Math.max.apply(Math, $strip.children().map(function(){ return $(this).width(); }).get());
}
}else {
//if fill with empty padding
var emptySpace = $strip.parent().width() - stripWidth;
emptySpace += $strip.find("li:first").width();
var height = $strip.find("li:first").height();
$strip.append('');
}
}
if (settings.startEmpty){
var height = $strip.find("li:first").height();
$strip.prepend('
');
}
//extra width to be able to move items without any jumps $strip.find("li:first").width()
stripWidth = 0;
$strip.children('li').each(function(){
stripWidth += $(this).outerWidth( true );
});
$strip.width(stripWidth+200);
widthCompare = 0;
$strip.children('li').each(function(){
widthCompare += $(this).outerWidth( true );
});
//loop to find weather the items inside the list are actually bigger then the size of the whole list. Increments in 200px.
//only required when a single item is bigger then the whole list
while (widthCompare >= $strip.width()){
$strip.width($strip.width()+200);
widthCompare = 0;
$strip.children('li').each(function(){
widthCompare += $(this).outerWidth( true );
});
}
}
var methods = {
init : function( settings ) { // THIS
settings = jQuery.extend({
speed: 50, //pixels per second
direction: "left",
moving: true,
startEmpty: true,
duplicate: false,
hoverpause: true,
rssfrequency: 0,
updatetype: "reset"
}, settings);
//set data-ticker a unique ticker identifier if it does not exist
return this.each(function(){
jQuery(this).data('settings',settings);
var $strip = jQuery(this);
$strip.addClass("newsticker");
var $tickercontainer = $strip.parent().wrap("
");
initalize($strip);
if (cssTransitionsSupported){
//fix for firefox not animating default transitions
$strip.css('transition-duration','0s').css(settings.direction, '0');
css3Scroll($strip,false);
$strip.on('transitionend webkitTransitionEnd oTransitionEnd otransitionend', function(event) {
if (!$strip.is(event.target)) {
return false;
}
css3Scroll($(this),true);
});
} else {
scrollitems($(this));
}
if (settings.hoverpause){
$strip.hover(function(){
if (cssTransitionsSupported){
var currentPosition = $(this).css(settings.direction);
$(this).css('transition-duration','0s').css(settings.direction,currentPosition);
} else
jQuery(this).stop();
},
function(){
if (jQuery(this).data('settings').moving){
if (cssTransitionsSupported){
css3Scroll($(this),false);
// $(this).css("-webkit-animation-play-state", "running");
} else {
//usual continue stuff
scrollitems($strip)
}
}
});
}
});
},
stop : function( ) {
var settings = $(this).data('settings');
if (settings.moving){
settings.moving = false;
return this.each(function(){
if (cssTransitionsSupported){
var currentPosition = $(this).css(settings.direction);
$(this).css('transition-duration','0s').css(settings.direction,currentPosition);
} else
$(this).stop();
});
}
},
cont : function( ) {
var settings = $(this).data('settings')
if (!settings.moving){
settings.moving = true;
return this.each(function(){
if (cssTransitionsSupported){
css3Scroll($(this),false);
} else {
scrollitems($(this));
}
});
}
},
update : function( list, type, insert, remove) {
type = type || "reset";
if (typeof insert === 'undefined')
insert = true;
if (typeof remove === 'undefined')
remove = false;
if( typeof list === 'string' ) {
list = $(list);
}
var $strip = $(this);
$strip.webTicker('stop');
var settings = $(this).data('settings');
if (type == 'reset'){
//this does a 'restart of the ticker'
$strip.html(list);
$strip.css(settings.direction, '0');
initalize($strip);
} else if (type == 'swap'){
// should the update be a 'hot-swap' or use replacement for IDs (in which case remove new ones)
$strip.children('li').addClass('old');
for (var i = 0; i < list.length; i++) {
id = $(list[i]).data('update');
match = $strip.find('[data-update="'+id+'"]');//should try find the id or data-attribute.
if (match.length < 1){
if (insert){
//we need to move this item into the dom
if ($strip.find('.ticker-spacer:first-child').length == 0 && $strip.find('.ticker-spacer').length > 0){
$strip.children('li.ticker-spacer').before(list[i]);
}
else {
$strip.append(list[i]);
}
}
} else $strip.find('[data-update="'+id+'"]').replaceWith(list[i]);;
};
$strip.children('li.webticker-init, li.ticker-spacer').removeClass('old');
if (remove)
$strip.children('li').remove('.old');
stripWidth = 0;
$strip.children('li').each(function(){
stripWidth += $(this).outerWidth( true );
});
$strip.width(stripWidth+200);
}
$strip.webTicker('cont');
}
};
$.fn.webTicker = function( method ) {
// Method calling logic
if ( methods[method] ) {
return methods[ method ].apply( this, Array.prototype.slice.call( arguments, 1 ));
} else if ( typeof method === 'object' || ! method ) {
return methods.init.apply( this, arguments );
} else {
$.error( 'Method ' + method + ' does not exist on jQuery.webTicker' );
}
};
})( jQuery );
var windowBig = true;
function searchFilter(windowWidth) {
if (windowWidth < 1024) {
// Click function to show/hide search filters
jQuery(".search-filters-outer-container h3").click(function(e) {
jQuery(".search-filters-inner-container").slideToggle();
e.preventDefault();
});
jQuery(".search-filters-inner-container").hide();
jQuery(".search-filters-outer-container").appendTo(".search-sort-filter");
} else if (windowWidth > 1023) {
// Prevent click function used for small screen
jQuery(".search-filters-outer-container h3").off();
jQuery(".search-filters-inner-container").show();
jQuery(".search-filters-outer-container").appendTo(
".content-b .inner-d article");
}
}
$(function() {
var windowWidth = window.innerWidth;
searchFilter(windowWidth);
jQuery(window).resize(function() {
var newWindowWidth = window.innerWidth;
if ((newWindowWidth > 1023 && windowWidth < 1024)
|| (newWindowWidth < 1024 && windowWidth > 1023)) {
searchFilter(newWindowWidth);
}
windowWidth = newWindowWidth;
});
});
function searchFromDate(e) {
e.preventDefault();
var $this = $(e.target);
var fromDate = $this.data('from-date');
var $form = $(e.target).parents('form');
$form.find('input[name="fromDate"]').val(fromDate);
$form.submit();
}
function filterByDate(e) {
e.preventDefault();
var $this = $(e.target);
var $form = $(e.target).parents('form');
var fromDate = $form.find('input[name="filterFromDate"]').val();
var toDate = $form.find('input[name="filterToDate"]').val();
$form.find('input[name="fromDate"]').val(fromDate);
$form.find('input[name="toDate"]').val(toDate);
$form.submit();
}
/*!
Weather.js
*/
//Used to sort issues with IE8 and console.logs
function emptyFunction(a) {
}
window.console = window.console || {
log : emptyFunction,
info : emptyFunction,
warn : emptyFunction,
error : emptyFunction
}
// Global variable
var defaultLocation = 'W1'; // user can set this in Polopoly - should be W1
// default
// When doc loaded - run
$(function() {
// Check to see if the user is logged in or not?
if (readCookie("sessionKey") != false) {
// User logged in - grab preferred stored post code.
console.log('user logged in');
var postcode = qs('postcode');
// in case the postcode exist in query string, use it instead
if (postcode != null && postcode != undefined && postcode.length > 0) {
getWeatherForecast(postcode);
} else {
if (typeof (localStorage.todayTemp) !== "undefined" && localStorage.override === "true") {
if (!getStoredWeather()) {
getUserWeather();
}
} else {
getUserWeather();
}
}
} else {
if (localStorage.override === "true") localStorage.override = false;
getStoredWeather();
}
}); // End doc ready
/*
* ----------------------------------------------------- FUNCTIONS
* ///////////////////////////////////////////
*/
function getUserWeather() {
$.ajax({
dataType: "json",
url: '/ajax?action=loginStatus',
success: function(json) {
if(json.loginStatus.postCode != null) {
getWeatherForecast(json.loginStatus.postCode);
} else {
getStoredWeather();
}
},
error: function() {
getStoredWeather();
}
});
}
function getStoredWeather() {
if (typeof (localStorage.todayTemp) !== "undefined") {
// Yes, localStorage supported - check how old data is?
var todaysTime = new Date().getTime();
var localStorageTime = localStorage.timeFetched;
if (todaysTime < localStorageTime) {
// date is not too old, retrieve from localStorage.
console.log('LOCAL STORAGE');
$('.weather-header .location').html(localStorage.weatherLocation).show();
$('.temperature.current-climate').html(localStorage.todayTemp + "°").show();
$('.weather-header .weather-image').attr("src", localStorage.weatherImage).show();
// set 5-day forecast link to url with specified location
var pageUrl = $('.weather-header').data('weather-page');
resetWeatherUrl(pageUrl, localStorage.weatherLocation);
// set modal input text to the new location name
resetWeatherLocation(localStorage.weatherLocation);
return true;
}
}
// No localStorage variables
var preferedLocation = $('.weather-header').data('preffered-location');
getWeather(preferedLocation);
return false;
}
function getWeatherForecast(locationName) {
getWeather(locationName);
if (typeof (localStorage.todayTemp) !== "undefined") {
localStorage.override = true;
}
}
function getWeather(locationName) {
console.log('locationName first: ' + locationName);
if (typeof (locationName) == "undefined") {
// if locationName not passed to function
// use default location
console.log('using cookie value: ' + defaultLocation);
ajaxWeather(defaultLocation);
} else { // argument passed - use this variable
console.log('using form value: ' + locationName);
var isLocationNameSterile = regexPostCode(locationName);
if (isLocationNameSterile == true) {
// passed regex - hide any previous error messages
$('.weather-header .no-weather').addClass('hide');
ajaxWeather(locationName);
} else {
// regex failed - show message
$('.weather-header .no-weather').html(
'Please enter a valid UK postcode - thank you');
$('.weather-header .hide.no-weather').removeClass('hide');
}
}
}
function regexPostCode(location) {
// Therefor using simple letters / numbers regex.
var postCodeReg = /^[A-Za-z0-9 ]*[A-Za-z0-9][A-Za-z0-9 ]*$/;
if (!postCodeReg.test(location)) {
// Failed regex
console.log('failed regex');
return false;
} else {
// Passed Regex
console.log('passed regex');
return true;
}
}
function ajaxWeather(locationName) {
console.log('ajax: ' + locationName);
console.log('ajaxWeather() ran');
var contentUrl = $('.weather-header').data('content-url');
if (contentUrl == undefined || contentUrl == null) return;
//var url = "http://www.edp24.co.uk/news/weather?contentonly=true&ajax=true&submit=true&postcode=" + locationName;
var url = contentUrl;
var ot = 'archant.AjaxPageLayout.ot';
$.ajax({
// URL for fetching weather and variable name for location/post code
// (this may need edit depending on the url string needed).
url : url,
data: {
"ot" : ot,
"isAjaxView" : "true",
"postcode" : locationName
},
dataType: "json",
success : function(result) {
// object result might still be successful, but not have anything in
// it.
// so check for object we use.
if (typeof (result.todayTemp) !== "undefined") { // Unsure of what
// exact object name
// will be....
// add result to the DOM
$('.weather-header .location').html(locationName).show();
$('.temperature.current-climate').html(result.todayTemp + "°").show();
$('.weather-header .weather-image')
.attr("src", result.weatherImage).show();
// set result in localStorage
localStorage.todayTemp = result.todayTemp;
localStorage.weatherLocation = locationName;
localStorage.weatherImage = result.weatherImage;
// add 30minutes to time to effect 'cache timeout'
localStorage.timeFetched = new Date().getTime() + 30 * 60000;
// set 5-day forecast link to url with specified location
var pageUrl = $('.weather-header').data('weather-page');
resetWeatherUrl(pageUrl, locationName);
// set modal input text to the new location name
resetWeatherLocation(locationName);
var win = $('#my-weather-modal');
if (win.hasClass('in')) {
win.modal('hide');
}
} else {
// aJax didn't return to us a useable object - display error
// message.
$('.weather-header .hide.no-weather').html(
"There was an error with your request, please try again.");
}
},
error : function(xhr, status, error) {
// Error handling messages
$('.weather-header .hide.no-weather')
.html(
"We do not have a forecast for "
+ locationName
+ ".
Please ensure you enter a valid postcode and try again");
$('.weather-header .hide.no-weather').removeClass('hide');
console.log('Ajax no results, error: ');
console.log('xhr: ' + xhr);
console.log('status: ' + status);
console.log('error: ' + error);
}
});
}
function readCookie(cookieName) {
var re = new RegExp('[; ]' + cookieName + '=([^\\s;]*)');
var sMatch = (' ' + document.cookie).match(re);
if (cookieName && sMatch) {
return unescape(sMatch[1]);
} else {
return false;
}
}
function resetWeatherUrl(pageUrl, locationName) {
var url = pageUrl + "?postcode=" + locationName;
$('.weather-header .forecast-link').attr('href', url).show();
}
function resetWeatherLocation(locationName) {
$('#weather-location input:text[name=location]').val(locationName);
}
function qs(name) {
var query = window.location.search.substring(1);
var vars = query.split("&");
for (var i=0;i
this.tgt = targetelement;
this.cont.style.position = 'absolute';
this.topOffset = this.tgt.offsetHeight; // the vertical distance (in pixels) to display the calendar from the Top of its input element
this.leftOffset = 0; // the horizontal distance (in pixels) to display the calendar from the Left of its input element
this.cont.style.top = this.getTop(targetelement) + this.topOffset + 'px';
this.cont.style.left = this.getLeft(targetelement) + this.leftOffset + 'px';
this.cont.appendChild(this.calendar);
document.body.appendChild(this.cont);
this.tgt.calendar = this;
this.tgt.onfocus = function () {this.calendar.show();}; //the calendar will popup when the input element is focused
this.tgt.onblur = function () {if(!this.calendar.mousein){this.calendar.hide();}}; //the calendar will popup when the input element is focused
}
else
{
this.container = targetelement;
this.container.appendChild(this.calendar);
}
this.state = 2; //0: initializing, 1: redrawing, 2: finished!
this.visible ? this.show() : this.hide();
}
//-----------------------------------------------------------------------------
Epoch.prototype.calConfig = function () //PRIVATE: initialize calendar variables
{
//this.mode = 'flat'; //can be 'flat' or 'popup'
this.displayYearInitial = this.curDate.getFullYear(); //the initial year to display on load
this.displayMonthInitial = this.curDate.getMonth(); //the initial month to display on load (0-11)
this.rangeYearLower = 2008;
this.rangeYearUpper = new Date().getFullYear()+2; //Amended by AK for RFC 1697 - Extend maximum date range on website, https://basecamp.com/2294155/projects/4252126/todos/211776634
this.minDate = new Date(2008,0,1);
this.maxDate = new Date(2015,0,1);
this.startDay = 1; // the day the week will 'start' on: 0(Sun) to 6(Sat)
this.showWeeks = false; //whether the week numbers will be shown
this.selCurMonthOnly = false; //allow user to only select dates in the currently displayed month
this.clearSelectedOnChange = true; //whether to clear all selected dates when changing months
//flat mode-only settings:
//this.selectMultiple = true; //whether the user can select multiple dates (flat mode only)
switch(this.mode) //set the variables based on the calendar mode
{
case 'popup': //popup options
this.visible = false;
break;
case 'flat':
this.visible = true;
break;
}
this.setLang();
};
//-----------------------------------------------------------------------------
Epoch.prototype.setLang = function() //all language settings for Epoch are made here. Check Date.dateFormat() for the Date object's language settings
{
this.daylist = new Array('S','M','T','W','T','F','S','S','M','T','W','T','F','S'); /**/
this.months_sh = new Array('January','February','March','April','May','June','July','August','September','October','November','December');
this.monthup_title = 'Go to the next month';
this.monthdn_title = 'Go to the previous month';
this.clearbtn_caption = 'Close';
this.clearbtn_title = 'Close the calendar';
this.maxrange_caption = 'This is the maximum range';
};
//-----------------------------------------------------------------------------
Epoch.prototype.getTop = function (element) //PRIVATE: returns the absolute Top value of element, in pixels
{
var oNode = element;
var iTop = 0;
// if(oNode.tagName != 'BODY') {
// iTop += oNode.offsetTop;
// oNode = oNode.offsetParent;
// }
var offset = $(element).offset();
iTop = offset.top;
return iTop;
};
//-----------------------------------------------------------------------------
Epoch.prototype.getLeft = function (element) //PRIVATE: returns the absolute Left value of element, in pixels
{
var oNode = element;
var iLeft = 0;
// if(oNode.tagName != 'BODY') {
// iLeft += oNode.offsetLeft;
// oNode = oNode.offsetParent;
// }
var offset = $(element).offset();
iLeft = offset.left;
return iLeft;
};
//-----------------------------------------------------------------------------
Epoch.prototype.show = function () //PUBLIC: displays the calendar
{
this.calendar.style.display = 'block';
if(this.cont)
{
this.cont.style.display = 'block';
}
this.visible = true;
};
//-----------------------------------------------------------------------------
Epoch.prototype.hide = function () //PUBLIC: Hides the calendar
{
this.calendar.style.display = 'none';
if(this.cont)
{
this.cont.style.display = 'none';
}
this.visible = false;
};
//-----------------------------------------------------------------------------
Epoch.prototype.toggle = function () //PUBLIC: Toggles (shows/hides) the calendar depending on its current state
{
if(this.visible) {
this.hide();
}
else {
this.show();
}
};
//-----------------------------------------------------------------------------
Epoch.prototype.setDays = function () //PRIVATE: initializes the standard Gregorian Calendar parameters
{
this.daynames = new Array();
var j=0;
for(var i=this.startDay; i< this.startDay + 7;i++) {
this.daynames[j++] = this.daylist[i];
}
this.monthDayCount = new Array(31,((this.curDate.getFullYear() - 2000) % 4 ? 28 : 29),31,30,31,30,31,31,30,31,30,31);
};
//-----------------------------------------------------------------------------
Epoch.prototype.setClass = function (element,className) //PRIVATE: sets the CSS class of the element, W3C & IE
{
element.setAttribute('class',className);
element.setAttribute('className',className); //
};
//-----------------------------------------------------------------------------
Epoch.prototype.createCalendar = function () //PRIVATE: creates the full DOM implementation of the calendar
{
var tbody, tr, td;
this.calendar = document.createElement('table');
this.calendar.setAttribute('id',this.name+'-calendar');
this.calendar.setAttribute('class','web-form-calendar');
this.calendar.setAttribute('className','web-form-calendar');
//to prevent IE from selecting text when clicking on the calendar
this.calendar.onselectstart = function() {return false;};
this.calendar.ondrag = function() {return false;};
tbody = document.createElement('tbody');
//create the Main Calendar Heading
tr = document.createElement('tr');
td = document.createElement('td');
td.appendChild(this.createMainHeading());
tr.appendChild(td);
tbody.appendChild(tr);
//create the calendar Day Heading
tr = document.createElement('tr');
td = document.createElement('td');
td.appendChild(this.createDayHeading());
tr.appendChild(td);
tbody.appendChild(tr);
//create the calendar Day Cells
tr = document.createElement('tr');
td = document.createElement('td');
td.setAttribute('id','web-form-cell-td');
this.calCellContainer = td; //used as a handle for manipulating the calendar cells as a whole
td.appendChild(this.createCalCells());
tr.appendChild(td);
tbody.appendChild(tr);
//create the calendar footer
if(this.mode == 'popup') {//hide the calendar if in popup mode
tr = document.createElement('tr');
td = document.createElement('td');
td.appendChild(this.createFooter());
tr.appendChild(td);
tbody.appendChild(tr);
}
//add the tbody element to the main calendar table
this.calendar.appendChild(tbody);
//and add the onmouseover events to the calendar table
this.calendar.owner = this;
this.calendar.onmouseover = function() {this.owner.mousein = true;};
this.calendar.onmouseout = function() {this.owner.mousein = false;};
};
//-----------------------------------------------------------------------------
Epoch.prototype.createMainHeading = function () //PRIVATE: Creates the primary calendar heading, with months & years
{
//create the containing element
var container = document.createElement('div');
container.setAttribute('id',this.name+'-mainheading');
this.setClass(container,'mainheading');
//create the child elements and other variables
this.monthSelect = document.createElement('select');
this.monthSelect.setAttribute('style','display:none;');
this.yearSelect = document.createElement('select');
this.yearSelect.setAttribute('style','display:none;');
this.dateDisplay = document.createElement('span');
this.dateDisplay.setAttribute('id',this.name+'-dateDisplay');
var monthDn = document.createElement('a'), monthUp = document.createElement('a');
var opt, i;
var textDate = '';
//fill the month select box
for(i=0;i<12;i++)
{
opt = document.createElement('option');
opt.setAttribute('value',i);
if(this.state == 0 && this.displayMonth == i) {
opt.setAttribute('selected','selected');
textDate += this.months_sh[i];
}
opt.appendChild(document.createTextNode(this.months_sh[i]));
this.monthSelect.appendChild(opt);
}
//and fill the year select box
for(i=this.rangeYearLower;i<=this.rangeYearUpper;i++)
{
opt = document.createElement('option');
opt.setAttribute('value',i);
if(this.state == 0 && this.displayYear == i) {
opt.setAttribute('selected','selected');
textDate += " " + this.displayYear;
}
opt.appendChild(document.createTextNode(i));
this.yearSelect.appendChild(opt);
}
this.dateDisplay.appendChild(document.createTextNode(textDate));
//add the appropriate children for the month buttons
var monthUpContent = document.createElement('span');
var monthDownContent = document.createElement('span');
monthUpContent.appendChild(document.createTextNode(this.monthup_title));
monthUp.appendChild(monthUpContent);
monthUp.setAttribute('href','#none');
monthUp.setAttribute('class','nextBtn');
monthUp.setAttribute('className','nextBtn'); //
monthDownContent.appendChild(document.createTextNode(this.monthdn_title));
monthDn.appendChild(monthDownContent);
monthDn.setAttribute('href','#none');
monthDn.setAttribute('class','prevBtn');
monthDn.setAttribute('className','prevBtn'); //
this.monthSelect.owner = this.yearSelect.owner = monthUp.owner = monthDn.owner = this; //hack to allow us to access this calendar in the events (??)
//assign the event handlers for the controls
monthUp.onclick = function () {this.owner.nextMonth(); this.owner.requestCalendarEvents(this.owner.monthSelect.value, this.owner.yearSelect.value); return false;};
monthDn.onclick = function () {this.owner.prevMonth(); this.owner.requestCalendarEvents(this.owner.monthSelect.value, this.owner.yearSelect.value); return false;};
this.monthSelect.onchange = function() {
this.owner.displayMonth = this.value;
this.owner.displayYear = this.owner.yearSelect.value;
this.owner.goToMonth(this.owner.displayYear,this.owner.displayMonth);
};
this.yearSelect.onchange = function() {
this.owner.displayMonth = this.owner.monthSelect.value;
this.owner.displayYear = this.value;
this.owner.goToMonth(this.owner.displayYear,this.owner.displayMonth);
};
//and finally add the elements to the containing div
container.appendChild(monthDn);
container.appendChild(this.monthSelect);
container.appendChild(this.dateDisplay);
container.appendChild(this.yearSelect);
container.appendChild(monthUp);
return container;
};
//-----------------------------------------------------------------------------
Epoch.prototype.createFooter = function () //PRIVATE: creates the footer of the calendar - goes under the calendar cells
{
var container = document.createElement('div');
var clearSelected = document.createElement('input');
clearSelected.setAttribute('type','button');
clearSelected.setAttribute('value',this.clearbtn_caption);
clearSelected.setAttribute('title',this.clearbtn_title);
clearSelected.owner = this;
clearSelected.onclick = function() { var datesString = "";
for(i=0;i for filler
if(this.showWeeks)
{
td = document.createElement('td');
td.setAttribute('class','wkhead');
td.setAttribute('className','wkhead'); //
tr.appendChild(td);
}
//populate the day titles
for(var dow=0;dow<7;dow++)
{
td = document.createElement('td');
td.appendChild(document.createTextNode(this.daynames[dow]));
if(this.selectMultiple) { //if selectMultiple is true, assign the cell a CalHeading Object to handle all events
td.headObj = new CalHeading(this,td,(dow + this.startDay < 7 ? dow + this.startDay : dow + this.startDay - 7));
}
tr.appendChild(td);
}
tbody.appendChild(tr);
this.calHeading.appendChild(tbody);
return this.calHeading;
};
//-----------------------------------------------------------------------------
Epoch.prototype.createCalCells = function () //PRIVATE: creates the table containing the calendar day cells
{
this.rows = new Array(false,false,false,false,false,false);
this.cells = new Array();
var row = -1, totalCells = (this.showWeeks ? 48 : 42);
var beginDate = new Date(this.displayYear,this.displayMonth,1);
var endDate = new Date(this.displayYear,this.displayMonth,this.monthDayCount[this.displayMonth]);
var sdt = new Date(beginDate);
sdt.setDate(sdt.getDate() + (this.startDay - beginDate.getDay()) - (this.startDay - beginDate.getDay() > 0 ? 7 : 0) );
//create the table element
this.calCells = document.createElement('table');
this.calCells.setAttribute('id',this.name+'-calcells');
this.setClass(this.calCells,'calcells');
var tbody,tr,td;
tbody = document.createElement('tbody');
for(var i=0;i
}
td.appendChild(document.createTextNode(sdt.getWeek()));
tr.appendChild(td);
i++;
}
}
else if(i % 7 == 0) //otherwise, new row every 7 cells
{
row++;
tr = document.createElement('tr');
}
//create the day cells
td = document.createElement('td');
td.appendChild(document.createTextNode(sdt.getDate()));// +' ' +sdt.getUeDay()));
var cell = new CalCell(this,td,sdt,row);
this.cells.push(cell);
td.cellObj = cell;
sdt.setDate(sdt.getDate() + 1); //increment the date
tr.appendChild(td);
tbody.appendChild(tr);
}
this.calCells.appendChild(tbody);
this.reDraw();
return this.calCells;
};
//-----------------------------------------------------------------------------
Epoch.prototype.reDraw = function () //PRIVATE: reapplies all the CSS classes for the calendar cells, usually called after chaning their state
{
this.state = 1;
var i,j;
for(i=0;i 0)
this.monthSelect.value--;
else
{
if(this.yearSelect.value > this.rangeYearLower)
{
this.monthSelect.value = 11;
this.yearSelect.value--;
}
else {
alert(this.maxrange_caption);
}
}
//assign the currently displaying month/year values
this.displayMonth = this.monthSelect.value;
this.displayYear = this.yearSelect.value;
document.getElementById(this.name+'-dateDisplay').innerHTML = this.months_sh[this.displayMonth] + ' ' + this.displayYear;
//and refresh the calendar for the new month/year
this.deleteCells();
this.calCellContainer.appendChild(this.createCalCells());
};
//-----------------------------------------------------------------------------
Epoch.prototype.addZero = function (vNumber) //PRIVATE: pads a 2 digit number with a leading zero
{
return ((vNumber < 10) ? '0' : '') + vNumber;
};
//-----------------------------------------------------------------------------
Epoch.prototype.addDates = function (dates,redraw) //PUBLIC: adds the array "dates" to the calendars selectedDates array (no duplicate dates) and redraws the calendar
{
var j,in_sd;
for(var i=0;i -1 ? vYearLong : vYearShort);
var vHour = this.addZero(vDate.getHours());
var vMinute = this.addZero(vDate.getMinutes());
var vSecond = this.addZero(vDate.getSeconds());
return vFormat.replace(/dd/g, vDay).replace(/mm/g, vMonth).replace(/y{1,4}/g, vYear).replace(/hh/g, vHour).replace(/nn/g, vMinute).replace(/ss/g, vSecond);
};
//-----------------------------------------------------------------------------
Epoch.prototype.updatePos = function (target) //PUBLIC: moves the calendar's position to target's location (popup mode only)
{
this.calendar.style.top = this.getTop(target) + this.topOffset + 'px'
this.calendar.style.left = this.getLeft(target) + this.leftOffset + 'px'
}
//-----------------------------------------------------------------------------
/*****************************************************************************/
function CalHeading(owner,tableCell,dow)
{
this.owner = owner;
this.tableCell = tableCell;
this.dayOfWeek = dow;
//the event handlers
this.tableCell.onclick = this.onclick;
}
//-----------------------------------------------------------------------------
CalHeading.prototype.onclick = function ()
{
//reduce indirection:
var owner = this.headObj.owner;
var sdates = owner.selectedDates;
var cells = owner.cells;
owner.cols[this.headObj.dayOfWeek] = !owner.cols[this.headObj.dayOfWeek];
for(var i=0;i
//the event handlers
this.tableCell.onclick = this.onclick;
}
//-----------------------------------------------------------------------------
WeekHeading.prototype.onclick = function ()
{
//reduce indirection:
var owner = this.weekObj.owner;
var cells = owner.cells;
var sdates = owner.selectedDates;
var i,j;
owner.rows[this.weekObj.tableRow] = !owner.rows[this.weekObj.tableRow];
for(i=0;i
{
this.setAttribute('class',this.cellClass + ' hover');
this.setAttribute('className',this.cellClass + ' hover');
//reduce indirection:
var cell = this.cellObj;
var owner = cell.owner;
if(cell.title)
{
var customMonth = owner.displayMonth;
if(customMonth == cell.date.getMonth()) {
// defined in main.js
highlightEvent(cell.title);
}
}
};
//-----------------------------------------------------------------------------
CalCell.prototype.onmouseout = function () //replicate CSS :hover effect for non-supporting browsers
{
// defined in main.js
removeHighlights();
this.cellObj.setClass();
};
//-----------------------------------------------------------------------------
CalCell.prototype.onclick = function ()
{
//reduce indirection:
var cell = this.cellObj;
var owner = cell.owner;
if(cell.href)
{
window.location = cell.href;
return;
}
if(!owner.selCurMonthOnly || cell.date.getMonth() == owner.displayMonth && cell.date.getFullYear() == owner.displayYear)
{
if(owner.selectMultiple == true) //if we can select multiple cells simultaneously, add the currently selected cell's date to the selectedDates array
{
if(!cell.selected) //if this cell has been selected
{
if(owner.selectedDates.arrayIndex(cell.date) == -1) {
owner.selectedDates.push(cell.date);
}
}
else
{
var tmp = owner.selectedDates; // to reduce indirection
//if the cell has been deselected, remove it from the owner calendar's selectedDates array
for(var i=0;i 0 && this.date.getDay() < 6) {
this.cellClass = 'wkday';
}
else {
this.cellClass = 'wkend';
}
if(this.date.getFullYear() == this.owner.curDate.getFullYear() && this.date.getMonth() == this.owner.curDate.getMonth() && this.date.getDate() == this.owner.curDate.getDate()) {
if(customMonth == this.date.getMonth()) {
this.cellClass = this.cellClass + ' curdate';
}
}
if(this.title)
{
this.cellClass = this.cellClass + ' ' + this.title;
}
this.tableCell.setAttribute('class',this.cellClass);
this.tableCell.setAttribute('className',this.cellClass); //
};
/*****************************************************************************/
Date.prototype.getDayOfYear = function () //returns the day of the year for this date
{
return parseInt((this.getTime() - new Date(this.getFullYear(),0,1).getTime())/86400000 + 1);
};
//-----------------------------------------------------------------------------
Date.prototype.getWeek = function () //returns the day of the year for this date
{
return parseInt((this.getTime() - new Date(this.getFullYear(),0,1).getTime())/604800000 + 1);
};
/*function getISOWeek()
{
var newYear = new Date(this.getFullYear(),0,1);
var modDay = newYear.getDay();
if (modDay == 0) modDay=6; else modDay--;
var daynum = ((Date.UTC(this.getFullYear(),this.getMonth(),this.getDate(),0,0,0) - Date.UTC(this.getFullYear()),0,1,0,0,0)) /1000/60/60/24) + 1;
if (modDay < 4 ) {
var weeknum = Math.floor((daynum+modDay-1)/7)+1;
}
else {
var weeknum = Math.floor((daynum+modDay-1)/7);
if (weeknum == 0) {
year--;
var prevNewYear = new Date(this.getFullYear(),0,1);
var prevmodDay = prevNewYear.getDay();
if (prevmodDay == 0) prevmodDay = 6; else prevmodDay--;
if (prevmodDay < 4) weeknum = 53; else weeknum = 52;
}
}
return + weeknum;
}*/
//-----------------------------------------------------------------------------
Date.prototype.getUeDay = function () //returns the number of DAYS since the UNIX Epoch - good for comparing the date portion
{
return parseInt(Math.floor((this.getTime() - this.getTimezoneOffset() * 60000)/86400000)); //must take into account the local timezone
};
//-----------------------------------------------------------------------------
Date.prototype.dateFormat = function(format)
{
if(!format) { // the default date format to use - can be customized to the current locale
format = 'd/m/Y';
}
LZ = function(x) {return(x < 0 || x > 9 ? '' : '0') + x};
var MONTH_NAMES = new Array('January','February','March','April','May','June','July','August','September','October','November','December','Jan','Feb','Mar','Apr','May','Jun','Jul','Aug','Sep','Oct','Nov','Dec');
var DAY_NAMES = new Array('Sunday','Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sun','Mon','Tue','Wed','Thu','Fri','Sat');
format = format + "";
var result="";
var i_format=0;
var c="";
var token="";
var y=this.getFullYear().toString();
var M=this.getMonth()+1;
var d=this.getDate();
var E=this.getDay();
var H=this.getHours();
var m=this.getMinutes();
var s=this.getSeconds();
var yyyy,yy,MMM,MM,dd,hh,h,mm,ss,ampm,HH,H,KK,K,kk,k;
// Convert real this parts into formatted versions
var value = new Object();
//if (y.length < 4) {y=''+(y-0+1900);}
value['Y'] = y.toString();
value['y'] = y.substring(2);
value['n'] = M;
value['m'] = LZ(M);
value['F'] = MONTH_NAMES[M-1];
value['M'] = MONTH_NAMES[M+11];
value['j'] = d;
value['d'] = LZ(d);
value['D'] = DAY_NAMES[E+7];
value['l'] = DAY_NAMES[E];
value['G'] = H;
value['H'] = LZ(H);
if (H==0) {value['g']=12;}
else if (H>12){value['g']=H-12;}
else {value['g']=H;}
value['h']=LZ(value['g']);
if (H > 11) {value['a']='pm'; value['A'] = 'PM';}
else { value['a']='am'; value['A'] = 'AM';}
value['i']=LZ(m);
value['s']=LZ(s);
//construct the result string
while (i_format < format.length) {
c=format.charAt(i_format);
token="";
while ((format.charAt(i_format)==c) && (i_format < format.length)) {
token += format.charAt(i_format++);
}
if (value[token] != null) { result=result + value[token]; }
else { result=result + token; }
}
return result;
};
/*****************************************************************************/
Array.prototype.arrayIndex = function(searchVal,startIndex) //similar to array.indexOf() - created to fix IE deficiencies
{
startIndex = (startIndex != null ? startIndex : 0); //default startIndex to 0, if not set
for(var i=startIndex;i';
} else {
if (options.length >=2) { // more than 2 options
return options.length + ' ' + this.nSelectedText + ' ';
} else { // 0 < x < 4
var selected = '';
$(options).each(function (index) { // each selection
var label = options[index];
if (index == options.length - 1) { // last selected
selected += label;
} else {
selected += label + ', ';
}
});
return selected + ' ';
}
}
},
buttonTitle: function (options) {// Updates the title of the button similar to the buttonText function
if (options.length === 0) { // no options
return this.nonSelectedText;
} else {
var selected = '';
$(options).each(function (index) {
var label = options[index];
if (index == options.length - 1) { // last selected
selected += label;
} else {
selected += label + ', ';
}
});
return selected;
}
},
},
constructor: PersonalisedDropdown,
buildDropdownOptions: function () { // define dropdown actions
$('li input', this.$ul).on('change', $.proxy(function (event) { // Bind the change event on the dropdown elements.
var checked = $(event.target).prop('checked') || false; // set checked value
if (this.options.selectedClass) { // Apply or unapply the configured selected class.
if (checked) { // add active class
$(event.target).parents('li')
.addClass(this.options.selectedClass);
} else { // remove active class
$(event.target).parents('li')
.removeClass(this.options.selectedClass);
}
}
var value = $(event.target).val(); // Get the changed option.
var $option = $('option').filter(function () { //Gets a select option by its value.
return $(this).val() === value;
});
if (checked) {
$option.prop('selected', true); // Select additional option.
} else {
$option.prop('selected', false); // Unselect option.
}
this.updateButtonText(); // update button
}, this));
$('li a', this.$ul).on('touchstart click', function (event) {
event.stopPropagation(); // prevents any parent handlers from being notified of the event
});
var self = this;
$($('.personalised-storylist .confirm.btn')).on('touchstart click', function (event) { // when 'choose club' button is pressed
var selection = self.getActiveSeletions(); // get selected options
localStorage[self.options.storageId] = selection; // save selected options through local storage
self.getStorylistContent(selection); // get content for selected options
});
$('.personalised-storylist-bottom > a').on('touchstart click', function (event) { // when 'refresh' is pressed
self.getStorylistContent(self.getActiveSeletions()); // get selected options
return false;
});
// Keyboard support.
this.$container.on('keydown', $.proxy(function (event) {
if ($('input[type="text"]', this.$container).is(':focus')) {
return;
}
if ((event.keyCode === 9 || event.keyCode === 27) && this.$container.hasClass('open')) { // tab or escape.
this.$button.click(); // close
} else {
var $items = $(this.$container).find("li:visible a");
if (!$items.length) { // no visible items
return;
}
var index = $items.index($items.filter(':focus'));
if (event.keyCode === 38 && index > 0) { // up arrow.
index--;
} else if (event.keyCode === 40 && index < $items.length - 1) { // down arrow.
index++;
} else if (!~index) {
index = 0;
}
var $current = $items.eq(index);
$current.focus();
if (event.keyCode === 32 || event.keyCode === 13) { //space or enter
var $checkbox = $current.find('input');
$checkbox.prop("checked", !$checkbox.prop("checked")); // select option
$checkbox.change();
}
event.stopPropagation(); // prevent parent handlers being notified
event.preventDefault(); // stop default behaviour
}
}, this));
},
// Update the button text and its title based on the currenty selected options
updateButtonText: function () {
var names = this.getActiveSeletionNames(); // get current selections
$(this.$button, this.$container).html(this.options.buttonText(names)); // Update the displayed button text.
$(this.$button, this.$container).attr('title', this.options.buttonTitle(names)); // Update the title attribute of the button.
},
// Get active selections
getActiveSeletions: function () {
var options = $('.dropdown-container li.active');
var names = [];
$(options).each(function (index) {
names.push($.trim($(this).find('input').prop('value'))); // add option to array
});
return names;
},
// Get active selections
getActiveSeletionNames: function () {
var options = $('.dropdown-container li.active');
var names = [];
$(options).each(function (index) {
names.push($.trim($(this).find('label').text())); // add option to array
});
return names;
},
// set active selections
setActiveSeletions: function () {
var selection;
if (localStorage[this.options.storageId]) { // local storage has previously been used
selection = localStorage[this.options.storageId]; // get stored values
var array = selection.split(','); // split into individual slections
$("li label").each(function (i) { // every option
var self = this;
$(self).children('input').prop('checked', false); // Deselect all options.
$(array).each(function (j) {
if ($.trim($(self).children('input').prop('value')) == array[j]) { // if option is on the list
$(self).parents('li').addClass('active');
$(self).children('input').prop('checked', true); // Select additional option.
}
});
});
} else { // no local storage
selection = '';
$("li label").each(function (i) { // every option
var self = this;
$(self).children('input').prop('checked', false); // Deselect all options.
});
}
this.getStorylistContent(selection); // get content for specified selection
},
// Get content for selection using AJAX request - this function has not been tested as there is currently no way of doing this. Therfore the code can be changed in order to retrive and display the content correctly. It has been assumed that the request will return a 'result' object. The result object will be made of a number of 'teaser' objects. The parameters used below are:
// teaser.headline - The headline of the teaser
// teaser.label - The category of the teaser, if the widhet is used for football, then this would be the club
// teaser.mediaIconClass - The icon used to disply the media icon, either Audio - "glyphicon" "glyphicon-volume-up", Video - "glyphicon" "glyphicon-facetime-video", or Photo - "glyphicon" "glyphicon-camera"
// teaser.updatedTime - How long since the article was last updated
// The URL used in the request is an example only, it is assumed that the selected options will be passed as a comma seperated list. The number of stories will also be passed as a parameter.
// If no clubs are sent as parameters for the AJAX request then teasers from all categories should be returned.
// Any of the described can be changed if neccessary.
getStorylistContent: function (selection) {
var self = this;
$(".personalised-storylist .alert-danger").remove(); // remove error message
$(".personalised-storylist-content").append('Loading content...
'); // add loading message
if (selection == '') {
var options = $('.dropdown-container li a');
var names = [];
$(options).each(function (index) {
names.push($.trim($(this).find('input').prop('value'))); // add all categories to array
});
selection = names;
}
$.ajax({
url: "/ajax?action=getPersonalisedStories&selection=" + selection + "&length=" + this.options.numberOfStories + "&site=" +this.options.site,
success: function (result) {
jsonresult = jQuery.parseJSON(result);
if (jsonresult != '' || typeof jsonresult !== "undefined") { // successfull response
$('.personalised-storylist .teaser').removeClass('fade-in'); // hide current content
$(".personalised-storylist-content").children().remove(); // remove current content
$(jsonresult).each(function (index, teaser) { // for each teaser
var even = "";
if(index%2 == 0){ // if even
even = "even";
}
// add new content to DOM
$(".personalised-storylist-content").append(''+ teaser['teaser.updatedTime'] +'
');
};
$(document).ready(function () {
var srcAttr = options.srcAttr;
if ($.isFunction(srcAttr)) {
srcAttr = 'data-src';
}
$('br[' + dataLazyTag + '],span[' + dataLazyTag + ']').each(function (index, origElem) {
var attrs = origElem.attributes,
el = document.createElement($(origElem).attr(dataLazyTag)),
i;
for (i = 0; i < attrs.length; i++) {
var attr = attrs[i];
if (attr.specified) {
var attrName = attr.nodeName,
attrValue = attr.nodeValue;
if (attrName.charAt(0) !== '<') {
if (attrName === 'src') {
el.setAttribute(srcAttr, attrValue);
} else {
el.setAttribute(attrName, attrValue);
}
}
}
}
while (origElem.hasChildNodes()) {
var child = origElem.removeChild(origElem.firstChild);
el.appendChild(child);
}
origElem.parentNode.replaceChild(el, origElem);
});
$(window).lazyLoadXT();
});
})(window.jQuery || window.Zepto || window.$, window, document);
/*! Lazy Load XT v1.1.0 2016-01-12
* http://ressio.github.io/lazy-load-xt
* (C) 2016 RESS.io
* Licensed under MIT */
(function ($, window, document, undefined) {
var options = $.lazyLoadXT,
srcsetSupport = (function () {
return 'srcset' in (new Image());
})(),
reUrl = /^\s*(\S*)/,
reWidth = /\S\s+(\d+)w/,
reHeight = /\S\s+(\d+)h/,
reDpr = /\S\s+([\d\.]+)x/,
infty = [0, Infinity],
one = [0, 1],
srcsetOptions = {
srcsetAttr: 'data-srcset',
srcsetExtended: true,
srcsetBaseAttr: 'data-srcset-base',
srcsetExtAttr: 'data-srcset-ext'
},
viewport = {
w: 0,
h: 0,
x: 0
},
property,
limit;
for (property in srcsetOptions) {
if (options[property] === undefined) {
options[property] = srcsetOptions[property];
}
}
options.selector += ',img[' + options.srcsetAttr + ']';
function mathFilter(array, action) {
return Math[action].apply(null, $.map(array, function (item) {
return item[property];
}));
}
function compareMax(item) {
return item[property] >= viewport[property] || item[property] === limit;
}
function compareMin(item) {
return item[property] === limit;
}
function parseSrcset($el) {
var srcset = $el.attr(options.srcsetAttr);
if (!srcset) {
return false;
}
var list = $.map(srcset.replace(/(\s[\d.]+[whx]),/g, '$1 @,@ ').split(' @,@ '), function (item) {
return {
url: reUrl.exec(item)[1],
w: parseFloat((reWidth.exec(item) || infty)[1]),
h: parseFloat((reHeight.exec(item) || infty)[1]),
x: parseFloat((reDpr.exec(item) || one)[1])
};
});
if (!list.length) {
return false;
}
var documentElement = document.documentElement,
whx,
src;
viewport = {
w: window.innerWidth || documentElement.clientWidth,
h: window.innerHeight || documentElement.clientHeight,
x: window.devicePixelRatio || 1
};
// Notice for DOMtastic users: currently $.grep method is not implemented in DOMtastic
for (whx in viewport) {
property = whx;
limit = mathFilter(list, 'max');
list = $.grep(list, compareMax);
}
for (whx in viewport) {
property = whx;
limit = mathFilter(list, 'min');
list = $.grep(list, compareMin);
}
src = list[0].url;
if (options.srcsetExtended) {
src = ($el.attr(options.srcsetBaseAttr) || '') + src + ($el.attr(options.srcsetExtAttr) || '');
}
return src;
}
$(document).on('lazyshow', 'img', function (e, $el) {
var srcset = $el.attr(options.srcsetAttr);
if (srcset) {
if (!options.srcsetExtended && srcsetSupport) {
$el.attr('srcset', srcset);
} else {
$el.lazyLoadXT.srcAttr = parseSrcset;
}
}
});
})(window.jQuery || window.Zepto || window.$, window, document);
/*jslint browser:true */
/*jshint browser:true, jquery:true */
(function ($) {
'use strict';
var options = $.lazyLoadXT,
widgetAttr = options.widgetAttr || 'data-lazy-widget',
reComment = //;
options.selector += ',[' + widgetAttr + ']';
$(document).on('lazyshow', '[' + widgetAttr + ']', function () {
var $this = $(this),
$target = $this,
id = $this.attr(widgetAttr),
match;
if (id) {
$target = $('#' + id);
}
if ($target.length) {
match = reComment.exec($target.html());
if (match) {
$target.replaceWith($.trim(match[1]));
}
}
$this.triggerHandler('load');
});
})(window.jQuery || window.Zepto || window.$);
/*!
* ScrollMagic v2.0.5 (2015-04-29)
* The javascript library for magical scroll interactions.
* (c) 2015 Jan Paepke (@janpaepke)
* Project Website: http://scrollmagic.io
*
* @version 2.0.5
* @license Dual licensed under MIT license and GPL.
* @author Jan Paepke - e-mail@janpaepke.de
*
* @file ScrollMagic main library.
*/
/**
* @namespace ScrollMagic
*/
(function (root, factory) {
if (typeof define === 'function' && define.amd) {
// AMD. Register as an anonymous module.
define(factory);
} else if (typeof exports === 'object') {
// CommonJS
module.exports = factory();
} else {
// Browser global
root.ScrollMagic = factory();
}
}(this, function () {
"use strict";
var ScrollMagic = function () {
_util.log(2, '(COMPATIBILITY NOTICE) -> As of ScrollMagic 2.0.0 you need to use \'new ScrollMagic.Controller()\' to create a new controller instance. Use \'new ScrollMagic.Scene()\' to instance a scene.');
};
ScrollMagic.version = "2.0.5";
// TODO: temporary workaround for chrome's scroll jitter bug
window.addEventListener("mousewheel", function () {});
// global const
var PIN_SPACER_ATTRIBUTE = "data-scrollmagic-pin-spacer";
/**
* The main class that is needed once per scroll container.
*
* @class
*
* @example
* // basic initialization
* var controller = new ScrollMagic.Controller();
*
* // passing options
* var controller = new ScrollMagic.Controller({container: "#myContainer", loglevel: 3});
*
* @param {object} [options] - An object containing one or more options for the controller.
* @param {(string|object)} [options.container=window] - A selector, DOM object that references the main container for scrolling.
* @param {boolean} [options.vertical=true] - Sets the scroll mode to vertical (`true`) or horizontal (`false`) scrolling.
* @param {object} [options.globalSceneOptions={}] - These options will be passed to every Scene that is added to the controller using the addScene method. For more information on Scene options see {@link ScrollMagic.Scene}.
* @param {number} [options.loglevel=2] Loglevel for debugging. Note that logging is disabled in the minified version of ScrollMagic.
** `0` => silent
** `1` => errors
** `2` => errors, warnings
** `3` => errors, warnings, debuginfo
* @param {boolean} [options.refreshInterval=100] - Some changes don't call events by default, like changing the container size or moving a scene trigger element.
This interval polls these parameters to fire the necessary events.
If you don't use custom containers, trigger elements or have static layouts, where the positions of the trigger elements don't change, you can set this to 0 disable interval checking and improve performance.
*
*/
ScrollMagic.Controller = function (options) {
/*
* ----------------------------------------------------------------
* settings
* ----------------------------------------------------------------
*/
var
NAMESPACE = 'ScrollMagic.Controller',
SCROLL_DIRECTION_FORWARD = 'FORWARD',
SCROLL_DIRECTION_REVERSE = 'REVERSE',
SCROLL_DIRECTION_PAUSED = 'PAUSED',
DEFAULT_OPTIONS = CONTROLLER_OPTIONS.defaults;
/*
* ----------------------------------------------------------------
* private vars
* ----------------------------------------------------------------
*/
var
Controller = this,
_options = _util.extend({}, DEFAULT_OPTIONS, options),
_sceneObjects = [],
_updateScenesOnNextCycle = false,
// can be boolean (true => all scenes) or an array of scenes to be updated
_scrollPos = 0,
_scrollDirection = SCROLL_DIRECTION_PAUSED,
_isDocument = true,
_viewPortSize = 0,
_enabled = true,
_updateTimeout, _refreshTimeout;
/*
* ----------------------------------------------------------------
* private functions
* ----------------------------------------------------------------
*/
/**
* Internal constructor function of the ScrollMagic Controller
* @private
*/
var construct = function () {
for (var key in _options) {
if (!DEFAULT_OPTIONS.hasOwnProperty(key)) {
log(2, "WARNING: Unknown option \"" + key + "\"");
delete _options[key];
}
}
_options.container = _util.get.elements(_options.container)[0];
// check ScrollContainer
if (!_options.container) {
log(1, "ERROR creating object " + NAMESPACE + ": No valid scroll container supplied");
throw NAMESPACE + " init failed."; // cancel
}
_isDocument = _options.container === window || _options.container === document.body || !document.body.contains(_options.container);
// normalize to window
if (_isDocument) {
_options.container = window;
}
// update container size immediately
_viewPortSize = getViewportSize();
// set event handlers
_options.container.addEventListener("resize", onChange);
_options.container.addEventListener("scroll", onChange);
_options.refreshInterval = parseInt(_options.refreshInterval) || DEFAULT_OPTIONS.refreshInterval;
scheduleRefresh();
log(3, "added new " + NAMESPACE + " controller (v" + ScrollMagic.version + ")");
};
/**
* Schedule the next execution of the refresh function
* @private
*/
var scheduleRefresh = function () {
if (_options.refreshInterval > 0) {
_refreshTimeout = window.setTimeout(refresh, _options.refreshInterval);
}
};
/**
* Default function to get scroll pos - overwriteable using `Controller.scrollPos(newFunction)`
* @private
*/
var getScrollPos = function () {
return _options.vertical ? _util.get.scrollTop(_options.container) : _util.get.scrollLeft(_options.container);
};
/**
* Returns the current viewport Size (width vor horizontal, height for vertical)
* @private
*/
var getViewportSize = function () {
return _options.vertical ? _util.get.height(_options.container) : _util.get.width(_options.container);
};
/**
* Default function to set scroll pos - overwriteable using `Controller.scrollTo(newFunction)`
* Make available publicly for pinned mousewheel workaround.
* @private
*/
var setScrollPos = this._setScrollPos = function (pos) {
if (_options.vertical) {
if (_isDocument) {
window.scrollTo(_util.get.scrollLeft(), pos);
} else {
_options.container.scrollTop = pos;
}
} else {
if (_isDocument) {
window.scrollTo(pos, _util.get.scrollTop());
} else {
_options.container.scrollLeft = pos;
}
}
};
/**
* Handle updates in cycles instead of on scroll (performance)
* @private
*/
var updateScenes = function () {
if (_enabled && _updateScenesOnNextCycle) {
// determine scenes to update
var scenesToUpdate = _util.type.Array(_updateScenesOnNextCycle) ? _updateScenesOnNextCycle : _sceneObjects.slice(0);
// reset scenes
_updateScenesOnNextCycle = false;
var oldScrollPos = _scrollPos;
// update scroll pos now instead of onChange, as it might have changed since scheduling (i.e. in-browser smooth scroll)
_scrollPos = Controller.scrollPos();
var deltaScroll = _scrollPos - oldScrollPos;
if (deltaScroll !== 0) { // scroll position changed?
_scrollDirection = (deltaScroll > 0) ? SCROLL_DIRECTION_FORWARD : SCROLL_DIRECTION_REVERSE;
}
// reverse order of scenes if scrolling reverse
if (_scrollDirection === SCROLL_DIRECTION_REVERSE) {
scenesToUpdate.reverse();
}
// update scenes
scenesToUpdate.forEach(function (scene, index) {
log(3, "updating Scene " + (index + 1) + "/" + scenesToUpdate.length + " (" + _sceneObjects.length + " total)");
scene.update(true);
});
if (scenesToUpdate.length === 0 && _options.loglevel >= 3) {
log(3, "updating 0 Scenes (nothing added to controller)");
}
}
};
/**
* Initializes rAF callback
* @private
*/
var debounceUpdate = function () {
_updateTimeout = _util.rAF(updateScenes);
};
/**
* Handles Container changes
* @private
*/
var onChange = function (e) {
log(3, "event fired causing an update:", e.type);
if (e.type == "resize") {
// resize
_viewPortSize = getViewportSize();
_scrollDirection = SCROLL_DIRECTION_PAUSED;
}
// schedule update
if (_updateScenesOnNextCycle !== true) {
_updateScenesOnNextCycle = true;
debounceUpdate();
}
};
var refresh = function () {
if (!_isDocument) {
// simulate resize event. Only works for viewport relevant param (performance)
if (_viewPortSize != getViewportSize()) {
var resizeEvent;
try {
resizeEvent = new Event('resize', {
bubbles: false,
cancelable: false
});
} catch (e) { // stupid IE
resizeEvent = document.createEvent("Event");
resizeEvent.initEvent("resize", false, false);
}
_options.container.dispatchEvent(resizeEvent);
}
}
_sceneObjects.forEach(function (scene, index) { // refresh all scenes
scene.refresh();
});
scheduleRefresh();
};
/**
* Send a debug message to the console.
* provided publicly with _log for plugins
* @private
*
* @param {number} loglevel - The loglevel required to initiate output for the message.
* @param {...mixed} output - One or more variables that should be passed to the console.
*/
var log = this._log = function (loglevel, output) {
if (_options.loglevel >= loglevel) {
Array.prototype.splice.call(arguments, 1, 0, "(" + NAMESPACE + ") ->");
_util.log.apply(window, arguments);
}
};
// for scenes we have getters for each option, but for the controller we don't, so we need to make it available externally for plugins
this._options = _options;
/**
* Sort scenes in ascending order of their start offset.
* @private
*
* @param {array} ScenesArray - an array of ScrollMagic Scenes that should be sorted
* @return {array} The sorted array of Scenes.
*/
var sortScenes = function (ScenesArray) {
if (ScenesArray.length <= 1) {
return ScenesArray;
} else {
var scenes = ScenesArray.slice(0);
scenes.sort(function (a, b) {
return a.scrollOffset() > b.scrollOffset() ? 1 : -1;
});
return scenes;
}
};
/**
* ----------------------------------------------------------------
* public functions
* ----------------------------------------------------------------
*/
/**
* Add one ore more scene(s) to the controller.
* This is the equivalent to `Scene.addTo(controller)`.
* @public
* @example
* // with a previously defined scene
* controller.addScene(scene);
*
* // with a newly created scene.
* controller.addScene(new ScrollMagic.Scene({duration : 0}));
*
* // adding multiple scenes
* controller.addScene([scene, scene2, new ScrollMagic.Scene({duration : 0})]);
*
* @param {(ScrollMagic.Scene|array)} newScene - ScrollMagic Scene or Array of Scenes to be added to the controller.
* @return {Controller} Parent object for chaining.
*/
this.addScene = function (newScene) {
if (_util.type.Array(newScene)) {
newScene.forEach(function (scene, index) {
Controller.addScene(scene);
});
} else if (newScene instanceof ScrollMagic.Scene) {
if (newScene.controller() !== Controller) {
newScene.addTo(Controller);
} else if (_sceneObjects.indexOf(newScene) < 0) {
// new scene
_sceneObjects.push(newScene); // add to array
_sceneObjects = sortScenes(_sceneObjects); // sort
newScene.on("shift.controller_sort", function () { // resort whenever scene moves
_sceneObjects = sortScenes(_sceneObjects);
});
// insert Global defaults.
for (var key in _options.globalSceneOptions) {
if (newScene[key]) {
newScene[key].call(newScene, _options.globalSceneOptions[key]);
}
}
log(3, "adding Scene (now " + _sceneObjects.length + " total)");
}
} else {
log(1, "ERROR: invalid argument supplied for '.addScene()'");
}
return Controller;
};
/**
* Remove one ore more scene(s) from the controller.
* This is the equivalent to `Scene.remove()`.
* @public
* @example
* // remove a scene from the controller
* controller.removeScene(scene);
*
* // remove multiple scenes from the controller
* controller.removeScene([scene, scene2, scene3]);
*
* @param {(ScrollMagic.Scene|array)} Scene - ScrollMagic Scene or Array of Scenes to be removed from the controller.
* @returns {Controller} Parent object for chaining.
*/
this.removeScene = function (Scene) {
if (_util.type.Array(Scene)) {
Scene.forEach(function (scene, index) {
Controller.removeScene(scene);
});
} else {
var index = _sceneObjects.indexOf(Scene);
if (index > -1) {
Scene.off("shift.controller_sort");
_sceneObjects.splice(index, 1);
log(3, "removing Scene (now " + _sceneObjects.length + " left)");
Scene.remove();
}
}
return Controller;
};
/**
* Update one ore more scene(s) according to the scroll position of the container.
* This is the equivalent to `Scene.update()`.
* The update method calculates the scene's start and end position (based on the trigger element, trigger hook, duration and offset) and checks it against the current scroll position of the container.
* It then updates the current scene state accordingly (or does nothing, if the state is already correct) – Pins will be set to their correct position and tweens will be updated to their correct progress.
* _**Note:** This method gets called constantly whenever Controller detects a change. The only application for you is if you change something outside of the realm of ScrollMagic, like moving the trigger or changing tween parameters._
* @public
* @example
* // update a specific scene on next cycle
* controller.updateScene(scene);
*
* // update a specific scene immediately
* controller.updateScene(scene, true);
*
* // update multiple scenes scene on next cycle
* controller.updateScene([scene1, scene2, scene3]);
*
* @param {ScrollMagic.Scene} Scene - ScrollMagic Scene or Array of Scenes that is/are supposed to be updated.
* @param {boolean} [immediately=false] - If `true` the update will be instant, if `false` it will wait until next update cycle.
This is useful when changing multiple properties of the scene - this way it will only be updated once all new properties are set (updateScenes).
* @return {Controller} Parent object for chaining.
*/
this.updateScene = function (Scene, immediately) {
if (_util.type.Array(Scene)) {
Scene.forEach(function (scene, index) {
Controller.updateScene(scene, immediately);
});
} else {
if (immediately) {
Scene.update(true);
} else if (_updateScenesOnNextCycle !== true && Scene instanceof ScrollMagic.Scene) { // if _updateScenesOnNextCycle is true, all connected scenes are already scheduled for update
// prep array for next update cycle
_updateScenesOnNextCycle = _updateScenesOnNextCycle || [];
if (_updateScenesOnNextCycle.indexOf(Scene) == -1) {
_updateScenesOnNextCycle.push(Scene);
}
_updateScenesOnNextCycle = sortScenes(_updateScenesOnNextCycle); // sort
debounceUpdate();
}
}
return Controller;
};
/**
* Updates the controller params and calls updateScene on every scene, that is attached to the controller.
* See `Controller.updateScene()` for more information about what this means.
* In most cases you will not need this function, as it is called constantly, whenever ScrollMagic detects a state change event, like resize or scroll.
* The only application for this method is when ScrollMagic fails to detect these events.
* One application is with some external scroll libraries (like iScroll) that move an internal container to a negative offset instead of actually scrolling. In this case the update on the controller needs to be called whenever the child container's position changes.
* For this case there will also be the need to provide a custom function to calculate the correct scroll position. See `Controller.scrollPos()` for details.
* @public
* @example
* // update the controller on next cycle (saves performance due to elimination of redundant updates)
* controller.update();
*
* // update the controller immediately
* controller.update(true);
*
* @param {boolean} [immediately=false] - If `true` the update will be instant, if `false` it will wait until next update cycle (better performance)
* @return {Controller} Parent object for chaining.
*/
this.update = function (immediately) {
onChange({
type: "resize"
}); // will update size and set _updateScenesOnNextCycle to true
if (immediately) {
updateScenes();
}
return Controller;
};
/**
* Scroll to a numeric scroll offset, a DOM element, the start of a scene or provide an alternate method for scrolling.
* For vertical controllers it will change the top scroll offset and for horizontal applications it will change the left offset.
* @public
*
* @since 1.1.0
* @example
* // scroll to an offset of 100
* controller.scrollTo(100);
*
* // scroll to a DOM element
* controller.scrollTo("#anchor");
*
* // scroll to the beginning of a scene
* var scene = new ScrollMagic.Scene({offset: 200});
* controller.scrollTo(scene);
*
* // define a new scroll position modification function (jQuery animate instead of jump)
* controller.scrollTo(function (newScrollPos) {
* $("html, body").animate({scrollTop: newScrollPos});
* });
* controller.scrollTo(100); // call as usual, but the new function will be used instead
*
* // define a new scroll function with an additional parameter
* controller.scrollTo(function (newScrollPos, message) {
* console.log(message);
* $(this).animate({scrollTop: newScrollPos});
* });
* // call as usual, but supply an extra parameter to the defined custom function
* controller.scrollTo(100, "my message");
*
* // define a new scroll function with an additional parameter containing multiple variables
* controller.scrollTo(function (newScrollPos, options) {
* someGlobalVar = options.a + options.b;
* $(this).animate({scrollTop: newScrollPos});
* });
* // call as usual, but supply an extra parameter containing multiple options
* controller.scrollTo(100, {a: 1, b: 2});
*
* // define a new scroll function with a callback supplied as an additional parameter
* controller.scrollTo(function (newScrollPos, callback) {
* $(this).animate({scrollTop: newScrollPos}, 400, "swing", callback);
* });
* // call as usual, but supply an extra parameter, which is used as a callback in the previously defined custom scroll function
* controller.scrollTo(100, function() {
* console.log("scroll has finished.");
* });
*
* @param {mixed} scrollTarget - The supplied argument can be one of these types:
* 1. `number` -> The container will scroll to this new scroll offset.
* 2. `string` or `object` -> Can be a selector or a DOM object.
* The container will scroll to the position of this element.
* 3. `ScrollMagic Scene` -> The container will scroll to the start of this scene.
* 4. `function` -> This function will be used for future scroll position modifications.
* This provides a way for you to change the behaviour of scrolling and adding new behaviour like animation. The function receives the new scroll position as a parameter and a reference to the container element using `this`.
* It may also optionally receive an optional additional parameter (see below)
* _**NOTE:**
* All other options will still work as expected, using the new function to scroll._
* @param {mixed} [additionalParameter] - If a custom scroll function was defined (see above 4.), you may want to supply additional parameters to it, when calling it. You can do this using this parameter – see examples for details. Please note, that this parameter will have no effect, if you use the default scrolling function.
* @returns {Controller} Parent object for chaining.
*/
this.scrollTo = function (scrollTarget, additionalParameter) {
if (_util.type.Number(scrollTarget)) { // excecute
setScrollPos.call(_options.container, scrollTarget, additionalParameter);
} else if (scrollTarget instanceof ScrollMagic.Scene) { // scroll to scene
if (scrollTarget.controller() === Controller) { // check if the controller is associated with this scene
Controller.scrollTo(scrollTarget.scrollOffset(), additionalParameter);
} else {
log(2, "scrollTo(): The supplied scene does not belong to this controller. Scroll cancelled.", scrollTarget);
}
} else if (_util.type.Function(scrollTarget)) { // assign new scroll function
setScrollPos = scrollTarget;
} else { // scroll to element
var elem = _util.get.elements(scrollTarget)[0];
if (elem) {
// if parent is pin spacer, use spacer position instead so correct start position is returned for pinned elements.
while (elem.parentNode.hasAttribute(PIN_SPACER_ATTRIBUTE)) {
elem = elem.parentNode;
}
var
param = _options.vertical ? "top" : "left",
// which param is of interest ?
containerOffset = _util.get.offset(_options.container),
// container position is needed because element offset is returned in relation to document, not in relation to container.
elementOffset = _util.get.offset(elem);
if (!_isDocument) { // container is not the document root, so substract scroll Position to get correct trigger element position relative to scrollcontent
containerOffset[param] -= Controller.scrollPos();
}
Controller.scrollTo(elementOffset[param] - containerOffset[param], additionalParameter);
} else {
log(2, "scrollTo(): The supplied argument is invalid. Scroll cancelled.", scrollTarget);
}
}
return Controller;
};
/**
* **Get** the current scrollPosition or **Set** a new method to calculate it.
* -> **GET**:
* When used as a getter this function will return the current scroll position.
* To get a cached value use Controller.info("scrollPos"), which will be updated in the update cycle.
* For vertical controllers it will return the top scroll offset and for horizontal applications it will return the left offset.
*
* -> **SET**:
* When used as a setter this method prodes a way to permanently overwrite the controller's scroll position calculation.
* A typical usecase is when the scroll position is not reflected by the containers scrollTop or scrollLeft values, but for example by the inner offset of a child container.
* Moving a child container inside a parent is a commonly used method for several scrolling frameworks, including iScroll.
* By providing an alternate calculation function you can make sure ScrollMagic receives the correct scroll position.
* Please also bear in mind that your function should return y values for vertical scrolls an x for horizontals.
*
* To change the current scroll position please use `Controller.scrollTo()`.
* @public
*
* @example
* // get the current scroll Position
* var scrollPos = controller.scrollPos();
*
* // set a new scroll position calculation method
* controller.scrollPos(function () {
* return this.info("vertical") ? -mychildcontainer.y : -mychildcontainer.x
* });
*
* @param {function} [scrollPosMethod] - The function to be used for the scroll position calculation of the container.
* @returns {(number|Controller)} Current scroll position or parent object for chaining.
*/
this.scrollPos = function (scrollPosMethod) {
if (!arguments.length) { // get
return getScrollPos.call(Controller);
} else { // set
if (_util.type.Function(scrollPosMethod)) {
getScrollPos = scrollPosMethod;
} else {
log(2, "Provided value for method 'scrollPos' is not a function. To change the current scroll position use 'scrollTo()'.");
}
}
return Controller;
};
/**
* **Get** all infos or one in particular about the controller.
* @public
* @example
* // returns the current scroll position (number)
* var scrollPos = controller.info("scrollPos");
*
* // returns all infos as an object
* var infos = controller.info();
*
* @param {string} [about] - If passed only this info will be returned instead of an object containing all.
Valid options are:
** `"size"` => the current viewport size of the container
** `"vertical"` => true if vertical scrolling, otherwise false
** `"scrollPos"` => the current scroll position
** `"scrollDirection"` => the last known direction of the scroll
** `"container"` => the container element
** `"isDocument"` => true if container element is the document.
* @returns {(mixed|object)} The requested info(s).
*/
this.info = function (about) {
var values = {
size: _viewPortSize,
// contains height or width (in regard to orientation);
vertical: _options.vertical,
scrollPos: _scrollPos,
scrollDirection: _scrollDirection,
container: _options.container,
isDocument: _isDocument
};
if (!arguments.length) { // get all as an object
return values;
} else if (values[about] !== undefined) {
return values[about];
} else {
log(1, "ERROR: option \"" + about + "\" is not available");
return;
}
};
/**
* **Get** or **Set** the current loglevel option value.
* @public
*
* @example
* // get the current value
* var loglevel = controller.loglevel();
*
* // set a new value
* controller.loglevel(3);
*
* @param {number} [newLoglevel] - The new loglevel setting of the Controller. `[0-3]`
* @returns {(number|Controller)} Current loglevel or parent object for chaining.
*/
this.loglevel = function (newLoglevel) {
if (!arguments.length) { // get
return _options.loglevel;
} else if (_options.loglevel != newLoglevel) { // set
_options.loglevel = newLoglevel;
}
return Controller;
};
/**
* **Get** or **Set** the current enabled state of the controller.
* This can be used to disable all Scenes connected to the controller without destroying or removing them.
* @public
*
* @example
* // get the current value
* var enabled = controller.enabled();
*
* // disable the controller
* controller.enabled(false);
*
* @param {boolean} [newState] - The new enabled state of the controller `true` or `false`.
* @returns {(boolean|Controller)} Current enabled state or parent object for chaining.
*/
this.enabled = function (newState) {
if (!arguments.length) { // get
return _enabled;
} else if (_enabled != newState) { // set
_enabled = !! newState;
Controller.updateScene(_sceneObjects, true);
}
return Controller;
};
/**
* Destroy the Controller, all Scenes and everything.
* @public
*
* @example
* // without resetting the scenes
* controller = controller.destroy();
*
* // with scene reset
* controller = controller.destroy(true);
*
* @param {boolean} [resetScenes=false] - If `true` the pins and tweens (if existent) of all scenes will be reset.
* @returns {null} Null to unset handler variables.
*/
this.destroy = function (resetScenes) {
window.clearTimeout(_refreshTimeout);
var i = _sceneObjects.length;
while (i--) {
_sceneObjects[i].destroy(resetScenes);
}
_options.container.removeEventListener("resize", onChange);
_options.container.removeEventListener("scroll", onChange);
_util.cAF(_updateTimeout);
log(3, "destroyed " + NAMESPACE + " (reset: " + (resetScenes ? "true" : "false") + ")");
return null;
};
// INIT
construct();
return Controller;
};
// store pagewide controller options
var CONTROLLER_OPTIONS = {
defaults: {
container: window,
vertical: true,
globalSceneOptions: {},
loglevel: 2,
refreshInterval: 100
}
};
/*
* method used to add an option to ScrollMagic Scenes.
*/
ScrollMagic.Controller.addOption = function (name, defaultValue) {
CONTROLLER_OPTIONS.defaults[name] = defaultValue;
};
// instance extension function for plugins
ScrollMagic.Controller.extend = function (extension) {
var oldClass = this;
ScrollMagic.Controller = function () {
oldClass.apply(this, arguments);
this.$super = _util.extend({}, this); // copy parent state
return extension.apply(this, arguments) || this;
};
_util.extend(ScrollMagic.Controller, oldClass); // copy properties
ScrollMagic.Controller.prototype = oldClass.prototype; // copy prototype
ScrollMagic.Controller.prototype.constructor = ScrollMagic.Controller; // restore constructor
};
/**
* A Scene defines where the controller should react and how.
*
* @class
*
* @example
* // create a standard scene and add it to a controller
* new ScrollMagic.Scene()
* .addTo(controller);
*
* // create a scene with custom options and assign a handler to it.
* var scene = new ScrollMagic.Scene({
* duration: 100,
* offset: 200,
* triggerHook: "onEnter",
* reverse: false
* });
*
* @param {object} [options] - Options for the Scene. The options can be updated at any time.
Instead of setting the options for each scene individually you can also set them globally in the controller as the controllers `globalSceneOptions` option. The object accepts the same properties as the ones below.
When a scene is added to the controller the options defined using the Scene constructor will be overwritten by those set in `globalSceneOptions`.
* @param {(number|function)} [options.duration=0] - The duration of the scene.
If `0` tweens will auto-play when reaching the scene start point, pins will be pinned indefinetly starting at the start position.
A function retuning the duration value is also supported. Please see `Scene.duration()` for details.
* @param {number} [options.offset=0] - Offset Value for the Trigger Position. If no triggerElement is defined this will be the scroll distance from the start of the page, after which the scene will start.
* @param {(string|object)} [options.triggerElement=null] - Selector or DOM object that defines the start of the scene. If undefined the scene will start right at the start of the page (unless an offset is set).
* @param {(number|string)} [options.triggerHook="onCenter"] - Can be a number between 0 and 1 defining the position of the trigger Hook in relation to the viewport.
Can also be defined using a string:
** `"onEnter"` => `1`
** `"onCenter"` => `0.5`
** `"onLeave"` => `0`
* @param {boolean} [options.reverse=true] - Should the scene reverse, when scrolling up?
* @param {number} [options.loglevel=2] - Loglevel for debugging. Note that logging is disabled in the minified version of ScrollMagic.
** `0` => silent
** `1` => errors
** `2` => errors, warnings
** `3` => errors, warnings, debuginfo
*
*/
ScrollMagic.Scene = function (options) {
/*
* ----------------------------------------------------------------
* settings
* ----------------------------------------------------------------
*/
var
NAMESPACE = 'ScrollMagic.Scene',
SCENE_STATE_BEFORE = 'BEFORE',
SCENE_STATE_DURING = 'DURING',
SCENE_STATE_AFTER = 'AFTER',
DEFAULT_OPTIONS = SCENE_OPTIONS.defaults;
/*
* ----------------------------------------------------------------
* private vars
* ----------------------------------------------------------------
*/
var
Scene = this,
_options = _util.extend({}, DEFAULT_OPTIONS, options),
_state = SCENE_STATE_BEFORE,
_progress = 0,
_scrollOffset = {
start: 0,
end: 0
},
// reflects the controllers's scroll position for the start and end of the scene respectively
_triggerPos = 0,
_enabled = true,
_durationUpdateMethod, _controller;
/**
* Internal constructor function of the ScrollMagic Scene
* @private
*/
var construct = function () {
for (var key in _options) { // check supplied options
if (!DEFAULT_OPTIONS.hasOwnProperty(key)) {
log(2, "WARNING: Unknown option \"" + key + "\"");
delete _options[key];
}
}
// add getters/setters for all possible options
for (var optionName in DEFAULT_OPTIONS) {
addSceneOption(optionName);
}
// validate all options
validateOption();
};
/*
* ----------------------------------------------------------------
* Event Management
* ----------------------------------------------------------------
*/
var _listeners = {};
/**
* Scene start event.
* Fires whenever the scroll position its the starting point of the scene.
* It will also fire when scrolling back up going over the start position of the scene. If you want something to happen only when scrolling down/right, use the scrollDirection parameter passed to the callback.
*
* For details on this event and the order in which it is fired, please review the {@link Scene.progress} method.
*
* @event ScrollMagic.Scene#start
*
* @example
* scene.on("start", function (event) {
* console.log("Hit start point of scene.");
* });
*
* @property {object} event - The event Object passed to each callback
* @property {string} event.type - The name of the event
* @property {Scene} event.target - The Scene object that triggered this event
* @property {number} event.progress - Reflects the current progress of the scene
* @property {string} event.state - The current state of the scene `"BEFORE"` or `"DURING"`
* @property {string} event.scrollDirection - Indicates which way we are scrolling `"PAUSED"`, `"FORWARD"` or `"REVERSE"`
*/
/**
* Scene end event.
* Fires whenever the scroll position its the ending point of the scene.
* It will also fire when scrolling back up from after the scene and going over its end position. If you want something to happen only when scrolling down/right, use the scrollDirection parameter passed to the callback.
*
* For details on this event and the order in which it is fired, please review the {@link Scene.progress} method.
*
* @event ScrollMagic.Scene#end
*
* @example
* scene.on("end", function (event) {
* console.log("Hit end point of scene.");
* });
*
* @property {object} event - The event Object passed to each callback
* @property {string} event.type - The name of the event
* @property {Scene} event.target - The Scene object that triggered this event
* @property {number} event.progress - Reflects the current progress of the scene
* @property {string} event.state - The current state of the scene `"DURING"` or `"AFTER"`
* @property {string} event.scrollDirection - Indicates which way we are scrolling `"PAUSED"`, `"FORWARD"` or `"REVERSE"`
*/
/**
* Scene enter event.
* Fires whenever the scene enters the "DURING" state.
* Keep in mind that it doesn't matter if the scene plays forward or backward: This event always fires when the scene enters its active scroll timeframe, regardless of the scroll-direction.
*
* For details on this event and the order in which it is fired, please review the {@link Scene.progress} method.
*
* @event ScrollMagic.Scene#enter
*
* @example
* scene.on("enter", function (event) {
* console.log("Scene entered.");
* });
*
* @property {object} event - The event Object passed to each callback
* @property {string} event.type - The name of the event
* @property {Scene} event.target - The Scene object that triggered this event
* @property {number} event.progress - Reflects the current progress of the scene
* @property {string} event.state - The current state of the scene - always `"DURING"`
* @property {string} event.scrollDirection - Indicates which way we are scrolling `"PAUSED"`, `"FORWARD"` or `"REVERSE"`
*/
/**
* Scene leave event.
* Fires whenever the scene's state goes from "DURING" to either "BEFORE" or "AFTER".
* Keep in mind that it doesn't matter if the scene plays forward or backward: This event always fires when the scene leaves its active scroll timeframe, regardless of the scroll-direction.
*
* For details on this event and the order in which it is fired, please review the {@link Scene.progress} method.
*
* @event ScrollMagic.Scene#leave
*
* @example
* scene.on("leave", function (event) {
* console.log("Scene left.");
* });
*
* @property {object} event - The event Object passed to each callback
* @property {string} event.type - The name of the event
* @property {Scene} event.target - The Scene object that triggered this event
* @property {number} event.progress - Reflects the current progress of the scene
* @property {string} event.state - The current state of the scene `"BEFORE"` or `"AFTER"`
* @property {string} event.scrollDirection - Indicates which way we are scrolling `"PAUSED"`, `"FORWARD"` or `"REVERSE"`
*/
/**
* Scene update event.
* Fires whenever the scene is updated (but not necessarily changes the progress).
*
* @event ScrollMagic.Scene#update
*
* @example
* scene.on("update", function (event) {
* console.log("Scene updated.");
* });
*
* @property {object} event - The event Object passed to each callback
* @property {string} event.type - The name of the event
* @property {Scene} event.target - The Scene object that triggered this event
* @property {number} event.startPos - The starting position of the scene (in relation to the conainer)
* @property {number} event.endPos - The ending position of the scene (in relation to the conainer)
* @property {number} event.scrollPos - The current scroll position of the container
*/
/**
* Scene progress event.
* Fires whenever the progress of the scene changes.
*
* For details on this event and the order in which it is fired, please review the {@link Scene.progress} method.
*
* @event ScrollMagic.Scene#progress
*
* @example
* scene.on("progress", function (event) {
* console.log("Scene progress changed to " + event.progress);
* });
*
* @property {object} event - The event Object passed to each callback
* @property {string} event.type - The name of the event
* @property {Scene} event.target - The Scene object that triggered this event
* @property {number} event.progress - Reflects the current progress of the scene
* @property {string} event.state - The current state of the scene `"BEFORE"`, `"DURING"` or `"AFTER"`
* @property {string} event.scrollDirection - Indicates which way we are scrolling `"PAUSED"`, `"FORWARD"` or `"REVERSE"`
*/
/**
* Scene change event.
* Fires whenvever a property of the scene is changed.
*
* @event ScrollMagic.Scene#change
*
* @example
* scene.on("change", function (event) {
* console.log("Scene Property \"" + event.what + "\" changed to " + event.newval);
* });
*
* @property {object} event - The event Object passed to each callback
* @property {string} event.type - The name of the event
* @property {Scene} event.target - The Scene object that triggered this event
* @property {string} event.what - Indicates what value has been changed
* @property {mixed} event.newval - The new value of the changed property
*/
/**
* Scene shift event.
* Fires whenvever the start or end **scroll offset** of the scene change.
* This happens explicitely, when one of these values change: `offset`, `duration` or `triggerHook`.
* It will fire implicitly when the `triggerElement` changes, if the new element has a different position (most cases).
* It will also fire implicitly when the size of the container changes and the triggerHook is anything other than `onLeave`.
*
* @event ScrollMagic.Scene#shift
* @since 1.1.0
*
* @example
* scene.on("shift", function (event) {
* console.log("Scene moved, because the " + event.reason + " has changed.)");
* });
*
* @property {object} event - The event Object passed to each callback
* @property {string} event.type - The name of the event
* @property {Scene} event.target - The Scene object that triggered this event
* @property {string} event.reason - Indicates why the scene has shifted
*/
/**
* Scene destroy event.
* Fires whenvever the scene is destroyed.
* This can be used to tidy up custom behaviour used in events.
*
* @event ScrollMagic.Scene#destroy
* @since 1.1.0
*
* @example
* scene.on("enter", function (event) {
* // add custom action
* $("#my-elem").left("200");
* })
* .on("destroy", function (event) {
* // reset my element to start position
* if (event.reset) {
* $("#my-elem").left("0");
* }
* });
*
* @property {object} event - The event Object passed to each callback
* @property {string} event.type - The name of the event
* @property {Scene} event.target - The Scene object that triggered this event
* @property {boolean} event.reset - Indicates if the destroy method was called with reset `true` or `false`.
*/
/**
* Scene add event.
* Fires when the scene is added to a controller.
* This is mostly used by plugins to know that change might be due.
*
* @event ScrollMagic.Scene#add
* @since 2.0.0
*
* @example
* scene.on("add", function (event) {
* console.log('Scene was added to a new controller.');
* });
*
* @property {object} event - The event Object passed to each callback
* @property {string} event.type - The name of the event
* @property {Scene} event.target - The Scene object that triggered this event
* @property {boolean} event.controller - The controller object the scene was added to.
*/
/**
* Scene remove event.
* Fires when the scene is removed from a controller.
* This is mostly used by plugins to know that change might be due.
*
* @event ScrollMagic.Scene#remove
* @since 2.0.0
*
* @example
* scene.on("remove", function (event) {
* console.log('Scene was removed from its controller.');
* });
*
* @property {object} event - The event Object passed to each callback
* @property {string} event.type - The name of the event
* @property {Scene} event.target - The Scene object that triggered this event
*/
/**
* Add one ore more event listener.
* The callback function will be fired at the respective event, and an object containing relevant data will be passed to the callback.
* @method ScrollMagic.Scene#on
*
* @example
* function callback (event) {
* console.log("Event fired! (" + event.type + ")");
* }
* // add listeners
* scene.on("change update progress start end enter leave", callback);
*
* @param {string} names - The name or names of the event the callback should be attached to.
* @param {function} callback - A function that should be executed, when the event is dispatched. An event object will be passed to the callback.
* @returns {Scene} Parent object for chaining.
*/
this.on = function (names, callback) {
if (_util.type.Function(callback)) {
names = names.trim().split(' ');
names.forEach(function (fullname) {
var
nameparts = fullname.split('.'),
eventname = nameparts[0],
namespace = nameparts[1];
if (eventname != "*") { // disallow wildcards
if (!_listeners[eventname]) {
_listeners[eventname] = [];
}
_listeners[eventname].push({
namespace: namespace || '',
callback: callback
});
}
});
} else {
log(1, "ERROR when calling '.on()': Supplied callback for '" + names + "' is not a valid function!");
}
return Scene;
};
/**
* Remove one or more event listener.
* @method ScrollMagic.Scene#off
*
* @example
* function callback (event) {
* console.log("Event fired! (" + event.type + ")");
* }
* // add listeners
* scene.on("change update", callback);
* // remove listeners
* scene.off("change update", callback);
*
* @param {string} names - The name or names of the event that should be removed.
* @param {function} [callback] - A specific callback function that should be removed. If none is passed all callbacks to the event listener will be removed.
* @returns {Scene} Parent object for chaining.
*/
this.off = function (names, callback) {
if (!names) {
log(1, "ERROR: Invalid event name supplied.");
return Scene;
}
names = names.trim().split(' ');
names.forEach(function (fullname, key) {
var
nameparts = fullname.split('.'),
eventname = nameparts[0],
namespace = nameparts[1] || '',
removeList = eventname === '*' ? Object.keys(_listeners) : [eventname];
removeList.forEach(function (remove) {
var
list = _listeners[remove] || [],
i = list.length;
while (i--) {
var listener = list[i];
if (listener && (namespace === listener.namespace || namespace === '*') && (!callback || callback == listener.callback)) {
list.splice(i, 1);
}
}
if (!list.length) {
delete _listeners[remove];
}
});
});
return Scene;
};
/**
* Trigger an event.
* @method ScrollMagic.Scene#trigger
*
* @example
* this.trigger("change");
*
* @param {string} name - The name of the event that should be triggered.
* @param {object} [vars] - An object containing info that should be passed to the callback.
* @returns {Scene} Parent object for chaining.
*/
this.trigger = function (name, vars) {
if (name) {
var
nameparts = name.trim().split('.'),
eventname = nameparts[0],
namespace = nameparts[1],
listeners = _listeners[eventname];
log(3, 'event fired:', eventname, vars ? "->" : '', vars || '');
if (listeners) {
listeners.forEach(function (listener, key) {
if (!namespace || namespace === listener.namespace) {
listener.callback.call(Scene, new ScrollMagic.Event(eventname, listener.namespace, Scene, vars));
}
});
}
} else {
log(1, "ERROR: Invalid event name supplied.");
}
return Scene;
};
// set event listeners
Scene.on("change.internal", function (e) {
if (e.what !== "loglevel" && e.what !== "tweenChanges") { // no need for a scene update scene with these options...
if (e.what === "triggerElement") {
updateTriggerElementPosition();
} else if (e.what === "reverse") { // the only property left that may have an impact on the current scene state. Everything else is handled by the shift event.
Scene.update();
}
}
}).on("shift.internal", function (e) {
updateScrollOffset();
Scene.update(); // update scene to reflect new position
});
/**
* Send a debug message to the console.
* @private
* but provided publicly with _log for plugins
*
* @param {number} loglevel - The loglevel required to initiate output for the message.
* @param {...mixed} output - One or more variables that should be passed to the console.
*/
var log = this._log = function (loglevel, output) {
if (_options.loglevel >= loglevel) {
Array.prototype.splice.call(arguments, 1, 0, "(" + NAMESPACE + ") ->");
_util.log.apply(window, arguments);
}
};
/**
* Add the scene to a controller.
* This is the equivalent to `Controller.addScene(scene)`.
* @method ScrollMagic.Scene#addTo
*
* @example
* // add a scene to a ScrollMagic Controller
* scene.addTo(controller);
*
* @param {ScrollMagic.Controller} controller - The controller to which the scene should be added.
* @returns {Scene} Parent object for chaining.
*/
this.addTo = function (controller) {
if (!(controller instanceof ScrollMagic.Controller)) {
log(1, "ERROR: supplied argument of 'addTo()' is not a valid ScrollMagic Controller");
} else if (_controller != controller) {
// new controller
if (_controller) { // was associated to a different controller before, so remove it...
_controller.removeScene(Scene);
}
_controller = controller;
validateOption();
updateDuration(true);
updateTriggerElementPosition(true);
updateScrollOffset();
_controller.info("container").addEventListener('resize', onContainerResize);
controller.addScene(Scene);
Scene.trigger("add", {
controller: _controller
});
log(3, "added " + NAMESPACE + " to controller");
Scene.update();
}
return Scene;
};
/**
* **Get** or **Set** the current enabled state of the scene.
* This can be used to disable this scene without removing or destroying it.
* @method ScrollMagic.Scene#enabled
*
* @example
* // get the current value
* var enabled = scene.enabled();
*
* // disable the scene
* scene.enabled(false);
*
* @param {boolean} [newState] - The new enabled state of the scene `true` or `false`.
* @returns {(boolean|Scene)} Current enabled state or parent object for chaining.
*/
this.enabled = function (newState) {
if (!arguments.length) { // get
return _enabled;
} else if (_enabled != newState) { // set
_enabled = !! newState;
Scene.update(true);
}
return Scene;
};
/**
* Remove the scene from the controller.
* This is the equivalent to `Controller.removeScene(scene)`.
* The scene will not be updated anymore until you readd it to a controller.
* To remove the pin or the tween you need to call removeTween() or removePin() respectively.
* @method ScrollMagic.Scene#remove
* @example
* // remove the scene from its controller
* scene.remove();
*
* @returns {Scene} Parent object for chaining.
*/
this.remove = function () {
if (_controller) {
_controller.info("container").removeEventListener('resize', onContainerResize);
var tmpParent = _controller;
_controller = undefined;
tmpParent.removeScene(Scene);
Scene.trigger("remove");
log(3, "removed " + NAMESPACE + " from controller");
}
return Scene;
};
/**
* Destroy the scene and everything.
* @method ScrollMagic.Scene#destroy
* @example
* // destroy the scene without resetting the pin and tween to their initial positions
* scene = scene.destroy();
*
* // destroy the scene and reset the pin and tween
* scene = scene.destroy(true);
*
* @param {boolean} [reset=false] - If `true` the pin and tween (if existent) will be reset.
* @returns {null} Null to unset handler variables.
*/
this.destroy = function (reset) {
Scene.trigger("destroy", {
reset: reset
});
Scene.remove();
Scene.off("*.*");
log(3, "destroyed " + NAMESPACE + " (reset: " + (reset ? "true" : "false") + ")");
return null;
};
/**
* Updates the Scene to reflect the current state.
* This is the equivalent to `Controller.updateScene(scene, immediately)`.
* The update method calculates the scene's start and end position (based on the trigger element, trigger hook, duration and offset) and checks it against the current scroll position of the container.
* It then updates the current scene state accordingly (or does nothing, if the state is already correct) – Pins will be set to their correct position and tweens will be updated to their correct progress.
* This means an update doesn't necessarily result in a progress change. The `progress` event will be fired if the progress has indeed changed between this update and the last.
* _**NOTE:** This method gets called constantly whenever ScrollMagic detects a change. The only application for you is if you change something outside of the realm of ScrollMagic, like moving the trigger or changing tween parameters._
* @method ScrollMagic.Scene#update
* @example
* // update the scene on next tick
* scene.update();
*
* // update the scene immediately
* scene.update(true);
*
* @fires Scene.update
*
* @param {boolean} [immediately=false] - If `true` the update will be instant, if `false` it will wait until next update cycle (better performance).
* @returns {Scene} Parent object for chaining.
*/
this.update = function (immediately) {
if (_controller) {
if (immediately) {
if (_controller.enabled() && _enabled) {
var
scrollPos = _controller.info("scrollPos"),
newProgress;
if (_options.duration > 0) {
newProgress = (scrollPos - _scrollOffset.start) / (_scrollOffset.end - _scrollOffset.start);
} else {
newProgress = scrollPos >= _scrollOffset.start ? 1 : 0;
}
Scene.trigger("update", {
startPos: _scrollOffset.start,
endPos: _scrollOffset.end,
scrollPos: scrollPos
});
Scene.progress(newProgress);
} else if (_pin && _state === SCENE_STATE_DURING) {
updatePinState(true); // unpin in position
}
} else {
_controller.updateScene(Scene, false);
}
}
return Scene;
};
/**
* Updates dynamic scene variables like the trigger element position or the duration.
* This method is automatically called in regular intervals from the controller. See {@link ScrollMagic.Controller} option `refreshInterval`.
*
* You can call it to minimize lag, for example when you intentionally change the position of the triggerElement.
* If you don't it will simply be updated in the next refresh interval of the container, which is usually sufficient.
*
* @method ScrollMagic.Scene#refresh
* @since 1.1.0
* @example
* scene = new ScrollMagic.Scene({triggerElement: "#trigger"});
*
* // change the position of the trigger
* $("#trigger").css("top", 500);
* // immediately let the scene know of this change
* scene.refresh();
*
* @fires {@link Scene.shift}, if the trigger element position or the duration changed
* @fires {@link Scene.change}, if the duration changed
*
* @returns {Scene} Parent object for chaining.
*/
this.refresh = function () {
updateDuration();
updateTriggerElementPosition();
// update trigger element position
return Scene;
};
/**
* **Get** or **Set** the scene's progress.
* Usually it shouldn't be necessary to use this as a setter, as it is set automatically by scene.update().
* The order in which the events are fired depends on the duration of the scene:
* 1. Scenes with `duration == 0`:
* Scenes that have no duration by definition have no ending. Thus the `end` event will never be fired.
* When the trigger position of the scene is passed the events are always fired in this order:
* `enter`, `start`, `progress` when scrolling forward
* and
* `progress`, `start`, `leave` when scrolling in reverse
* 2. Scenes with `duration > 0`:
* Scenes with a set duration have a defined start and end point.
* When scrolling past the start position of the scene it will fire these events in this order:
* `enter`, `start`, `progress`
* When continuing to scroll and passing the end point it will fire these events:
* `progress`, `end`, `leave`
* When reversing through the end point these events are fired:
* `enter`, `end`, `progress`
* And when continuing to scroll past the start position in reverse it will fire:
* `progress`, `start`, `leave`
* In between start and end the `progress` event will be called constantly, whenever the progress changes.
*
* In short:
* `enter` events will always trigger **before** the progress update and `leave` envents will trigger **after** the progress update.
* `start` and `end` will always trigger at their respective position.
*
* Please review the event descriptions for details on the events and the event object that is passed to the callback.
*
* @method ScrollMagic.Scene#progress
* @example
* // get the current scene progress
* var progress = scene.progress();
*
* // set new scene progress
* scene.progress(0.3);
*
* @fires {@link Scene.enter}, when used as setter
* @fires {@link Scene.start}, when used as setter
* @fires {@link Scene.progress}, when used as setter
* @fires {@link Scene.end}, when used as setter
* @fires {@link Scene.leave}, when used as setter
*
* @param {number} [progress] - The new progress value of the scene `[0-1]`.
* @returns {number} `get` - Current scene progress.
* @returns {Scene} `set` - Parent object for chaining.
*/
this.progress = function (progress) {
if (!arguments.length) { // get
return _progress;
} else { // set
var
doUpdate = false,
oldState = _state,
scrollDirection = _controller ? _controller.info("scrollDirection") : 'PAUSED',
reverseOrForward = _options.reverse || progress >= _progress;
if (_options.duration === 0) {
// zero duration scenes
doUpdate = _progress != progress;
_progress = progress < 1 && reverseOrForward ? 0 : 1;
_state = _progress === 0 ? SCENE_STATE_BEFORE : SCENE_STATE_DURING;
} else {
// scenes with start and end
if (progress < 0 && _state !== SCENE_STATE_BEFORE && reverseOrForward) {
// go back to initial state
_progress = 0;
_state = SCENE_STATE_BEFORE;
doUpdate = true;
} else if (progress >= 0 && progress < 1 && reverseOrForward) {
_progress = progress;
_state = SCENE_STATE_DURING;
doUpdate = true;
} else if (progress >= 1 && _state !== SCENE_STATE_AFTER) {
_progress = 1;
_state = SCENE_STATE_AFTER;
doUpdate = true;
} else if (_state === SCENE_STATE_DURING && !reverseOrForward) {
updatePinState(); // in case we scrolled backwards mid-scene and reverse is disabled => update the pin position, so it doesn't move back as well.
}
}
if (doUpdate) {
// fire events
var
eventVars = {
progress: _progress,
state: _state,
scrollDirection: scrollDirection
},
stateChanged = _state != oldState;
var trigger = function (eventName) { // tmp helper to simplify code
Scene.trigger(eventName, eventVars);
};
if (stateChanged) { // enter events
if (oldState !== SCENE_STATE_DURING) {
trigger("enter");
trigger(oldState === SCENE_STATE_BEFORE ? "start" : "end");
}
}
trigger("progress");
if (stateChanged) { // leave events
if (_state !== SCENE_STATE_DURING) {
trigger(_state === SCENE_STATE_BEFORE ? "start" : "end");
trigger("leave");
}
}
}
return Scene;
}
};
/**
* Update the start and end scrollOffset of the container.
* The positions reflect what the controller's scroll position will be at the start and end respectively.
* Is called, when:
* - Scene event "change" is called with: offset, triggerHook, duration
* - scroll container event "resize" is called
* - the position of the triggerElement changes
* - the controller changes -> addTo()
* @private
*/
var updateScrollOffset = function () {
_scrollOffset = {
start: _triggerPos + _options.offset
};
if (_controller && _options.triggerElement) {
// take away triggerHook portion to get relative to top
_scrollOffset.start -= _controller.info("size") * _options.triggerHook;
}
_scrollOffset.end = _scrollOffset.start + _options.duration;
};
/**
* Updates the duration if set to a dynamic function.
* This method is called when the scene is added to a controller and in regular intervals from the controller through scene.refresh().
*
* @fires {@link Scene.change}, if the duration changed
* @fires {@link Scene.shift}, if the duration changed
*
* @param {boolean} [suppressEvents=false] - If true the shift event will be suppressed.
* @private
*/
var updateDuration = function (suppressEvents) {
// update duration
if (_durationUpdateMethod) {
var varname = "duration";
if (changeOption(varname, _durationUpdateMethod.call(Scene)) && !suppressEvents) { // set
Scene.trigger("change", {
what: varname,
newval: _options[varname]
});
Scene.trigger("shift", {
reason: varname
});
}
}
};
/**
* Updates the position of the triggerElement, if present.
* This method is called ...
* - ... when the triggerElement is changed
* - ... when the scene is added to a (new) controller
* - ... in regular intervals from the controller through scene.refresh().
*
* @fires {@link Scene.shift}, if the position changed
*
* @param {boolean} [suppressEvents=false] - If true the shift event will be suppressed.
* @private
*/
var updateTriggerElementPosition = function (suppressEvents) {
var
elementPos = 0,
telem = _options.triggerElement;
if (_controller && telem) {
var
controllerInfo = _controller.info(),
containerOffset = _util.get.offset(controllerInfo.container),
// container position is needed because element offset is returned in relation to document, not in relation to container.
param = controllerInfo.vertical ? "top" : "left"; // which param is of interest ?
// if parent is spacer, use spacer position instead so correct start position is returned for pinned elements.
while (telem.parentNode.hasAttribute(PIN_SPACER_ATTRIBUTE)) {
telem = telem.parentNode;
}
var elementOffset = _util.get.offset(telem);
if (!controllerInfo.isDocument) { // container is not the document root, so substract scroll Position to get correct trigger element position relative to scrollcontent
containerOffset[param] -= _controller.scrollPos();
}
elementPos = elementOffset[param] - containerOffset[param];
}
var changed = elementPos != _triggerPos;
_triggerPos = elementPos;
if (changed && !suppressEvents) {
Scene.trigger("shift", {
reason: "triggerElementPosition"
});
}
};
/**
* Trigger a shift event, when the container is resized and the triggerHook is > 1.
* @private
*/
var onContainerResize = function (e) {
if (_options.triggerHook > 0) {
Scene.trigger("shift", {
reason: "containerResize"
});
}
};
var _validate = _util.extend(SCENE_OPTIONS.validate, {
// validation for duration handled internally for reference to private var _durationMethod
duration: function (val) {
if (_util.type.String(val) && val.match(/^(\.|\d)*\d+%$/)) {
// percentage value
var perc = parseFloat(val) / 100;
val = function () {
return _controller ? _controller.info("size") * perc : 0;
};
}
if (_util.type.Function(val)) {
// function
_durationUpdateMethod = val;
try {
val = parseFloat(_durationUpdateMethod());
} catch (e) {
val = -1; // will cause error below
}
}
// val has to be float
val = parseFloat(val);
if (!_util.type.Number(val) || val < 0) {
if (_durationUpdateMethod) {
_durationUpdateMethod = undefined;
throw ["Invalid return value of supplied function for option \"duration\":", val];
} else {
throw ["Invalid value for option \"duration\":", val];
}
}
return val;
}
});
/**
* Checks the validity of a specific or all options and reset to default if neccessary.
* @private
*/
var validateOption = function (check) {
check = arguments.length ? [check] : Object.keys(_validate);
check.forEach(function (optionName, key) {
var value;
if (_validate[optionName]) { // there is a validation method for this option
try { // validate value
value = _validate[optionName](_options[optionName]);
} catch (e) { // validation failed -> reset to default
value = DEFAULT_OPTIONS[optionName];
var logMSG = _util.type.String(e) ? [e] : e;
if (_util.type.Array(logMSG)) {
logMSG[0] = "ERROR: " + logMSG[0];
logMSG.unshift(1); // loglevel 1 for error msg
log.apply(this, logMSG);
} else {
log(1, "ERROR: Problem executing validation callback for option '" + optionName + "':", e.message);
}
} finally {
_options[optionName] = value;
}
}
});
};
/**
* Helper used by the setter/getters for scene options
* @private
*/
var changeOption = function (varname, newval) {
var
changed = false,
oldval = _options[varname];
if (_options[varname] != newval) {
_options[varname] = newval;
validateOption(varname); // resets to default if necessary
changed = oldval != _options[varname];
}
return changed;
};
// generate getters/setters for all options
var addSceneOption = function (optionName) {
if (!Scene[optionName]) {
Scene[optionName] = function (newVal) {
if (!arguments.length) { // get
return _options[optionName];
} else {
if (optionName === "duration") { // new duration is set, so any previously set function must be unset
_durationUpdateMethod = undefined;
}
if (changeOption(optionName, newVal)) { // set
Scene.trigger("change", {
what: optionName,
newval: _options[optionName]
});
if (SCENE_OPTIONS.shifts.indexOf(optionName) > -1) {
Scene.trigger("shift", {
reason: optionName
});
}
}
}
return Scene;
};
}
};
/**
* **Get** or **Set** the duration option value.
* As a setter it also accepts a function returning a numeric value.
* This is particularly useful for responsive setups.
*
* The duration is updated using the supplied function every time `Scene.refresh()` is called, which happens periodically from the controller (see ScrollMagic.Controller option `refreshInterval`).
* _**NOTE:** Be aware that it's an easy way to kill performance, if you supply a function that has high CPU demand.
* Even for size and position calculations it is recommended to use a variable to cache the value. (see example)
* This counts double if you use the same function for multiple scenes._
*
* @method ScrollMagic.Scene#duration
* @example
* // get the current duration value
* var duration = scene.duration();
*
* // set a new duration
* scene.duration(300);
*
* // use a function to automatically adjust the duration to the window height.
* var durationValueCache;
* function getDuration () {
* return durationValueCache;
* }
* function updateDuration (e) {
* durationValueCache = window.innerHeight;
* }
* $(window).on("resize", updateDuration); // update the duration when the window size changes
* $(window).triggerHandler("resize"); // set to initial value
* scene.duration(getDuration); // supply duration method
*
* @fires {@link Scene.change}, when used as setter
* @fires {@link Scene.shift}, when used as setter
* @param {(number|function)} [newDuration] - The new duration of the scene.
* @returns {number} `get` - Current scene duration.
* @returns {Scene} `set` - Parent object for chaining.
*/
/**
* **Get** or **Set** the offset option value.
* @method ScrollMagic.Scene#offset
* @example
* // get the current offset
* var offset = scene.offset();
*
* // set a new offset
* scene.offset(100);
*
* @fires {@link Scene.change}, when used as setter
* @fires {@link Scene.shift}, when used as setter
* @param {number} [newOffset] - The new offset of the scene.
* @returns {number} `get` - Current scene offset.
* @returns {Scene} `set` - Parent object for chaining.
*/
/**
* **Get** or **Set** the triggerElement option value.
* Does **not** fire `Scene.shift`, because changing the trigger Element doesn't necessarily mean the start position changes. This will be determined in `Scene.refresh()`, which is automatically triggered.
* @method ScrollMagic.Scene#triggerElement
* @example
* // get the current triggerElement
* var triggerElement = scene.triggerElement();
*
* // set a new triggerElement using a selector
* scene.triggerElement("#trigger");
* // set a new triggerElement using a DOM object
* scene.triggerElement(document.getElementById("trigger"));
*
* @fires {@link Scene.change}, when used as setter
* @param {(string|object)} [newTriggerElement] - The new trigger element for the scene.
* @returns {(string|object)} `get` - Current triggerElement.
* @returns {Scene} `set` - Parent object for chaining.
*/
/**
* **Get** or **Set** the triggerHook option value.
* @method ScrollMagic.Scene#triggerHook
* @example
* // get the current triggerHook value
* var triggerHook = scene.triggerHook();
*
* // set a new triggerHook using a string
* scene.triggerHook("onLeave");
* // set a new triggerHook using a number
* scene.triggerHook(0.7);
*
* @fires {@link Scene.change}, when used as setter
* @fires {@link Scene.shift}, when used as setter
* @param {(number|string)} [newTriggerHook] - The new triggerHook of the scene. See {@link Scene} parameter description for value options.
* @returns {number} `get` - Current triggerHook (ALWAYS numerical).
* @returns {Scene} `set` - Parent object for chaining.
*/
/**
* **Get** or **Set** the reverse option value.
* @method ScrollMagic.Scene#reverse
* @example
* // get the current reverse option
* var reverse = scene.reverse();
*
* // set new reverse option
* scene.reverse(false);
*
* @fires {@link Scene.change}, when used as setter
* @param {boolean} [newReverse] - The new reverse setting of the scene.
* @returns {boolean} `get` - Current reverse option value.
* @returns {Scene} `set` - Parent object for chaining.
*/
/**
* **Get** or **Set** the loglevel option value.
* @method ScrollMagic.Scene#loglevel
* @example
* // get the current loglevel
* var loglevel = scene.loglevel();
*
* // set new loglevel
* scene.loglevel(3);
*
* @fires {@link Scene.change}, when used as setter
* @param {number} [newLoglevel] - The new loglevel setting of the scene. `[0-3]`
* @returns {number} `get` - Current loglevel.
* @returns {Scene} `set` - Parent object for chaining.
*/
/**
* **Get** the associated controller.
* @method ScrollMagic.Scene#controller
* @example
* // get the controller of a scene
* var controller = scene.controller();
*
* @returns {ScrollMagic.Controller} Parent controller or `undefined`
*/
this.controller = function () {
return _controller;
};
/**
* **Get** the current state.
* @method ScrollMagic.Scene#state
* @example
* // get the current state
* var state = scene.state();
*
* @returns {string} `"BEFORE"`, `"DURING"` or `"AFTER"`
*/
this.state = function () {
return _state;
};
/**
* **Get** the current scroll offset for the start of the scene.
* Mind, that the scrollOffset is related to the size of the container, if `triggerHook` is bigger than `0` (or `"onLeave"`).
* This means, that resizing the container or changing the `triggerHook` will influence the scene's start offset.
* @method ScrollMagic.Scene#scrollOffset
* @example
* // get the current scroll offset for the start and end of the scene.
* var start = scene.scrollOffset();
* var end = scene.scrollOffset() + scene.duration();
* console.log("the scene starts at", start, "and ends at", end);
*
* @returns {number} The scroll offset (of the container) at which the scene will trigger. Y value for vertical and X value for horizontal scrolls.
*/
this.scrollOffset = function () {
return _scrollOffset.start;
};
/**
* **Get** the trigger position of the scene (including the value of the `offset` option).
* @method ScrollMagic.Scene#triggerPosition
* @example
* // get the scene's trigger position
* var triggerPosition = scene.triggerPosition();
*
* @returns {number} Start position of the scene. Top position value for vertical and left position value for horizontal scrolls.
*/
this.triggerPosition = function () {
var pos = _options.offset; // the offset is the basis
if (_controller) {
// get the trigger position
if (_options.triggerElement) {
// Element as trigger
pos += _triggerPos;
} else {
// return the height of the triggerHook to start at the beginning
pos += _controller.info("size") * Scene.triggerHook();
}
}
return pos;
};
var
_pin, _pinOptions;
Scene.on("shift.internal", function (e) {
var durationChanged = e.reason === "duration";
if ((_state === SCENE_STATE_AFTER && durationChanged) || (_state === SCENE_STATE_DURING && _options.duration === 0)) {
// if [duration changed after a scene (inside scene progress updates pin position)] or [duration is 0, we are in pin phase and some other value changed].
updatePinState();
}
if (durationChanged) {
updatePinDimensions();
}
}).on("progress.internal", function (e) {
updatePinState();
}).on("add.internal", function (e) {
updatePinDimensions();
}).on("destroy.internal", function (e) {
Scene.removePin(e.reset);
});
/**
* Update the pin state.
* @private
*/
var updatePinState = function (forceUnpin) {
if (_pin && _controller) {
var
containerInfo = _controller.info(),
pinTarget = _pinOptions.spacer.firstChild; // may be pin element or another spacer, if cascading pins
if (!forceUnpin && _state === SCENE_STATE_DURING) { // during scene or if duration is 0 and we are past the trigger
// pinned state
if (_util.css(pinTarget, "position") != "fixed") {
// change state before updating pin spacer (position changes due to fixed collapsing might occur.)
_util.css(pinTarget, {
"position": "fixed"
});
// update pin spacer
updatePinDimensions();
}
var
fixedPos = _util.get.offset(_pinOptions.spacer, true),
// get viewport position of spacer
scrollDistance = _options.reverse || _options.duration === 0 ? containerInfo.scrollPos - _scrollOffset.start // quicker
: Math.round(_progress * _options.duration * 10) / 10; // if no reverse and during pin the position needs to be recalculated using the progress
// add scrollDistance
fixedPos[containerInfo.vertical ? "top" : "left"] += scrollDistance;
// set new values
_util.css(_pinOptions.spacer.firstChild, {
top: fixedPos.top,
left: fixedPos.left
});
} else {
// unpinned state
var
newCSS = {
position: _pinOptions.inFlow ? "relative" : "absolute",
top: 0,
left: 0
},
change = _util.css(pinTarget, "position") != newCSS.position;
if (!_pinOptions.pushFollowers) {
newCSS[containerInfo.vertical ? "top" : "left"] = _options.duration * _progress;
} else if (_options.duration > 0) { // only concerns scenes with duration
if (_state === SCENE_STATE_AFTER && parseFloat(_util.css(_pinOptions.spacer, "padding-top")) === 0) {
change = true; // if in after state but havent updated spacer yet (jumped past pin)
} else if (_state === SCENE_STATE_BEFORE && parseFloat(_util.css(_pinOptions.spacer, "padding-bottom")) === 0) { // before
change = true; // jumped past fixed state upward direction
}
}
// set new values
_util.css(pinTarget, newCSS);
if (change) {
// update pin spacer if state changed
updatePinDimensions();
}
}
}
};
/**
* Update the pin spacer and/or element size.
* The size of the spacer needs to be updated whenever the duration of the scene changes, if it is to push down following elements.
* @private
*/
var updatePinDimensions = function () {
if (_pin && _controller && _pinOptions.inFlow) { // no spacerresize, if original position is absolute
var
after = (_state === SCENE_STATE_AFTER),
before = (_state === SCENE_STATE_BEFORE),
during = (_state === SCENE_STATE_DURING),
vertical = _controller.info("vertical"),
pinTarget = _pinOptions.spacer.firstChild,
// usually the pined element but can also be another spacer (cascaded pins)
marginCollapse = _util.isMarginCollapseType(_util.css(_pinOptions.spacer, "display")),
css = {};
// set new size
// if relsize: spacer -> pin | else: pin -> spacer
if (_pinOptions.relSize.width || _pinOptions.relSize.autoFullWidth) {
if (during) {
_util.css(_pin, {
"width": _util.get.width(_pinOptions.spacer)
});
} else {
_util.css(_pin, {
"width": "100%"
});
}
} else {
// minwidth is needed for cascaded pins.
css["min-width"] = _util.get.width(vertical ? _pin : pinTarget, true, true);
css.width = during ? css["min-width"] : "auto";
}
if (_pinOptions.relSize.height) {
if (during) {
// the only padding the spacer should ever include is the duration (if pushFollowers = true), so we need to substract that.
_util.css(_pin, {
"height": _util.get.height(_pinOptions.spacer) - (_pinOptions.pushFollowers ? _options.duration : 0)
});
} else {
_util.css(_pin, {
"height": "100%"
});
}
} else {
// margin is only included if it's a cascaded pin to resolve an IE9 bug
css["min-height"] = _util.get.height(vertical ? pinTarget : _pin, true, !marginCollapse); // needed for cascading pins
css.height = during ? css["min-height"] : "auto";
}
// add space for duration if pushFollowers is true
if (_pinOptions.pushFollowers) {
css["padding" + (vertical ? "Top" : "Left")] = _options.duration * _progress;
css["padding" + (vertical ? "Bottom" : "Right")] = _options.duration * (1 - _progress);
}
_util.css(_pinOptions.spacer, css);
}
};
/**
* Updates the Pin state (in certain scenarios)
* If the controller container is not the document and we are mid-pin-phase scrolling or resizing the main document can result to wrong pin positions.
* So this function is called on resize and scroll of the document.
* @private
*/
var updatePinInContainer = function () {
if (_controller && _pin && _state === SCENE_STATE_DURING && !_controller.info("isDocument")) {
updatePinState();
}
};
/**
* Updates the Pin spacer size state (in certain scenarios)
* If container is resized during pin and relatively sized the size of the pin might need to be updated...
* So this function is called on resize of the container.
* @private
*/
var updateRelativePinSpacer = function () {
if (_controller && _pin && // well, duh
_state === SCENE_STATE_DURING && // element in pinned state?
( // is width or height relatively sized, but not in relation to body? then we need to recalc.
((_pinOptions.relSize.width || _pinOptions.relSize.autoFullWidth) && _util.get.width(window) != _util.get.width(_pinOptions.spacer.parentNode)) || (_pinOptions.relSize.height && _util.get.height(window) != _util.get.height(_pinOptions.spacer.parentNode)))) {
updatePinDimensions();
}
};
/**
* Is called, when the mousewhel is used while over a pinned element inside a div container.
* If the scene is in fixed state scroll events would be counted towards the body. This forwards the event to the scroll container.
* @private
*/
var onMousewheelOverPin = function (e) {
if (_controller && _pin && _state === SCENE_STATE_DURING && !_controller.info("isDocument")) { // in pin state
e.preventDefault();
_controller._setScrollPos(_controller.info("scrollPos") - ((e.wheelDelta || e[_controller.info("vertical") ? "wheelDeltaY" : "wheelDeltaX"]) / 3 || -e.detail * 30));
}
};
/**
* Pin an element for the duration of the tween.
* If the scene duration is 0 the element will only be unpinned, if the user scrolls back past the start position.
* Make sure only one pin is applied to an element at the same time.
* An element can be pinned multiple times, but only successively.
* _**NOTE:** The option `pushFollowers` has no effect, when the scene duration is 0._
* @method ScrollMagic.Scene#setPin
* @example
* // pin element and push all following elements down by the amount of the pin duration.
* scene.setPin("#pin");
*
* // pin element and keeping all following elements in their place. The pinned element will move past them.
* scene.setPin("#pin", {pushFollowers: false});
*
* @param {(string|object)} element - A Selector targeting an element or a DOM object that is supposed to be pinned.
* @param {object} [settings] - settings for the pin
* @param {boolean} [settings.pushFollowers=true] - If `true` following elements will be "pushed" down for the duration of the pin, if `false` the pinned element will just scroll past them.
Ignored, when duration is `0`.
* @param {string} [settings.spacerClass="scrollmagic-pin-spacer"] - Classname of the pin spacer element, which is used to replace the element.
*
* @returns {Scene} Parent object for chaining.
*/
this.setPin = function (element, settings) {
var
defaultSettings = {
pushFollowers: true,
spacerClass: "scrollmagic-pin-spacer"
};
settings = _util.extend({}, defaultSettings, settings);
// validate Element
element = _util.get.elements(element)[0];
if (!element) {
log(1, "ERROR calling method 'setPin()': Invalid pin element supplied.");
return Scene; // cancel
} else if (_util.css(element, "position") === "fixed") {
log(1, "ERROR calling method 'setPin()': Pin does not work with elements that are positioned 'fixed'.");
return Scene; // cancel
}
if (_pin) { // preexisting pin?
if (_pin === element) {
// same pin we already have -> do nothing
return Scene; // cancel
} else {
// kill old pin
Scene.removePin();
}
}
_pin = element;
var
parentDisplay = _pin.parentNode.style.display,
boundsParams = ["top", "left", "bottom", "right", "margin", "marginLeft", "marginRight", "marginTop", "marginBottom"];
_pin.parentNode.style.display = 'none'; // hack start to force css to return stylesheet values instead of calculated px values.
var
inFlow = _util.css(_pin, "position") != "absolute",
pinCSS = _util.css(_pin, boundsParams.concat(["display"])),
sizeCSS = _util.css(_pin, ["width", "height"]);
_pin.parentNode.style.display = parentDisplay; // hack end.
if (!inFlow && settings.pushFollowers) {
log(2, "WARNING: If the pinned element is positioned absolutely pushFollowers will be disabled.");
settings.pushFollowers = false;
}
window.setTimeout(function () { // wait until all finished, because with responsive duration it will only be set after scene is added to controller
if (_pin && _options.duration === 0 && settings.pushFollowers) {
log(2, "WARNING: pushFollowers =", true, "has no effect, when scene duration is 0.");
}
}, 0);
// create spacer and insert
var
spacer = _pin.parentNode.insertBefore(document.createElement('div'), _pin),
spacerCSS = _util.extend(pinCSS, {
position: inFlow ? "relative" : "absolute",
boxSizing: "content-box",
mozBoxSizing: "content-box",
webkitBoxSizing: "content-box"
});
if (!inFlow) { // copy size if positioned absolutely, to work for bottom/right positioned elements.
_util.extend(spacerCSS, _util.css(_pin, ["width", "height"]));
}
_util.css(spacer, spacerCSS);
spacer.setAttribute(PIN_SPACER_ATTRIBUTE, "");
_util.addClass(spacer, settings.spacerClass);
// set the pin Options
_pinOptions = {
spacer: spacer,
relSize: { // save if size is defined using % values. if so, handle spacer resize differently...
width: sizeCSS.width.slice(-1) === "%",
height: sizeCSS.height.slice(-1) === "%",
autoFullWidth: sizeCSS.width === "auto" && inFlow && _util.isMarginCollapseType(pinCSS.display)
},
pushFollowers: settings.pushFollowers,
inFlow: inFlow,
// stores if the element takes up space in the document flow
};
if (!_pin.___origStyle) {
_pin.___origStyle = {};
var
pinInlineCSS = _pin.style,
copyStyles = boundsParams.concat(["width", "height", "position", "boxSizing", "mozBoxSizing", "webkitBoxSizing"]);
copyStyles.forEach(function (val) {
_pin.___origStyle[val] = pinInlineCSS[val] || "";
});
}
// if relative size, transfer it to spacer and make pin calculate it...
if (_pinOptions.relSize.width) {
_util.css(spacer, {
width: sizeCSS.width
});
}
if (_pinOptions.relSize.height) {
_util.css(spacer, {
height: sizeCSS.height
});
}
// now place the pin element inside the spacer
spacer.appendChild(_pin);
// and set new css
_util.css(_pin, {
position: inFlow ? "relative" : "absolute",
margin: "auto",
top: "auto",
left: "auto",
bottom: "auto",
right: "auto"
});
if (_pinOptions.relSize.width || _pinOptions.relSize.autoFullWidth) {
_util.css(_pin, {
boxSizing: "border-box",
mozBoxSizing: "border-box",
webkitBoxSizing: "border-box"
});
}
// add listener to document to update pin position in case controller is not the document.
window.addEventListener('scroll', updatePinInContainer);
window.addEventListener('resize', updatePinInContainer);
window.addEventListener('resize', updateRelativePinSpacer);
// add mousewheel listener to catch scrolls over fixed elements
_pin.addEventListener("mousewheel", onMousewheelOverPin);
_pin.addEventListener("DOMMouseScroll", onMousewheelOverPin);
log(3, "added pin");
// finally update the pin to init
updatePinState();
return Scene;
};
/**
* Remove the pin from the scene.
* @method ScrollMagic.Scene#removePin
* @example
* // remove the pin from the scene without resetting it (the spacer is not removed)
* scene.removePin();
*
* // remove the pin from the scene and reset the pin element to its initial position (spacer is removed)
* scene.removePin(true);
*
* @param {boolean} [reset=false] - If `false` the spacer will not be removed and the element's position will not be reset.
* @returns {Scene} Parent object for chaining.
*/
this.removePin = function (reset) {
if (_pin) {
if (_state === SCENE_STATE_DURING) {
updatePinState(true); // force unpin at position
}
if (reset || !_controller) { // if there's no controller no progress was made anyway...
var pinTarget = _pinOptions.spacer.firstChild; // usually the pin element, but may be another spacer (cascaded pins)...
if (pinTarget.hasAttribute(PIN_SPACER_ATTRIBUTE)) { // copy margins to child spacer
var
style = _pinOptions.spacer.style,
values = ["margin", "marginLeft", "marginRight", "marginTop", "marginBottom"];
margins = {};
values.forEach(function (val) {
margins[val] = style[val] || "";
});
_util.css(pinTarget, margins);
}
_pinOptions.spacer.parentNode.insertBefore(pinTarget, _pinOptions.spacer);
_pinOptions.spacer.parentNode.removeChild(_pinOptions.spacer);
if (!_pin.parentNode.hasAttribute(PIN_SPACER_ATTRIBUTE)) { // if it's the last pin for this element -> restore inline styles
// TODO: only correctly set for first pin (when cascading) - how to fix?
_util.css(_pin, _pin.___origStyle);
delete _pin.___origStyle;
}
}
window.removeEventListener('scroll', updatePinInContainer);
window.removeEventListener('resize', updatePinInContainer);
window.removeEventListener('resize', updateRelativePinSpacer);
_pin.removeEventListener("mousewheel", onMousewheelOverPin);
_pin.removeEventListener("DOMMouseScroll", onMousewheelOverPin);
_pin = undefined;
log(3, "removed pin (reset: " + (reset ? "true" : "false") + ")");
}
return Scene;
};
var
_cssClasses, _cssClassElems = [];
Scene.on("destroy.internal", function (e) {
Scene.removeClassToggle(e.reset);
});
/**
* Define a css class modification while the scene is active.
* When the scene triggers the classes will be added to the supplied element and removed, when the scene is over.
* If the scene duration is 0 the classes will only be removed if the user scrolls back past the start position.
* @method ScrollMagic.Scene#setClassToggle
* @example
* // add the class 'myclass' to the element with the id 'my-elem' for the duration of the scene
* scene.setClassToggle("#my-elem", "myclass");
*
* // add multiple classes to multiple elements defined by the selector '.classChange'
* scene.setClassToggle(".classChange", "class1 class2 class3");
*
* @param {(string|object)} element - A Selector targeting one or more elements or a DOM object that is supposed to be modified.
* @param {string} classes - One or more Classnames (separated by space) that should be added to the element during the scene.
*
* @returns {Scene} Parent object for chaining.
*/
this.setClassToggle = function (element, classes) {
var elems = _util.get.elements(element);
if (elems.length === 0 || !_util.type.String(classes)) {
log(1, "ERROR calling method 'setClassToggle()': Invalid " + (elems.length === 0 ? "element" : "classes") + " supplied.");
return Scene;
}
if (_cssClassElems.length > 0) {
// remove old ones
Scene.removeClassToggle();
}
_cssClasses = classes;
_cssClassElems = elems;
Scene.on("enter.internal_class leave.internal_class", function (e) {
var toggle = e.type === "enter" ? _util.addClass : _util.removeClass;
_cssClassElems.forEach(function (elem, key) {
toggle(elem, _cssClasses);
});
});
return Scene;
};
/**
* Remove the class binding from the scene.
* @method ScrollMagic.Scene#removeClassToggle
* @example
* // remove class binding from the scene without reset
* scene.removeClassToggle();
*
* // remove class binding and remove the changes it caused
* scene.removeClassToggle(true);
*
* @param {boolean} [reset=false] - If `false` and the classes are currently active, they will remain on the element. If `true` they will be removed.
* @returns {Scene} Parent object for chaining.
*/
this.removeClassToggle = function (reset) {
if (reset) {
_cssClassElems.forEach(function (elem, key) {
_util.removeClass(elem, _cssClasses);
});
}
Scene.off("start.internal_class end.internal_class");
_cssClasses = undefined;
_cssClassElems = [];
return Scene;
};
// INIT
construct();
return Scene;
};
// store pagewide scene options
var SCENE_OPTIONS = {
defaults: {
duration: 0,
offset: 0,
triggerElement: undefined,
triggerHook: 0.5,
reverse: true,
loglevel: 2
},
validate: {
offset: function (val) {
val = parseFloat(val);
if (!_util.type.Number(val)) {
throw ["Invalid value for option \"offset\":", val];
}
return val;
},
triggerElement: function (val) {
val = val || undefined;
if (val) {
var elem = _util.get.elements(val)[0];
if (elem) {
val = elem;
} else {
throw ["Element defined in option \"triggerElement\" was not found:", val];
}
}
return val;
},
triggerHook: function (val) {
var translate = {
"onCenter": 0.5,
"onEnter": 1,
"onLeave": 0
};
if (_util.type.Number(val)) {
val = Math.max(0, Math.min(parseFloat(val), 1)); // make sure its betweeen 0 and 1
} else if (val in translate) {
val = translate[val];
} else {
throw ["Invalid value for option \"triggerHook\": ", val];
}
return val;
},
reverse: function (val) {
return !!val; // force boolean
},
loglevel: function (val) {
val = parseInt(val);
if (!_util.type.Number(val) || val < 0 || val > 3) {
throw ["Invalid value for option \"loglevel\":", val];
}
return val;
}
},
// holder for validation methods. duration validation is handled in 'getters-setters.js'
shifts: ["duration", "offset", "triggerHook"],
// list of options that trigger a `shift` event
};
/*
* method used to add an option to ScrollMagic Scenes.
* TODO: DOC (private for dev)
*/
ScrollMagic.Scene.addOption = function (name, defaultValue, validationCallback, shifts) {
if (!(name in SCENE_OPTIONS.defaults)) {
SCENE_OPTIONS.defaults[name] = defaultValue;
SCENE_OPTIONS.validate[name] = validationCallback;
if (shifts) {
SCENE_OPTIONS.shifts.push(name);
}
} else {
ScrollMagic._util.log(1, "[static] ScrollMagic.Scene -> Cannot add Scene option '" + name + "', because it already exists.");
}
};
// instance extension function for plugins
// TODO: DOC (private for dev)
ScrollMagic.Scene.extend = function (extension) {
var oldClass = this;
ScrollMagic.Scene = function () {
oldClass.apply(this, arguments);
this.$super = _util.extend({}, this); // copy parent state
return extension.apply(this, arguments) || this;
};
_util.extend(ScrollMagic.Scene, oldClass); // copy properties
ScrollMagic.Scene.prototype = oldClass.prototype; // copy prototype
ScrollMagic.Scene.prototype.constructor = ScrollMagic.Scene; // restore constructor
};
/**
* TODO: DOCS (private for dev)
* @class
* @private
*/
ScrollMagic.Event = function (type, namespace, target, vars) {
vars = vars || {};
for (var key in vars) {
this[key] = vars[key];
}
this.type = type;
this.target = this.currentTarget = target;
this.namespace = namespace || '';
this.timeStamp = this.timestamp = Date.now();
return this;
};
/*
* TODO: DOCS (private for dev)
*/
var _util = ScrollMagic._util = (function (window) {
var U = {},
i;
/**
* ------------------------------
* internal helpers
* ------------------------------
*/
// parse float and fall back to 0.
var floatval = function (number) {
return parseFloat(number) || 0;
};
// get current style IE safe (otherwise IE would return calculated values for 'auto')
var _getComputedStyle = function (elem) {
return elem.currentStyle ? elem.currentStyle : window.getComputedStyle(elem);
};
// get element dimension (width or height)
var _dimension = function (which, elem, outer, includeMargin) {
elem = (elem === document) ? window : elem;
if (elem === window) {
includeMargin = false;
} else if (!_type.DomElement(elem)) {
return 0;
}
which = which.charAt(0).toUpperCase() + which.substr(1).toLowerCase();
var dimension = (outer ? elem['offset' + which] || elem['outer' + which] : elem['client' + which] || elem['inner' + which]) || 0;
if (outer && includeMargin) {
var style = _getComputedStyle(elem);
dimension += which === 'Height' ? floatval(style.marginTop) + floatval(style.marginBottom) : floatval(style.marginLeft) + floatval(style.marginRight);
}
return dimension;
};
// converts 'margin-top' into 'marginTop'
var _camelCase = function (str) {
return str.replace(/^[^a-z]+([a-z])/g, '$1').replace(/-([a-z])/g, function (g) {
return g[1].toUpperCase();
});
};
/**
* ------------------------------
* external helpers
* ------------------------------
*/
// extend obj – same as jQuery.extend({}, objA, objB)
U.extend = function (obj) {
obj = obj || {};
for (i = 1; i < arguments.length; i++) {
if (!arguments[i]) {
continue;
}
for (var key in arguments[i]) {
if (arguments[i].hasOwnProperty(key)) {
obj[key] = arguments[i][key];
}
}
}
return obj;
};
// check if a css display type results in margin-collapse or not
U.isMarginCollapseType = function (str) {
return ["block", "flex", "list-item", "table", "-webkit-box"].indexOf(str) > -1;
};
// implementation of requestAnimationFrame
// based on https://gist.github.com/paulirish/1579671
var
lastTime = 0,
vendors = ['ms', 'moz', 'webkit', 'o'];
var _requestAnimationFrame = window.requestAnimationFrame;
var _cancelAnimationFrame = window.cancelAnimationFrame;
// try vendor prefixes if the above doesn't work
for (i = 0; !_requestAnimationFrame && i < vendors.length; ++i) {
_requestAnimationFrame = window[vendors[i] + 'RequestAnimationFrame'];
_cancelAnimationFrame = window[vendors[i] + 'CancelAnimationFrame'] || window[vendors[i] + 'CancelRequestAnimationFrame'];
}
// fallbacks
if (!_requestAnimationFrame) {
_requestAnimationFrame = function (callback) {
var
currTime = new Date().getTime(),
timeToCall = Math.max(0, 16 - (currTime - lastTime)),
id = window.setTimeout(function () {
callback(currTime + timeToCall);
}, timeToCall);
lastTime = currTime + timeToCall;
return id;
};
}
if (!_cancelAnimationFrame) {
_cancelAnimationFrame = function (id) {
window.clearTimeout(id);
};
}
U.rAF = _requestAnimationFrame.bind(window);
U.cAF = _cancelAnimationFrame.bind(window);
var
loglevels = ["error", "warn", "log"],
console = window.console || {};
console.log = console.log ||
function () {}; // no console log, well - do nothing then...
// make sure methods for all levels exist.
for (i = 0; i < loglevels.length; i++) {
var method = loglevels[i];
if (!console[method]) {
console[method] = console.log; // prefer .log over nothing
}
}
U.log = function (loglevel) {
if (loglevel > loglevels.length || loglevel <= 0) loglevel = loglevels.length;
var now = new Date(),
time = ("0" + now.getHours()).slice(-2) + ":" + ("0" + now.getMinutes()).slice(-2) + ":" + ("0" + now.getSeconds()).slice(-2) + ":" + ("00" + now.getMilliseconds()).slice(-3),
method = loglevels[loglevel - 1],
args = Array.prototype.splice.call(arguments, 1),
func = Function.prototype.bind.call(console[method], console);
args.unshift(time);
func.apply(console, args);
};
/**
* ------------------------------
* type testing
* ------------------------------
*/
var _type = U.type = function (v) {
return Object.prototype.toString.call(v).replace(/^\[object (.+)\]$/, "$1").toLowerCase();
};
_type.String = function (v) {
return _type(v) === 'string';
};
_type.Function = function (v) {
return _type(v) === 'function';
};
_type.Array = function (v) {
return Array.isArray(v);
};
_type.Number = function (v) {
return !_type.Array(v) && (v - parseFloat(v) + 1) >= 0;
};
_type.DomElement = function (o) {
return (
typeof HTMLElement === "object" ? o instanceof HTMLElement : //DOM2
o && typeof o === "object" && o !== null && o.nodeType === 1 && typeof o.nodeName === "string");
};
/**
* ------------------------------
* DOM Element info
* ------------------------------
*/
// always returns a list of matching DOM elements, from a selector, a DOM element or an list of elements or even an array of selectors
var _get = U.get = {};
_get.elements = function (selector) {
var arr = [];
if (_type.String(selector)) {
try {
selector = document.querySelectorAll(selector);
} catch (e) { // invalid selector
return arr;
}
}
if (_type(selector) === 'nodelist' || _type.Array(selector)) {
for (var i = 0, ref = arr.length = selector.length; i < ref; i++) { // list of elements
var elem = selector[i];
arr[i] = _type.DomElement(elem) ? elem : _get.elements(elem); // if not an element, try to resolve recursively
}
} else if (_type.DomElement(selector) || selector === document || selector === window) {
arr = [selector]; // only the element
}
return arr;
};
// get scroll top value
_get.scrollTop = function (elem) {
return (elem && typeof elem.scrollTop === 'number') ? elem.scrollTop : window.pageYOffset || 0;
};
// get scroll left value
_get.scrollLeft = function (elem) {
return (elem && typeof elem.scrollLeft === 'number') ? elem.scrollLeft : window.pageXOffset || 0;
};
// get element height
_get.width = function (elem, outer, includeMargin) {
return _dimension('width', elem, outer, includeMargin);
};
// get element width
_get.height = function (elem, outer, includeMargin) {
return _dimension('height', elem, outer, includeMargin);
};
// get element position (optionally relative to viewport)
_get.offset = function (elem, relativeToViewport) {
var offset = {
top: 0,
left: 0
};
if (elem && elem.getBoundingClientRect) { // check if available
var rect = elem.getBoundingClientRect();
offset.top = rect.top;
offset.left = rect.left;
if (!relativeToViewport) { // clientRect is by default relative to viewport...
offset.top += _get.scrollTop();
offset.left += _get.scrollLeft();
}
}
return offset;
};
/**
* ------------------------------
* DOM Element manipulation
* ------------------------------
*/
U.addClass = function (elem, classname) {
if (classname) {
if (elem.classList) elem.classList.add(classname);
else elem.className += ' ' + classname;
}
};
U.removeClass = function (elem, classname) {
if (classname) {
if (elem.classList) elem.classList.remove(classname);
else elem.className = elem.className.replace(new RegExp('(^|\\b)' + classname.split(' ').join('|') + '(\\b|$)', 'gi'), ' ');
}
};
// if options is string -> returns css value
// if options is array -> returns object with css value pairs
// if options is object -> set new css values
U.css = function (elem, options) {
if (_type.String(options)) {
return _getComputedStyle(elem)[_camelCase(options)];
} else if (_type.Array(options)) {
var
obj = {},
style = _getComputedStyle(elem);
options.forEach(function (option, key) {
obj[option] = style[_camelCase(option)];
});
return obj;
} else {
for (var option in options) {
var val = options[option];
if (val == parseFloat(val)) { // assume pixel for seemingly numerical values
val += 'px';
}
elem.style[_camelCase(option)] = val;
}
}
};
return U;
}(window || {}));
ScrollMagic.Scene.prototype.addIndicators = function () {
ScrollMagic._util.log(1, '(ScrollMagic.Scene) -> ERROR calling addIndicators() due to missing Plugin \'debug.addIndicators\'. Please make sure to include plugins/debug.addIndicators.js');
return this;
}
ScrollMagic.Scene.prototype.removeIndicators = function () {
ScrollMagic._util.log(1, '(ScrollMagic.Scene) -> ERROR calling removeIndicators() due to missing Plugin \'debug.addIndicators\'. Please make sure to include plugins/debug.addIndicators.js');
return this;
}
ScrollMagic.Scene.prototype.setTween = function () {
ScrollMagic._util.log(1, '(ScrollMagic.Scene) -> ERROR calling setTween() due to missing Plugin \'animation.gsap\'. Please make sure to include plugins/animation.gsap.js');
return this;
}
ScrollMagic.Scene.prototype.removeTween = function () {
ScrollMagic._util.log(1, '(ScrollMagic.Scene) -> ERROR calling removeTween() due to missing Plugin \'animation.gsap\'. Please make sure to include plugins/animation.gsap.js');
return this;
}
ScrollMagic.Scene.prototype.setVelocity = function () {
ScrollMagic._util.log(1, '(ScrollMagic.Scene) -> ERROR calling setVelocity() due to missing Plugin \'animation.velocity\'. Please make sure to include plugins/animation.velocity.js');
return this;
}
ScrollMagic.Scene.prototype.removeVelocity = function () {
ScrollMagic._util.log(1, '(ScrollMagic.Scene) -> ERROR calling removeVelocity() due to missing Plugin \'animation.velocity\'. Please make sure to include plugins/animation.velocity.js');
return this;
}
return ScrollMagic;
}));