|
Name |
Type |
alterTextCase
|
object
|
Sets or gets the alterTextCase property used to specify the field by which tags should be sorted. Possible values are 'none', 'allLower', 'allUpper', 'firstUpper', 'titleCase'
|
disabled
|
bool
|
Enables or disables the ability to follow tag links in jqxTagCloud.
|
displayLimit
|
double
|
Sets or gets the displayLimit property used to filter highest values tags up to the number specified.
Code example
Set the displayLimit property.
$('#jqxTagCloud').jqxTagCloud({ displayLimit: 10 });
Get the displayLimit property.
var value = $('#jqxTagCloud').jqxTagCloud({ 'displayLimit' });
|
displayMember
|
string
|
Sets or gets the field name used for the tag label.
|
displayValue
|
bool
|
Sets or gets the displayValue property used to specify whether to add the tag value field after the text.
Code example
Set the displayValue property.
$('#jqxTagCloud').jqxTagCloud({ displayValue: true });
Get the displayValue property.
var value = $('#jqxTagCloud').jqxTagCloud({ 'displayValue' });
|
fontSizeUnit
|
object
|
Sets or gets the fontSizeUnit property used to set the font size unit possible values 'px', 'em', '%'
Code example
Set the fontSizeUnit property.
$('#jqxTagCloud').jqxTagCloud({ fontSizeUnit: 'em' });
Get the fontSizeUnit property.
var value = $('#jqxTagCloud').jqxTagCloud({ 'fontSizeUnit' });
|
height
|
object
|
Sets or gets the jqxTagCloud's height.
|
maxColor
|
string
|
Sets or gets the maxColor property used to specify color of the tags for the elements with highest value attribute. Together with minColor property will set color of tags in a gradient fashion depending on their value attribute towards the highest value. Possible values: all browser supported colors including rgba.
Code example
Set the maxColor property.
$('#jqxTagCloud').jqxTagCloud({ maxColor: 'red' });
Get the maxColor property.
var value = $('#jqxTagCloud').jqxTagCloud({ 'maxColor' });
|
maxFontSize
|
double
|
Sets or gets the maxFontSize property used to set the font size of the tags with the highest value attribute.
Code example
Set the maxFontSize property.
$('#jqxTagCloud').jqxTagCloud({ maxFontSize: 30 });
Get the maxFontSize property.
var value = $('#jqxTagCloud').jqxTagCloud({ 'maxFontSize' });
|
maxValueToDisplay
|
double
|
Sets or gets the maxValueToDisplay property used to filter tags with value higher than the specified.
Code example
Set the maxValueToDisplay property.
$('#jqxTagCloud').jqxTagCloud({ maxValueToDisplay: 10 });
Get the maxValueToDisplay property.
var value = $('#jqxTagCloud').jqxTagCloud({ 'maxValueToDisplay' });
|
minColor
|
string
|
Sets or gets the minColor property used to specify color of the tags for the elements with lowest value attribute. Together with maxColor property will set color of tags in a gradient fashion depending on their value attribute towards the highest value. Possible values: all browser supported colors including rgba.
Code example
Set the minColor property.
$('#jqxTagCloud').jqxTagCloud({ minColor: 'green' });
Get the minColor property.
var value = $('#jqxTagCloud').jqxTagCloud({ 'minColor' });
|
minFontSize
|
double
|
Sets or gets the minFontSize property used to set the font size of the tags with the lowest value attribute.
Code example
Set the minFontSize property.
$('#jqxTagCloud').jqxTagCloud({ minFontSize: 10 });
Get the minFontSize property.
var value = $('#jqxTagCloud').jqxTagCloud({ 'minFontSize' });
|
minValueToDisplay
|
double
|
Sets or gets the minValueToDisplay property used to filter tags with value lower than the specified.
Code example
Set the minValueToDisplay property.
$('#jqxTagCloud').jqxTagCloud({ minValueToDisplay: 10 });
Get the minValueToDisplay property.
var value = $('#jqxTagCloud').jqxTagCloud({ 'minValueToDisplay' });
|
rtl
|
bool
|
Sets or gets a value indicating whether widget's elements are aligned to support locales using right-to-left fonts.
Code example
Set the rtl property.
$('#jqxTagCloud').jqxTagCloud({ rtl : true });
Get the rtl property.
var rtl = $('#jqxTagCloud').jqxTagCloud('rtl');
|
sortBy
|
object
|
Sets or gets the sortBy property used to specify the field by which tags should be sorted. Possible values are 'none', 'label', 'value'
Code example
Set the sortBy property.
$('#jqxTagCloud').jqxTagCloud({ sortBy: 'value' });
Get the sortBy property.
var value = $('#jqxTagCloud').jqxTagCloud({ 'sortBy' });
|
sortOrder
|
object
|
Sets or gets the sortOrder property used to specify the direction in which tags should be sorted. Possible values are 'ascending', 'descending'
Code example
Set the sortOrder property.
$('#jqxTagCloud').jqxTagCloud({ sortOrder: 'descending' });
Get the sortOrder property.
var value = $('#jqxTagCloud').jqxTagCloud({ 'sortOrder' });
|
source
|
object
|
|
tagRenderer
|
object
|
A callback function used for custom tags rendering.
function tagRenderer (itemData, minValue, valueRange)
itemData - the record information of the current tag
minValue - the lowest value attribute of all elements in the cloud
valueRange - the difference between the lowest and highest value attributes in the cloud ( can be used for custom logic )
The function must return valid content for an anchor tag, usually a string but can be also be a jquery element object.
Code example
Set the tagRenderer callback function.
$('#jqxTagCloud').jqxTagCloud({ tagRenderer: function () {
var el = $('' + record.countryName + '');
var img = $('');
img.on('click', function (event) {
var id = $(event.target).closest('li').index();
var index = $('#tagCloud').jqxTagCloud('getRenderedTags')[id].index;
$('#tagCloud').jqxTagCloud('removeAt', index);
event.preventDefault();
event.stopPropagation();
});
el.append(img);
return el;
}
});
|
takeTopWeightedItems
|
bool
|
Sets or gets the takeTopWeightedItems property. Property indicates if displayLimit will prioritize highest value members
Code example
Set the takeTopWeightedItems property.
$('#jqxTagCloud').jqxTagCloud({ takeTopWeightedItems: true });
Get the takeTopWeightedItems property.
var value = $('#jqxTagCloud').jqxTagCloud({ 'takeTopWeightedItems' });
|
textColor
|
string
|
Sets or gets the textColor property used to specify color of the tags in the case where the minColor and maxColor properties are not set. Possible values: all browser supported colors including rgba.
Code example
Set the textColor property.
$('#jqxTagCloud').jqxTagCloud({ textColor: 'red' });
Get the textColor property.
var value = $('#jqxTagCloud').jqxTagCloud({ 'textColor' });
|
urlBase
|
string
|
Sets or gets the field name used for common base URL path for all tags.
|
urlMember
|
string
|
Sets or gets the field name used by the anchor element.
|
valueMember
|
string
|
Sets or gets the field name used for value/weight.
|
width
|
object
|
Sets or gets the jqxTagCloud's width.
|
|
onBindingComplete
|
Event
|
This event is triggered when the widget has completed binding to a dataAdapter.
|
onItemClick
|
Event
|
This event is triggered when a tag element is clicked. Event Arguments:
- label - item's label.
- value - item's value.
- url - item's url.
- visibleIndex - item's visible index.
- index - item's index.
- originalEvent - the Click event object.
- target - item's html element.
|
|
Name |
Arguments |
Return Type |
destroy
|
()
|
void
|
Calls the widget's destroy function.
|
findTagIndex
|
(string tag)
|
double
|
Returns the index of the first tag with the specified label (displayMember).
|
getHiddenTagsList
|
()
|
object[]
|
Returns an array with indices of all hidden tags.
|
getRenderedTags
|
()
|
object[]
|
Returns an array with a copy of all tags that have been rendered in the order that they have been rendered. This array excludes filtered values. But includes hidden ones.
|
getTagsList
|
()
|
object[]
|
Returns an array with a copy of all tags. This list is used before any filtering/sorting/hiding is done.
|
hideItem
|
(double index)
|
void
|
Hides an element with specified index.
|
insertAt
|
(double index, object item)
|
void
|
Inserts an element before an element with specified index
|
removeAt
|
(double index)
|
void
|
Deletes an element with specified index.
|
updateAt
|
(double index, object item)
|
void
|
Updates an element with specified index.
|
showItem
|
(double index)
|
void
|
Reveals a hidden element with specified index.
|