TagCloud

Namespace: PP.Ui;

Inheritance Hierarchy

Object

Control

DataVisualizer

TagCloud

Description

The TagCloud class implements the TagCloud component which is the tag cloud.

Syntax

PP.initClass(PP.Ui.TagCloud, PP.Ui.DataVisualizer, "PP.Ui.TagCloud");

Constructor

  Constructor name Brief description
TagCloud The TagCloud constructor creates an instance of the TagCloudcomponent.

Properties

  Property name Brief description
property_image.gif FreezeActive The FreezeActive property determines whether animation of elements freezes on pointing the cursor to the active tag.
property_image.gif IsDragControl The IsDragControl property determines the method of moving tag cloud elements.
property_image.gif IsWheelZoom The IsWheelZoom property determines whether tag cloud can be zoomed using the mouse wheel.
property_image.gif Shape The Shape property contains a form of distribution of tag cloud elements.
property_image.gif SortItems The SortItems property determines whether tag cloud elements are sorted.

Methods

  Method name Brief description
sub_image.gif addItem The addItem method adds a new item to tag cloud.
sub_image.gif getActiveItem The getActiveItem method returns the active cloud tag.
sub_image.gif getCanvas The getCanvas method returns rendering area of tag cloud elements.
sub_image.gif getClickToFront The getClickToFront method determines whether a tag element is sent to front on clicking on it.
sub_image.gif getItems The getItems method returns array of tag cloud elements.
sub_image.gif getItemsNames The getItemsNames method returns array of tag cloud element headers.

Events

  Event name Brief description
ItemClick The ItemClick event occurs after clicking the mouse button on the cloud active tag.
ItemMouseOut The ItemMouseOut event occurs after moving the cursor outside the borders of active tag area.
ItemMouseOver The ItemMouseOver event occurs after the cursor appears over the cloud active tag.

Properties inherited from the DataVisualizer class

  Property name Brief description
property_image.gif ActiveMappingItems The ActiveMappingItems property determines an array of active values of a bubble chart.
property_image.gif AreaSelection The AreaSelection property sets selection area for charts.
property_image.gif AreaSelectionAction The AreaSelectionAction property determines the action on selecting visualizer area.
property_image.gif CustomData The CustomData property is used to store custom data.
property_image.gif DataSources The DataSources property sets and returns an object that contains data sources for charts.
property_image.gif EnableBatchData The EnableBatchData property controls availability of batch data in a chart source.
property_image.gif EnableSelection The EnableSelection property determines whether visualizer elements can be selected.
property_image.gif GlobalItemsIds The GlobalItemsIds method determines a dictionary of global identifiers of elements.
property_image.gif HoverActiveEffects The HoverActiveEffects property determines effects applied to objects on hovering the cursor on them.
property_image.gif HoveredItems The HoveredItems property determines an array of elements, which can be hovered.
property_image.gif HoverInactiveEffects The HoverInactiveEffects property determines effects applied to the objects, which are not hovered.
property_image.gif ItemHoverness The ItemHoverness property determines whether a chart element can be hovered.
property_image.gif ItemSelection The ItemSelection property determines element selection.
property_image.gif LegendMapping The LegendMapping property determines a dictionary of connection of legends with data bindings.
property_image.gif Legends The Legends property sets and returns array of chart legends.
property_image.gif LegendsPackingMaxPart The LegendsPackingMaxPart property sets and returns maximum part of chart legends from their packing.
property_image.gif MappingActiveEffects The MappingActiveEffects property compares effects for active elements.
property_image.gif MappingInactiveEffects The MappingInactiveEffects property compares effects for inactive elements.
property_image.gif MappingItemActiveness The MappingItemActiveness property determines whether effect comparison is active for visualizer element.
property_image.gif Scales The Scales property sets and returns chart scales.
property_image.gif SelectActiveEffects The SelectActiveEffects property determines an array of effects applied to the selected bubble chart elements.
property_image.gif SelectedItems The SelectedItems property determines an array of selected bubble chart elements.
property_image.gif SelectInactiveEffects The SelectInactiveEffects property determines an array of effects applied to non-selected bubble chart elements.
property_image.gif SettingsProvider The SettingsProvider property determines a basic class for specified settings.
property_image.gif Timeline The Timeline property returns and sets a chart timeline.
property_image.gif UseLegendsPacking The UseLegendsPacking property allows and prohibits using chart legend packing.
property_image.gif UseSelectOnClick The UseSelectOnClick property determines whether an element can be selected by means of the mouse cursor.
property_image.gif UseSelectOnRightClick The UseSelectOnRightClick property determines whether an element can be selected by means of the right mouse button.
property_image.gif Visuals The Visuals property sets and returns settings of mapping data series values with chart axes, color and size of chart elements.

