The Ultralink Object

When the Ultralink code runs inside of a webpage, it creates a global object named Ultralink which you can interact with to customize and control Ultralink behavior, inspect information about the running Ultralink environment and better integrate Ultralinks into your page. Below is a table of the publically exposed data and functions in the Ultralink object.

Information
versionThe Ultralink version number, as a simple to compare integer.
versionStringThe Ultralink version string.
isMobileThe current environment inside a mobile browser?
thisWebsiteThe current website this instance of Ultralink is running in.
thisURLThe current URL this instance of Ultralink is running in.
thisURLHashA SHA1 hash Ultralink.thisURL.
Options
OJust the capital letter 'O'. The full, current set of running Ultralink options. Although you can set some of these directly, it is instead best to Ultralink.setOptions() or Ultralink.start() for setting specific options.
APIVersionThe version of Ultralink Server API to make calls against.
APIInterfaceThe API endpoint on the Ultralink Server to make API calls against.
setOptions( uo, rl, onlyUnloaded )Sets the user options laid out in uo, acts on them and puts the results in Ultralink.O.
Structures
linkTypesThe current link types object.
sectionsAn array of the current known fragments for the page.
linkTypeImage( type, fSize )Returns an link type icon image URL for type and the functional size.
insightHandlersHandlers functions for insights.
Debugging
highlightFragments()Highlights all the fragments in the page and outputs the current scan selector.
Data Functions
setDataUl( el, data, key )Sets the Ultralink data 'data' for an Ultralink on the give element 'el'.
getDataUl( el, key )Gets the Ultralink data for an element 'el'.
linkForLocale( URLS, langs, countries )Returns the link for locale bias arrays 'langs' and 'countries' in the set of 'URLS'.
Ultralink Control Functions
closeUltralinkPopup()Closes any existing Ultralinks that are currently displayed.
repositionUltralink()Checks the position of the element that the current Ultralink is attached to and repositions it if it has moved.
popUltralink( uword, cm )Pulls up the Ultralink attached element 'uword'. If there are multiple Ultralinks associated with the element then you can specifiy which one to bring up with 'cm'.
Scanning
getPageContentSelectors()Returns the best, automatically calculated scan selector for the current page.
Formatting Canonizers
canonizeTitle( ti )Returns a canonized title string from 'ti'.
canonizePerson( inv )Returns a canonized person name string from 'inv'.
canonizeCompany( inv )Returns a canonized company string from 'inv'.
canonizeOrganization( org )Returns a canonized organization string from 'org'.
canonizeOrganizationAbv( org )Returns a canonized organization abbreviation string from 'org'.
degreeSimplifiersSome replacement sets to make the canonization of a degree string easier.
degreesA non-exhaustive list of degree types and their abbreviations.
canonizeDegree( deg )Returns a clean, canonized degree abbrivation string.
studySimplifiersSome replacement sets to make the canonization of a study string easier.
studiesA non-exhaustive list of various disciplines and their abbreviations.
canonizeStudy( stud )Returns a clean, canonized study abbrivation string.
Helper Functions
addToInsightDescription( d, base )A helper function for creating concatenated insight description strings.
compareValues( o, lVal, rVal )A helper function for numericCompare type insights. Evaluates lVal o rVal.
Other Functionality
loadRemoteRoots( roots, onlyUnloaded, callback )Loads the remote Ultralink Roots in the 'roots' array
start( uo, callback )Starts the Ultralink functionality with an optional 'uo' (user options) object and completion 'callback'.
Information
version
The Ultralink version number, as a simple to compare integer.
versionString
The Ultralink version string.
isMobile
The current environment inside a mobile browser?
thisWebsite
The current website this instance of Ultralink is running in.
thisURL
The current URL this instance of Ultralink is running in.
thisURLHash
A SHA1 hash Ultralink.thisURL.
Options
O
Just the capital letter 'O'. The full, current set of running Ultralink options. Although you can set some of these directly, it is instead best to Ultralink.setOptions() or Ultralink.start() for setting specific options.
APIVersion
The version of Ultralink Server API to make calls against.
APIInterface
The API endpoint on the Ultralink Server to make API calls against.
setOptions( uo, rl, onlyUnloaded )
Sets the user options laid out in uo, acts on them and puts the results in Ultralink.O.
Structures
linkTypes
The current link types object.
sections
An array of the current known fragments for the page.
linkTypeImage( type, fSize )
Returns an link type icon image URL for type and the functional size.
insightHandlers
Handlers functions for insights.
Debugging
highlightFragments()
Highlights all the fragments in the page and outputs the current scan selector.
Data Functions
setDataUl( el, data, key )
Sets the Ultralink data 'data' for an Ultralink on the give element 'el'.
getDataUl( el, key )
Gets the Ultralink data for an element 'el'.
linkForLocale( URLS, langs, countries )
Returns the link for locale bias arrays 'langs' and 'countries' in the set of 'URLS'.
Ultralink Control Functions
closeUltralinkPopup()
Closes any existing Ultralinks that are currently displayed.
repositionUltralink()
Checks the position of the element that the current Ultralink is attached to and repositions it if it has moved.
popUltralink( uword, cm )
Pulls up the Ultralink attached element 'uword'. If there are multiple Ultralinks associated with the element then you can specifiy which one to bring up with 'cm'.
Scanning
getPageContentSelectors()
Returns the best, automatically calculated scan selector for the current page.
Formatting Canonizers
canonizeTitle( ti )
Returns a canonized title string from 'ti'.
canonizePerson( inv )
Returns a canonized person name string from 'inv'.
canonizeCompany( inv )
Returns a canonized company string from 'inv'.
canonizeOrganization( org )
Returns a canonized organization string from 'org'.
canonizeOrganizationAbv( org )
Returns a canonized organization abbreviation string from 'org'.
degreeSimplifiers
Some replacement sets to make the canonization of a degree string easier.
degrees
A non-exhaustive list of degree types and their abbreviations.
canonizeDegree( deg )
Returns a clean, canonized degree abbrivation string.
studySimplifiers
Some replacement sets to make the canonization of a study string easier.
studies
A non-exhaustive list of various disciplines and their abbreviations.
canonizeStudy( stud )
Returns a clean, canonized study abbrivation string.
Helper Functions
addToInsightDescription( d, base )
A helper function for creating concatenated insight description strings.
compareValues( o, lVal, rVal )
A helper function for numericCompare type insights. Evaluates lVal o rVal.
Other Functionality
loadRemoteRoots( roots, onlyUnloaded, callback )
Loads the remote Ultralink Roots in the 'roots' array
start( uo, callback )
Starts the Ultralink functionality with an optional 'uo' (user options) object and completion 'callback'.