Instance Settings

A separate GSNewsbar instance is created for each targetted division and has its own settings:

$(selector).gsnewsbar({...});

currentResult | cycleMode | cycleTime | horizontal | linkTarget | manyResults | search | title | verticalCompressed

NameTypeDefaultComments
horizontalbooleantrue Controls the orientation of the newsbar, being horizontal (true) or vertical (false).
verticalCompressedbooleanfalse Controls the how much detail is shown for a vertical newsbar, being titles only (true) or all details (false). Note that this setting has no effect on horizontal newsbars.
titlestring'' The title of the newsbar. It only appears at the top of a vertical newsbar.
string or string[]'jquery' The single term to search for, or a list of terms to cycle through.
manyResultsbooleanfalse Control how many results are returned, being few (false) or many (true).
cycleTimeenumeratedthis.cycleManual Specify the interval between cycles when multiple search terms are provided. For horizontal newsbars this is the time between individual entries, whereas for vertical newsbars it is the time between results for multiple search terms. Use one of ($.gsnewsbar.) cycleVShort (3 seconds), cycleShort (3 seconds horizontal, 10 seconds vertical), cycleMedium (5 seconds horizontal, 15 seconds vertical), cycleLong (10 seconds horizontal, 30 seconds vertical), cycleManual (5 seconds horizontal, indefinite vertical).
cycleModeenumeratedthis.cycleLinear Specify the order in which search terms are used when multiple are provided. Use either ($.gsnewsbar.) cycleRandom or cycleLinear.
linkTargetenumeratedthis.targetSelf Indicate in which window a news entry should open. Use one of ($.gsnewsbar.) targetSelf (the current window), targetBlank (a new window), targetTop (replacing all frames), or targetParent (the frameset parent window).
currentResultstring, object, element'' The jQuery selector, jQuery object, or individual element for the a container to show details about the current newsbar entry. If more than one element is selected, only the first is used. Note that this setting only applies to horizontal newsbars.

Functions

destroy | option (get) | option (set) | search | setDefaults

SignatureReturnsComments
$.gsnewsbar.setDefaults(settings)GSNewsbar object Update the default instance settings to use with all GSNewsbar instances.
$(selector).gsnewsbar('option', options)jQuery object Update the settings for the GSNewsbar instance(s) attached to the given div(s).

options (object) the collection of new settings.

$(selector).gsnewsbar('option', {search: 'cats', horizontal: false});

Since 1.1.0 - previously you used the 'change' command.
$(selector).gsnewsbar('option', name, value)jQuery object Update a particular setting for the GSNewsbar instance(s) attached to the given div(s).

name (string) the name of the setting to change;
value (any) the new value of that setting.

$(selector).gsnewsbar('option', 'search', 'cats');

Since 1.1.0.
$(selector).gsnewsbar('option', name)object or any Retrieve one or all of the current settings for the first GSNewsbar instance attached to the given div(s).

name (string, optional) the name of the setting to retrieve; omit for all settings.

var settings = $(selector).gsnewsbar('option');
var search = $(selector).gsnewsbar('option', 'search');

Since 1.1.0.
$(selector).gsnewsbar('destroy')jQuery object Remove the GSNewsbar functionality from the given div(s).
$(selector).gsnewsbar('search', terms)jQuery object Execute a new search for the GSNewsbar.

terms (string) the keywords to search for.