Class Panel

Hierarchy

Container
- Panel

Index

Constructors

constructor

new Panel(): Panel
Returns Panel

Inherited from Container.constructor

Properties

ctrlId

ctrlId: string

This is the actual name of the component

el

rendered

rendered: boolean

self

self: {
TypeStr: string;
}

Type declaration

TypeStr: string

`Static` TypeStr

TypeStr: string

Methods

_getInnerEl

_getInnerEl(): ExtElement
Returns ExtElement

Inherited from Container._getInnerEl

getCtrlPropValue

getCtrlPropValue(propertyName: string): any
Parameters
- propertyName: string
  
  One of CtrlProperties
Returns any

Inherited from Container.getCtrlPropValue

getHeight

getHeight(): number
Returns number

Inherited from Container.getHeight

getSize

getSize(): {
height: number;
width: number;
}
Returns {
height: number;
width: number;
}
- height: number
- width: number
Inherited from Container.getSize

getTooltip

getTooltip(): Instance
Returns a tooltip instance of the control based on tippy.js

See
Documentation of tippy.js

Returns Instance

Inherited from Container.getTooltip

hasCls

hasCls(cls: string): boolean
Parameters
- cls: string
Returns boolean

Inherited from Container.hasCls

on

on(eventName: string, callback: Function, scope?: any, options?: object): void
This function is actually inherited from ExtJS: https://docs.sencha.com/extjs/6.2.0/modern/Ext.mixin.Observable.html#method-on
Parameters
- eventName: string
- callback: Function
- Optional scope: any
- Optional options: object
Returns void

Inherited from Container.on

setCollapseGroup

setCollapseGroup(group: string): void
Parameters
- group: string
Returns void

setCollapsed

setCollapsed(collapsed?: boolean, silent?: boolean, callback?: ((pnl: Panel) => void)): void
Collapses/expands the panel or toggles it if the collapsed parameter is undefined
Parameters
- Optional collapsed: boolean
- Optional silent: boolean
  
  False to fire the ctrlcollapsed & ctrlexpanded events.
- Optional callback: ((pnl: Panel) => void)
  
  Called after the collapse/expand operation finished.
  Given parameter is the panel itself.
  - - (pnl: Panel): void
    - Parameters
      
      pnl: Panel
      
      Returns void
Returns void

setCollapsible

setCollapsible(collapsible: boolean): void
Parameters
- collapsible: boolean
Returns void

setCtrlBckgr

setCtrlBckgr(value: string): void
Parameters
- value: string
  
  A css compliant background string
Returns void

Inherited from Container.setCtrlBckgr

setCtrlHeight

setCtrlHeight(value: string | number): void
Parameters
- value: string | number
  
  CSS size string with or without unit or number which will be interpreted as px
Returns void

Inherited from Container.setCtrlHeight

setCtrlVisibility

setCtrlVisibility(value: boolean | CtrlVisibility, updateCtrlProperty?: boolean): void
Show or hide the control
Parameters
- value: boolean | CtrlVisibility
  
  True: "Show"
  False: "PluggedOut"
- Optional updateCtrlProperty: boolean
Returns void

Inherited from Container.setCtrlVisibility

setCtrlWidth

setCtrlWidth(value: string): void
Parameters
- value: string
  
  CSS size string with or without unit or number which will be interpreted as px
Returns void

Inherited from Container.setCtrlWidth

setDisabled

setDisabled(value: boolean): void
Parameters
- value: boolean
Returns void

Inherited from Container.setDisabled

setHeaderText

setHeaderText(value: string, sanitizeValue?: boolean): void
Parameters
- value: string
  
  If empty, the header is completely hidden
- Optional sanitizeValue: boolean
  
  See documentation on User input sanitization for more information
Returns void

Inherited from Container.setHeaderText

setTooltipContent

setTooltipContent(content: string): void
Set the content of the tooltip
Parameters
- content: string
  
  Plain text or HTML
Returns void

Inherited from Container.setTooltipContent

setUserCssClass

setUserCssClass(cls: string): void
Parameters
- cls: string
  
  One or more CSS classes which are added to the control. Previously added classes are removed.
Returns void

Inherited from Container.setUserCssClass

un

un(eventName: string, callback: Function, scope?: any): void
This function is actually inherited from ExtJS: https://docs.sencha.com/extjs/6.2.0/modern/Ext.mixin.Observable.html#method-un
Parameters
- eventName: string
- callback: Function
- Optional scope: any
Returns void

Inherited from Container.un

Generated using TypeDoc