Methods inherited from the DataVisualizer class

  Method name Brief description
sub_image.gif addVisual The addVisual method compares visualizer data with the specified identifier.
sub_image.gif animate The animate method plays chart animation.
sub_image.gif beginUpdate The beginUpdate method starts data update mode that disables component rerendering until exiting from this mode.
sub_image.gif clearAreaSelection The clearAreaSelection method clears chart selection.
sub_image.gif disposeData The disposeData method deletes complex properties of visualizer.
sub_image.gif draw The draw method completely rerenders a chart.
sub_image.gif endUpdate The endUpdate method disables data update mode that disables component rerendering until exiting from this mode.
sub_image.gif getBackwardGlobalItemsIds The getBackwardGlobalItemsIds method returns backward dictionary of global identifiers of elements.
sub_image.gif getBackwardLegendMapping The getBackwardLegendMapping method returns backward dictionary of connection of legends with data bindings.
sub_image.gif getEnableHover The getEnableHover method returns whether effects are used on hovering the cursor on bubble chart bubbles.
sub_image.gif getFirstDataSource The getFirstDataSource method returns the first data source for chart data visualizer.
sub_image.gif getFirstLegend The getFirstLegend method returns the chart first legend.
sub_image.gif getFirstScale The getFirstScale method returns the first scale in a chart.
sub_image.gif getGlobalItemId The getGlobalItemId method returns global identifier of element.
sub_image.gif getItemsByAreaRect The getItemsByAreaRect method returns elements within the specified chart area.
sub_image.gif getLegendByDataMapping The getLegendByDataMapping method returns visualizer legend by data comparison identifier.
sub_image.gif getLegendById The getLegendById method returns bubble chart legend by its identifier.
sub_image.gif getLocalItemId The getLocalItemId method returns internal identifier of element.
sub_image.gif getTimelineStepName The getTimeLineStepName method returns the current timeline step.
sub_image.gif getVisualById The getVisualById method returns comparison of visualizer data by its identifier.
sub_image.gif loadData The loadData method uploads specified data to a chart.
sub_image.gif refresh The refresh method refreshes a chart.
sub_image.gif setTimelineStep The setTimelineStep method sets a timeline step.
sub_image.gif updateData The updateData method assigns new index value to parameters of chart series data values mapping.

Events inherited from the DataVisualizer class

  Event name Brief description
event_image.gif AreaSelected The AreaSelected event occurs after a chart area is selected.
event_image.gif AreaSelecting The AreaSelecting event occurs in the process of chart area selection.
event_image.gif ItemsSelected The ItemSelected event occurs after visualizer elements are selected.
event_image.gif ItemsSelecting The ItemSelecting event occurs before selecting visualizer elements.
event_image.gif LegendHeaderClicked The LegendHeaderClicked event occurs on clicking the chart legend title.
event_image.gif LegendItemSelected The LegendItemSelected event occurs after selecting a legend element.
event_image.gif LegendItemSelecting The LegendItemSelecting event occurs on selecting a legend element.
event_image.gif RequestData The RequestData event occurs when it is necessary to load data to a data source.
event_image.gif TimelineStep The TimelineStep event occurs on changing the current step of the chart timeline.

Properties inherited from the Control class

  Property name Brief description
