Skip to content

Interface: ISideDrawerControlProxy

A designer-facing interface that provides access to side drawer.

It is passed to rules to provide access to the side drawer for application specific customizations.

In addition it provides access to the IControlProxy interface.

Hierarchy

Implemented by

Summary

Properties

Class Properties

Inherited Properties

Methods

Class Methods

Inherited Methods

Properties

menuItems: Array‹ISideDrawerMenuItemProxy[]›

returns list of items in the side drawer control


sections

sections: string[]

returns list of section captions in the side drawer control

Methods

getMenuItemsAtSection

getMenuItemsAtSection(sectionIndex: number): ISideDrawerMenuItemProxy[]

Get menu items at section index for side drawer control

Parameters:

Name Type
sectionIndex number

Returns: ISideDrawerMenuItemProxy[]


getSelectedMenuItemIndexPath

getSelectedMenuItemIndexPath(): [number, number]

Returns: [number, number]

selected menu item indexPath


getSelectedMenuItemName

getSelectedMenuItemName(): string

Returns: string

selected menu item name


setSectionVisibilityAtIndex

setSectionVisibilityAtIndex(sectionIndex: number, visibility: boolean): any

Get menu items at section index for side drawer control

Parameters:

Name Type
sectionIndex number
visibility boolean

Returns: any


setSelectedMenuItemByIndexPath

setSelectedMenuItemByIndexPath(indexPath: [number, number]): any

Set selected menu item by indexPath for side drawer control

Parameters:

Name Type
indexPath [number, number]

Returns: any


setSelectedMenuItemByName

setSelectedMenuItemByName(name: string): any

Set selected menu item by name for side drawer control

Parameters:

Name Type
name string

Returns: any


setSideDrawerButton

setSideDrawerButton(iconPath: string): any

Set side drawer icon

Parameters:

Name Type
iconPath string

Returns: any