LIDOR SYSTEMS

Advanced User Interface Controls and Components

IntegralUI Web

Documentation and API Reference


IntegralUI.Menu

Represents a Menu directive for AngularJS. Displays hierarchical collection of item objects.

Properties


  • controlStyle
  • Specifies an object that contains all style settings for the Menu directive
  • dataFields
  • Specifies data fields that match the data in local data source
  • displayMode
  • Determines how menu items are displayed
  • events
  • Specifies an object that holds all event handlers in the Menu
  • itemIcon
  • A HTML element which represents a default icon shown for all items that don't have an icon
  • items
  • Gets the collection of menu items that are assigned to the Menu
  • name
  • Gets or sets the name of the Menu
  • openOnHover
  • Determines whether submenu will open when mouse cursor hovers over parent menu item space
  • options
  • Specifies an object that holds all options available in the Menu
  • rtl
  • Determines whether left-to-right or right-to-left layout is active
  • showDropdownIcon
  • Determines whether dropdown icon is shown for the root menu items
  • showIcons
  • Determines whether icons are visible or not

Events


  • close
  • Occurs when submenu for specified menu item is closing
  • enabledChanged
  • Occurs after enabled property value changes
  • itemAdded
  • Occurs after item is added to the collection
  • itemAdding
  • Occurs before item is added to the collection
  • itemClick
  • Occurs when item is clicked
  • itemHover
  • Occurs when the mouse cursor hovers over item space
  • itemRemoved
  • Occurs after item is removed from the collection
  • itemRemoving
  • Occurs before item is removed from the collection
  • open
  • Occurs when submenu for specified menu item is opening
  • styleChanged
  • Occurs after controlStyle property value changes

Methods


  • addItem
  • Adds a new item
  • beginLoad
  • Enables change of the expand box image with an animated gif
  • clearItems
  • Removes all items
  • closeMenu
  • Closes the opened submenu for specified menu item
  • endLoad
  • Disables changes of the expand box image and returns its default appearance
  • exportToJSON
  • Exports the whole tree structure as tree or flat list in JSON format
  • findItemById
  • Searches for an item using specified id
  • findItemByText
  • Searches for an item using specified text
  • getList
  • Returns a list of all items
  • insertItemAfter
  • Inserts a new item after specified item
  • insertItemAt
  • Inserts a new item at specified position
  • insertItemBefore
  • Inserts a new item before specified item
  • loadData
  • Populates the Menu content using local or remote data source
  • openMenu
  • Opens a submenu for specified menu item
  • refresh
  • Applies the control styles and updates the appearance of the Menu
  • removeItem
  • Removes the specified item
  • removeItemAt
  • Removes an item at specified position
  • resumeLayout
  • Resumes the Menu layout and updates it, internally calls the updateLayout method
  • suspendLayout
  • Suspends the Menu layout from any updates
  • updateLayout
  • Updates the Menu layout