Class Dataview

Hierarchy

Cbn.ctrls.Base
- Dataview

Constructors

constructor

new Dataview(): Dataview
Returns Dataview

Inherited from Base.constructor

Properties

ctrlId

ctrlId: string

This is the actual name of the component

el

el: ExtElement

rendered

rendered: boolean

self

self: {
TypeStr: string;
}

Type declaration

TypeStr: string

`Static` TypeStr

TypeStr: string

Methods

getCtrlPropValue

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

Inherited from Base.getCtrlPropValue

getCtrlValue

getCtrlValue(): string | number | boolean
Returns string | number | boolean

getEntriesTooltips

getEntriesTooltips(): {
[value: string | number]: Instance;
}
Returns {
[value: string | number]: Instance;
}
- [value: string | number]: Instance

getHeight

getHeight(): number
Returns number

Inherited from Base.getHeight

getInnerDataView

getInnerDataView(callback: Function): void
Gets the inner ExtJS dataview.
If the dataview is not rendered at the call time (e.g. dataview in hidden wizard page) the callback is automatically deferred until the dataview is actually rendered.
Parameters
- callback: Function
Returns void

getSize

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

getTooltip

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

See
Documentation of tippy.js

Returns Instance

Inherited from Base.getTooltip

hasCls

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

Inherited from Base.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 Base.on

scrollItemIntoView

scrollItemIntoView(value?: string | number | boolean, pos?: "Center" | "Top" | "Bottom", ifNeeded?: boolean, animateDuration?: number, scrollInnerDV?: boolean): void
Scrolls the selected item into view.\

!!! Note !!!

This function hasn't been tested & used a lot so far which means that it could easily be that it won't work under all conditions (e.g. horizontal scrolling, elements with absolute positioning etc)
Parameters
- Optional value: string | number | boolean
  
  If not given the currently selected one will be scrolled into view
- Optional pos: "Center" | "Top" | "Bottom"
  
  'Top', 'Center' or 'Bottom'
- Optional ifNeeded: boolean
  
  If true, only scrolls if the given is el isn't already visible.
- Optional animateDuration: number
  
  Animation duration in [ms].
- Optional scrollInnerDV: boolean
  
  By default the outer element is scrolled. Depending on the styles it can be necessary to scroll the inner dataview element...
Returns void

setCtrlBckgr

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

Inherited from Base.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 Base.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 Base.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 Base.setCtrlWidth

setDataviewValue

setDataviewValue(value: string | number | boolean, silent?: boolean): void
Parameters
- value: string | number | boolean
  
  The value of the item that should be selected
- Optional silent: boolean
  
  If true the controls "Value changed" signal won't be fired.
Returns void

setDisabled

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

Inherited from Base.setDisabled

setEntries

setEntries(entries: ListCtrlEntryData[] | object[]): void
Fills the dataview store with the given data
Parameters
- entries: ListCtrlEntryData[] | object[]
  
  An array of ListCtrlEntryData if the dataview is using a standard layout (i.e. property Custom layout is not set).
  If using a custom layout, the given properties inside entries need to match the properties used in the layout (usually everything after values.).
Returns void

setTooltipContent

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

Inherited from Base.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 Base.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 Base.un

Class Dataview

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Dataview

Properties

ctrlId

el

rendered

self

Type declaration

TypeStr: string

Static TypeStr

Methods

getCtrlPropValue

Parameters

propertyName: string

Returns any

getCtrlValue

Returns string | number | boolean

getEntriesTooltips

Returns { [value: string | number]: Instance; }

[value: string | number]: Instance

getHeight

Returns number

getInnerDataView

Parameters

callback: Function

Returns void

getSize

Returns { height: number; width: number; }

height: number

width: number

getTooltip

See

Returns Instance

hasCls

Parameters

cls: string

Returns boolean

on

Parameters

eventName: string

callback: Function

Optional scope: any

Optional options: object

Returns void

scrollItemIntoView

!!! Note !!!

Parameters

Optional value: string | number | boolean

Optional pos: "Center" | "Top" | "Bottom"

Optional ifNeeded: boolean

Optional animateDuration: number

Optional scrollInnerDV: boolean

Returns void

setCtrlBckgr

Parameters

value: string

Returns void

setCtrlHeight

Parameters

value: string | number

Returns void

setCtrlVisibility

Parameters

value: boolean | CtrlVisibility

Optional updateCtrlProperty: boolean

Returns void

setCtrlWidth

Parameters

value: string

Returns void

setDataviewValue

Parameters

value: string | number | boolean

`Static` TypeStr

Returns {
[value: string | number]: Instance;
}

Returns {
height: number;
width: number;
}

`Optional` scope: any

`Optional` options: object

`Optional` value: string | number | boolean

`Optional` pos: "Center" | "Top" | "Bottom"

`Optional` ifNeeded: boolean

`Optional` animateDuration: number

`Optional` scrollInnerDV: boolean

`Optional` updateCtrlProperty: boolean

`Optional` silent: boolean

`Optional` scope: any