Methods

SPArrayChunk

Permits to cut an array into smaller blocks

SPArrayForEach

Array.forEach polyfill for IE8 (source : https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach)

SPArrayIndexOf

Array.indexOf polyfill for IE8

SPExtend

It will clone an object (see )

SPIsArray

Return true when the arg is an array

decode_b64

Permits to decode a Base 64 string

encode_b64

Permits to encode in Base 64

getLookup

Split the ID and Value

Example:

$SP().getLookup("328;#Foo"); // --> {id:328, value:"Foo"}

getURL

Return the current base URL website

regionalDateFormat

Provide the Date Format based on the user regional settings (YYYY for 4-digits Year, YY for 2-digits day, MM for 2-digits Month, M for 1-digit Month, DD for 2-digits day, D for 1-digit day) -- it's using the DatePicker iFrame (so an AJAX request)

Example:

// you'll typically need that info when parsing a date from a Date Picker field from a form
// we suppose here you're using momentjs
// eg. we want to verify start date is before end date
var startDate = $SP().formfields("Start Date").val();
var endDate = $SP().formfields("End Date").val();
$SP().regionalDateFormat(function(dateFormat) {
  // if the user settings are on French, then dateFormat = "DD/MM/YYYY"
  if (moment(startDate, dateFormat).isAfter(moment(endDate, dateFormat))) {
    alert("StartDate must be before EndDate!")
  }
})

// Here is also an example of how you can parse a string date
// -> https://gist.github.com/Aymkdn/b17903cf7786578300f04f50460ebe96

regionalSettings

Find the region settings (of the current user) defined with _layouts/regionalsetng.aspx?Type=User (lcid, cultureInfo, timeZone, calendar, alternateCalendar, workWeek, timeFormat..)

Example:

$SP().regionalSettings(function(region) {
  if (typeof region === "string") {
    // something went wrong
    console.log(region); // returns the error
  } else {
    // show the selected timezone, and the working days
    console.log("timeZone: "+region.timeZone);
    console.log("working days: "+region.workWeek.days.join(", "))
  }
})

toCurrency

It will return a number with commas, currency sign and a specific number of decimals

Example:

$SP().toCurrency(1500000); // --> $1,500,000
$SP().toCurrency(1500000,2,''); // --> 1,500,000.00

toDate

Change a Sharepoint date (as a string) to a Date Object

Example:

$SP().toDate("2012-10-31T00:00:00").getFullYear(); // 2012

toSPDate

Change a Date object into a Sharepoint date string

Example:

$SP().toSPDate(new Date(2012,9,31), true); // --> "2012-10-31 00:00:00"
$SP().toSPDate(new Date(2012,9,31)); // --> "2012-10-31"

toXSLString

Change a string into a XSL format string

Example:

$SP().toXSLString("Big Title"); // --> "Big_x0020_Title"

workflowStatusToText

Return the text related to a workflow status code

Example:

$SP().workflowStatusToText(2); // -> "In Progress"