Skip to content

Class: SideDrawerControlProxy

SideDrawerControlProxy is a developer-facing class that provides access to a side drawer control for application specific customizations.

Hierarchy

Implements

Summary

Constructors

Properties

Class Properties

None in this class.

Inherited Properties

Accessors

Class Accessors

Inherited Accessors

Methods

Class Methods

Inherited Methods

Constructors

constructor

+ new SideDrawerControlProxy(context: IContext): SideDrawerControlProxy

Overrides ControlProxy.constructor

Parameters:

Name Type
context IContext

Returns: SideDrawerControlProxy

Accessors

getter

Returns: Array‹ISideDrawerMenuItemProxy[]›

list of sections of menu items in the side drawer control


sections

getter

Returns: string[]

list of section captions in the side drawer control

Methods

getMenuItem

getMenuItem(name: string): ISideDrawerMenuItemProxy

Parameters:

Name Type
name string

Returns: ISideDrawerMenuItemProxy

a single SideDrawerMenuItemProxy instance of the menu item that's identified by the provided name (which is based on the _Name property)


getMenuItemsAtSection

getMenuItemsAtSection(sectionIndex: number): ISideDrawerMenuItemProxy[]

Implementation of ISideDrawerControlProxy

Get menu items at section index for side drawer control

Parameters:

Name Type
sectionIndex number

Returns: ISideDrawerMenuItemProxy[]


getSelectedMenuItemIndexPath

getSelectedMenuItemIndexPath(): [number, number]

Implementation of ISideDrawerControlProxy

Returns: [number, number]

selected menu item indexPath


getSelectedMenuItemName

getSelectedMenuItemName(): string

Implementation of ISideDrawerControlProxy

Returns: string

selected menu item name


isContainer

isContainer(): boolean

Implementation of ISideDrawerControlProxy

Overrides ControlProxy.isContainer

Determine if the side drawer control is a container.

Returns: boolean


setSectionVisibilityAtIndex

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

Implementation of ISideDrawerControlProxy

Get menu items at section index for side drawer control

Parameters:

Name Type
sectionIndex number
visibility boolean

Returns: void


setSelectedMenuItemByIndexPath

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

Implementation of ISideDrawerControlProxy

Set selected menu item by indexPath for side drawer control

Parameters:

Name Type
indexPath [number, number]

Returns: void


setSelectedMenuItemByName

setSelectedMenuItemByName(name: string): void

Implementation of ISideDrawerControlProxy

Set selected menu item by name for side drawer control

Parameters:

Name Type
name string

Returns: void


setSideDrawerButton

setSideDrawerButton(iconPath: string): any

Implementation of ISideDrawerControlProxy

Set side drawer icon

Parameters:

Name Type Description
iconPath string Path of the icon

Returns: any