Anchors The Anchors property determines position of the component placed within container.
Animation The Animation property determines component animation parameters.
Bottom The Bottom property determines a bottom margin if a component is placed inside LayoutPanel.
Content The Content property determines component contents.
ContextMenu The ContextMenu property determines a component's context menu.
Data The Data property is used to store any custom data.
Enabled The Enabled property determines whether a component can be used.
Height The Height property determines component height.
IsRTL The IsRTL property determines whether component elements are aligned to the right.
IsVisible The IsVisible property determines whether a component is displayed.
Left The Left property determines a left margin if a component is placed inside GridPanel.
Opacity The Opacity property determines component transparency.
Parent The Parent property determines a parent component of a control.
ParentNode The ParentNode property determines a parent DOM node.
ResourceKey The ResourceKey property determines a component resource key.
Right The Right property determines a right margin if a component is placed inside LayoutPanel.
Rotate The Rotate property determines a component rotation angle.
ShowToolTip The ShowToolTip property determines whether a tooltip of the component can be displayed.
Style The Style property determines a component style.
TabIndex The TabIndex property determines the order of the control element passing inside the container.
Tag The Tag property determines a JSON object associated with the component.
ToolTip The ToolTip property determines text of component tooltip.
Top The Top property determines a top margin if a component is placed inside GridPanel.
Value The Value property determines a component value.
Width The Width property determines component width.

Methods inherited from the Control class

  Method name Brief description

addClass

The addClass method adds a CSS class to the component.
addEventHandler The addEventHandler method adds an event handler to a DOM node.

addStateClass

The addStateClass method adds a CSS class to the component and removes the previous CSS class.

addToNode

The addToNode method adds a component to the specified node.
bindEvents The bindEvents method subscribes an element to all available events.

getAnchorFlags

The getAnchorFlags method returns JSON object that contains settings of the current component's position.

getClass

The getClass method returns the current CSS classes of the component.

getCssStyle

The getCssStyle method returns style for the specified node.

getDomNode

The getDomNode method returns main DOM node of the component.

getFocused

The getFocused method determines whether the component is focused.
getIsBinded The getIsBinded method returns whether an element is subscribed to all DOM node events.

hide

The hide method hides a control.

hideToolTip

The hideToolTip method clears tooltip timeout and hides the tooltip if it is shown.
refreshStyle The refreshStyle method refreshes element CSS styles.

removeClass

The removeClass method removes CSS class from the component.
removeEventHandler The removeEventHandler method removes event handler from DOM node.
removeFromDOM The removeFromDOM method removes node from the DOM structure.

removeStateClasses

The removeStateClasses method removes CSS classes of the component.

setDraggable

The setDraggable method determines whether a component can be dragged on the HTML page.

setFocus

The setFocus method sets the component focus.

setIsHovered

The setIsHovered method sets up component displaying only on mouseover.

setSize

The setSize method establishes the sizes of the component.

show

The show method displays a control.
unBindEvents The unBindEvents method unsubscribes an element from all standard events.

updatePosition

The updatePosition method updates size and position when absolute positioning based on the current parameters is used.

updateSize

The updateSize method updates the component size on changing the size of the container that contains the component.

Events inherited from Control

  Event name Brief description
Drag The Drag event occurs on clicking and holding the mouse button.
DragEnd The DragEnd event occurs when dragging the component finishes.
DragStart The DragStart event occurs when dragging the component starts.
OnContextMenu The OnContextMenu event occurs on calling context menu of the component.
SizeChanged The SizeChanged event occurs after the component is resized.
SizeChanging The SizeChanging event occurs during component resize.

Properties inherited from Object

  Property name Brief description

Id

The Id property determines a repository object identifier.

Methods inherited from Object

  Method name Brief description
clone The clone method creates an object copy.
dispose The dispose method deletes the component.
getHashCode The getHashCode method returns hash code of repository object.
getId The getId method returns repository object identifier.
getSettings The getSettings method returns repository object settings.
getTypeName The getTypeName method returns the name of the object type without the namespace, to which it belongs.
isEqual The isEqual method determines whether the specified object is equal to the current repository object.
isLive The isLive method determines validity of repository object.
removeAllEvents The removeAllEvents method removes all object event handlers by the specified context.
setId The setId method determines a repository object identifier.
setSettings The setSettings method determines repository object settings.
defineProps The defineProps method creates get and set methods from name array for the specified class.
keys The keys method returns array of methods and properties names for the specified object.

PP.Ui