|
Name |
Type |
animationType
|
object
|
Sets or gets the animation type.
Possible Values:
'slide'
'fade'
'none'
|
arrowPosition
|
object
|
Sets or gets header's arrow position.
Possible Values:
'left'
'right'
|
collapseAnimationDuration
|
double
|
Sets or gets the collapsing animation duration.
|
disabled
|
bool
|
Sets or gets whether the navigation bar is disabled.
|
expandAnimationDuration
|
double
|
Sets or gets the expanding animation duration.
|
expandMode
|
object
|
Sets or gets navigation bar's expand mode. Possible values ['single', 'singleFitHeight' 'multiple', 'toggle', 'none'].
Possible Values:
'single' - only one item can be expanded. If the expanded item's height is greater than the value of the height property, a vertical scrollbar is shown.
'singleFitHeight' - only one item can be expanded. If the expanded item's height is greater than the value of the height property, a vertical scrollbar is shown inside the content of the expanded item
'multiple' - multiple items can be expanded. If the expanded items' height is greater than the value of the height property, a vertical scrollbar is shown.
'toggle' - only one item can be expanded. The expanded item can also be collapsed.If the expanded item's height is greater than the value of the height property, a vertical scrollbar is shown
'none' - no items can be expanded/collapsed
|
expandedIndexes
|
double[]
|
Sets or gets the expanded item(s). If the property expandMode is set to either 'single', 'singleFitHeight', 'toggle' or 'none', only the item corresponding to the first value in the array is expanded. If the property expandMode is set to either 'single' or 'singleFitHeight' and the expandedIndexes array is empty, the first item is expanded automatically.
|
height
|
object
|
Sets or gets the navigationbar's height. Possible values - 'auto' or string like this 'Npx' where N is any number or a numeric value in pixels.
|
initContent
|
object
|
Callback function called when an item's content needs to be initialized. Useful for initializing other widgets within the content of any of the items of jqxNavigationBar. The index argument shows which item is initialized.
|
rtl
|
bool
|
Determines whether the right-to-left support is enabled.
|
showArrow
|
bool
|
Sets or gets whether header's arrow is going to be shown.
|
theme
|
string
|
|
toggleMode
|
object
|
Sets or gets user interaction used for expanding or collapsing the content. Possible values ['click', 'dblclick', 'none'].
Possible Values:
'click'
'dblclick'
'none'
|
width
|
object
|
Sets or gets the navigationbar's width. Possible values - 'auto' or string like this 'Npx' where N is any number or a numeric value in pixels.
|
|
onCollapsingItem
|
Event
|
This event is triggered when a jqxNavigationBar item is going to be collapsed.
|
onCollapsedItem
|
Event
|
This event is triggered when a jqxNavigationBar item is collapsed.
|
onExpandingItem
|
Event
|
This event is triggered when a jqxNavigationBar item is going to be expanded.
|
onExpandedItem
|
Event
|
This event is triggered when a jqxNavigationBar item is expanded.
|
|
Name |
Arguments |
Return Type |
add
|
(object header, object content)
|
void
|
This method inserts an item at the bottom of the navigationbar. It has two parameters - header (the header of the new item) and content (the content of the new item).
|
collapseAt
|
(object index)
|
void
|
Collapsing item with any index.
|
disableAt
|
(object index)
|
void
|
Disabling item with any index.
|
disable
|
()
|
void
|
This method is disabling the navigation bar.
|
destroy
|
()
|
void
|
This method destroys the navigationbar.
|
expandAt
|
(object index)
|
void
|
Expanding item with any index.
|
enableAt
|
(object index)
|
void
|
Enabling item with any index.
|
enable
|
()
|
void
|
This method is enabling the navigation bar.
|
focus
|
()
|
void
|
This method focuses on the navigationbar. When the widget is focused, keyboard navigation can be used. Here is a list of the keys, supported by jqxNavigationBar and their function:
- Enter/Spacebar - if the focus is on an item header, collapses or expands the item.
- Left/Up arrow - focuses on the previous item header or on the last one if the currently focused is the first one.
- Right/Down arrow - focuses on the next item header or on the first one if the currently focused is the last one.
- End - focuses on the last item header.
- Home - focuses on the first item header.
- Tab - focuses on the first header or the next element in the DOM.
- Ctrl+Up arrow - if the focus is on an item content, focuses on its respective header.
- Ctrl+Down arrow - if the focus is on an item header, focuses on its respective content.
|
getHeaderContentAt
|
(object index)
|
string
|
Getting header content of item with any index. Returns a string value.
|
getContentAt
|
(object index)
|
string
|
Getting content of item with any index. Returns a string value.
|
hideArrowAt
|
(object index)
|
void
|
Hiding the arrow of an item with specific index.
|
invalidate
|
()
|
void
|
This method refreshes the navigationbar.
|
insert
|
(double Index, object header, object content)
|
void
|
This method inserts an item at a specific index. It has three parameters - index, header (the header of the new item) and content (the content of the new item).
|
refresh
|
()
|
void
|
This method refreshes the navigationbar.
|
render
|
()
|
void
|
This method renders the navigationbar.
|
remove
|
(object index)
|
void
|
This method removes an item at a specific index. The parameter (index) is optional and if it is not set, the method removes the last item.
|
setContentAt
|
(double index, object item)
|
void
|
Setting content to item with any index.
|
setHeaderContentAt
|
(double index, object item)
|
void
|
Setting header content to item with any index
|
showArrowAt
|
(object index)
|
void
|
Showing the arrow of an item with specific index.
|
update
|
(double index, object header, object content)
|
void
|
This method updates an item at a specific index. It has three parameters - index, header (the new header of the item) and content (the new content of the item).
|
val
|
[SET] (object value) [GET] ()
|
[SET] void [GET] object
|
Sets or gets the expanded item.
|