jqwidgets-framework
Version:
jQWidgets is an advanced Angular, Vue, Blazor, React, Web Components, jquery, ASP .NET MVC, Custom Elements and HTML5 UI framework.
1,476 lines (1,357 loc) • 175 kB
TypeScript
/*
jQWidgets TypeScript definitions
Copyright (c) 2011-2025 jQWidgets.
License: https://jqwidgets.com/license/
*/
interface JQueryStatic {
jqx: any;
}
declare var generatedata: any;
declare var jqx: any;
declare module jqwidgets {
export function createInstance(selector: string, widgetName: string, params?: any): any;
export class widget
{
constructor(selector: string, options?: Object);
refresh(): void;
destroy(): void;
getInstance(): any;
addEventHandler(event: string, funcEventHandler: (any: any) => void): void;
removeEventHandler(event: string): void;
setOptions(params?: any): any;
}
export interface BarGaugeLabelsFont {
// BarGaugeLabelsFont properties
color?: string;
size?: number | string;
family?: string;
}// BarGaugeLabelsFont
export interface BarGaugeLabels {
// BarGaugeLabels properties
connectorColor?: string;
connectorWidth?: number;
font?: BarGaugeLabelsFont;
formatFunction?: (value: number, index?: number) => string;
indent?: number;
precision?: number;
visible?: boolean;
}// BarGaugeLabels
export interface BarGaugeTextFont {
// BarGaugeTextFont properties
color?: string;
family?: string;
opacity?: number;
size?: number | string;
weight?: number;
}// BarGaugeTextFont
export interface BarGaugeTitleMargin {
// BarGaugeTitleMargin properties
bottom?: number;
left?: number;
right?: number;
top?: number;
}// BarGaugeTitleMargin
export interface BarGaugeTitleSubtitle {
// BarGaugeTitleSubtitle properties
text?: string;
font?: BarGaugeTextFont;
}// BarGaugeTitleSubtitle
export interface BarGaugeTitle {
// BarGaugeTitle properties
text?: string;
font?: BarGaugeTextFont;
horizontalAlignment?: string;
margin?: BarGaugeTitleMargin;
subtitle?: BarGaugeTitleSubtitle;
verticalAlignment?: string;
}// BarGaugeTitle
export interface BarGaugeTooltip {
// BarGaugeTooltip properties
classname?: string;
formatFunction?: (value: string, index?: number, color?: string) => string;
visible?: boolean;
precision?: number;
}// BarGaugeTooltip
export interface BarGaugeCustomColorScheme {
// BarGaugeCustomColorScheme properties
name: string;
colors: Array<string>;
}// BarGaugeCustomColorScheme
export interface BarGaugeOptions {
// BarGaugeOptions properties
animationDuration?: number;
backgroundColor?: string;
barSpacing?: number;
baseValue?: number;
colorScheme?: string;
customColorScheme?: BarGaugeCustomColorScheme;
disabled?: boolean;
endAngle?: number;
formatFunction?: (value: number, index?: number, color?: string) => string;
height?: string | number;
labels?: BarGaugeLabels;
max?: number | string;
min?: number;
relativeInnerRadius?: number | string;
rendered?: () => void;
startAngle?: number;
title?: BarGaugeTitle;
tooltip?: BarGaugeTooltip;
useGradient?: boolean;
values?: Array<number>;
width?: string | number;
}// BarGaugeOptions
export interface jqxBarGauge extends widget, BarGaugeOptions {
// jqxBarGauge functions
refresh(): void;
render(): void;
val(value: Array<number>): Array<number>;
}// jqxBarGauge
export interface BulletChartLabelsFormatFunction {
// BulletChartLabelsFormatFunction properties
value?: string;
position?: string;
}// BulletChartLabelsFormatFunction
export interface BulletChartTooltipFormatFunction {
// BulletChartTooltipFormatFunction properties
pointerValue?: number;
targetValue?: number;
}// BulletChartTooltipFormatFunction
export interface BulletChartPointer {
// BulletChartPointer properties
value?: number;
label?: string;
size?: number | string;
color?: string;
}// BulletChartPointer
export interface BulletChartRanges {
// BulletChartRanges properties
startValue: number;
endValue: number;
opacity?: number;
color?: string;
}// BulletChartRanges
export interface BulletChartTicks {
// BulletChartTicks properties
position?: string;
interval?: number;
size?: number | string;
}// BulletChartTicks
export interface BulletChartOptions {
// BulletChartOptions properties
animationDuration?: number;
barSize?: number | string;
description?: string;
disabled?: boolean;
height?: string | number;
labelsFormat?: string;
labelsFormatFunction?: (value?: BulletChartLabelsFormatFunction['value'], position?: BulletChartLabelsFormatFunction['position']) => any;
orientation?: string;
pointer?: BulletChartPointer;
rtl?: boolean;
ranges?: Array<BulletChartRanges>;
showTooltip?: boolean;
target?: BulletChartPointer;
ticks?: BulletChartTicks;
title?: string;
tooltipFormatFunction?: (pointerValue?: BulletChartTooltipFormatFunction['pointerValue'], targetValue?: BulletChartTooltipFormatFunction['targetValue']) => string;
width?: string | number;
}// BulletChartOptions
export interface jqxBulletChart extends widget, BulletChartOptions {
// jqxBulletChart functions
destroy(): void;
render(): void;
refresh(): void;
val(value: number): number;
}// jqxBulletChart
export interface ButtonGroupOptions {
// ButtonGroupOptions properties
disabled?: boolean;
enableHover?: boolean;
mode?: string;
rtl?: boolean;
template?: string;
theme?: string;
}// ButtonGroupOptions
export interface jqxButtonGroup extends widget, ButtonGroupOptions {
// jqxButtonGroup functions
disableAt(index: number): void;
disable(): void;
destroy(): void;
enable(): void;
enableAt(index: number): void;
getSelection(): any;
render(): void;
setSelection(index: number): void;
}// jqxButtonGroup
export interface ButtonOptions {
// ButtonOptions properties
disabled?: boolean;
height?: number | string;
imgSrc?: string;
imgWidth?: number | string;
imgHeight?: number | string;
imgPosition?: string;
roundedCorners?: string;
rtl?: boolean;
enableDefault?: boolean;
cursor?: boolean;
textPosition?: string;
textImageRelation?: string;
theme?: string;
template?: string;
width?: number | string;
value?: string;
}// ButtonOptions
export interface jqxButton extends widget, ButtonOptions {
// jqxButton functions
destroy(): void;
focus(): void;
render(): void;
val(value: string): string;
}// jqxButton
export interface CalendarOptions {
// CalendarOptions properties
backText?: string;
columnHeaderHeight?: number;
clearString?: string;
culture?: string;
dayNameFormat?: string;
disabled?: boolean;
enableWeekend?: boolean;
enableViews?: boolean;
enableOtherMonthDays?: boolean;
enableFastNavigation?: boolean;
enableHover?: boolean;
enableAutoNavigation?: boolean;
enableTooltips?: boolean;
forwardText?: string;
firstDayOfWeek?: number;
height?: string | number;
min?: any;
max?: any;
navigationDelay?: number;
rowHeaderWidth?: number | string;
readOnly?: boolean;
restrictedDates?: Array<Date>;
rtl?: boolean;
stepMonths?: number;
showWeekNumbers?: boolean;
showDayNames?: boolean;
showOtherMonthDays?: boolean;
showFooter?: boolean;
selectionMode?: string;
specialDates?: Array<any>;
theme?: string;
titleHeight?: number;
titleFormat?: string;
todayString?: string;
value?: Date;
width?: string | number;
}// CalendarOptions
export interface jqxCalendar extends widget, CalendarOptions {
// jqxCalendar functions
clear(): void;
destroy(): void;
focus(): void;
addSpecialDate(date: any, specialDateClass: any, text: any): void;
getMinDate(): any;
getMaxDate(): any;
getDate(): any;
getRange(): any;
navigateForward(months: number): void;
navigateBackward(months: number): void;
render(): void;
refresh(): void;
setMinDate(date: any): void;
setMaxDate(date: any): void;
setDate(date: any): void;
setRange(date: any, date2: any): void;
today(): void;
val(value: Date | string, value2: Date | string): Date | string;
}// jqxCalendar
export interface ChartDraw {
// ChartDraw properties
renderer?: any;
rect?: any;
}// ChartDraw
export interface ChartDrawBefore {
// ChartDrawBefore properties
renderer?: any;
rect?: any;
}// ChartDrawBefore
export interface ChartOffset {
// ChartOffset properties
x: number;
y: number;
}// ChartOffset
export interface ChartRect {
// ChartRect properties
x: number;
y: number;
width: number | string;
height: number | string;
}// ChartRect
export interface ChartPadding {
// ChartPadding properties
left: number;
right: number;
top: number;
bottom: number;
}// ChartPadding
export interface ChartTickMarks {
// ChartTickMarks properties
visible?: any;
color?: string;
step?: number;
dashStyle?: string;
lineWidth?: number;
size?: number | string;
interval?: any;
custom?: Array<ChartCustomOffset>;
}// ChartTickMarks
export interface ChartGridLines {
// ChartGridLines properties
visible?: any;
color?: string;
step?: number;
dashStyle?: string;
lineWidth?: number;
interval?: any;
custom?: Array<ChartCustomOffset>;
}// ChartGridLines
export interface ChartAxisLine {
// ChartAxisLine properties
visible?: any;
color?: string;
dashStyle?: string;
lineWidth?: number;
}// ChartAxisLine
export interface ChartCustomOffset {
// ChartCustomOffset properties
value?: any;
offset?: number;
}// ChartCustomOffset
export interface ChartAxisLabels {
// ChartAxisLabels properties
visible?: any;
class?: string;
step?: number;
angle?: number;
rotationPoint?: string;
horizontalAlignment?: string;
verticalAlignment?: string;
offset?: ChartOffset;
custom?: Array<ChartCustomOffset>;
formatSettings?: ChartFormatSettings;
formatFunction?: (value: any, itemIndex?: number, serieIndex?: number, groupIndex?: number, xAxisValue?: any, xAxis?: ChartXAxis) => string;
autoRotate?: boolean;
}// ChartAxisLabels
export interface ChartFormatSettings {
// ChartFormatSettings properties
prefix?: string;
sufix?: string;
decimalSeparator?: string;
thousandsSeparator?: string;
decimalPlaces?: number;
negativeWithBrackets?: boolean;
dateFormat?: string;
}// ChartFormatSettings
export interface ChartSeriesLabels {
// ChartSeriesLabels properties
visible?: boolean;
class?: string;
angle?: number;
horizontalAlignment?: string;
verticalAlignment?: string;
offset?: ChartOffset;
backgroundColor?: string;
backgroundOpacity?: number;
borderColor?: string;
borderOpacity?: number;
padding?: ChartPadding;
linesEnabled?: boolean;
linesAngles?: boolean;
autoRotate?: boolean;
radius?: any;
}// ChartSeriesLabels
export interface ChartAxisTitle {
// ChartAxisTitle properties
visible?: boolean;
text?: string;
class?: string;
horizontalAlignment?: string;
verticalAlignment?: string;
angle?: number;
rotationPoint?: string;
offset?: ChartOffset;
}// ChartAxisTitle
export interface ChartColorBand {
// ChartColorBand properties
minValue?: number;
maxValue?: number;
fillColor?: string;
opacity?: number;
lineColor?: string;
lineWidth?: number;
dashStyle?: string;
}// ChartColorBand
export interface ChartXAxis {
// ChartXAxis properties
visible?: boolean;
unitInterval?: number;
dataField?: string;
displayText?: string;
type?: string;
baseUnit?: string;
valuesOnTicks?: boolean;
dateFormat?: string;
axisSize?: number | string;
customDraw?: boolean;
flip?: boolean;
position?: string;
padding?: ChartPadding;
title?: ChartAxisTitle;
tickMarks?: ChartTickMarks;
gridLines?: ChartGridLines;
line?: ChartAxisLine;
labels?: ChartAxisLabels;
logarithmicScale?: boolean;
logarithmicScaleBase?: number;
minValue?: any;
maxValue?: any;
bands?: Array<ChartColorBand>;
alternatingBackgroundColor?: string;
alternatingBackgroundColor2?: string;
alternatingBackgroundOpacity?: number;
formatSettings?: any;
formatFunction?: any;
toolTipFormatSettings?: ChartFormatSettings;
toolTipFormatFunction?: any;
rangeSelector?: any;
textRotationAngle?: number;
}// ChartXAxis
export interface ChartSerie {
// ChartSerie properties
dataField?: string;
displayText?: string;
dataFieldFrom?: string;
displayTextFrom?: string;
dataFieldTo?: string;
displayTextTo?: string;
dataFieldOpen?: string;
displayTextOpen?: string;
dataFieldLow?: string;
displayTextLow?: string;
dataFieldHigh?: string;
displayTextHigh?: string;
dataFieldClose?: string;
displayTextClose?: string;
lineWidth?: number;
dashStyle?: string;
symbolType?: string;
symbolSize?: number;
symbolSizeSelected?: number;
emptyPointsDisplay?: string;
linesUnselectMode?: string;
opacity?: number;
useGradientColors?: boolean;
greyScale?: boolean;
lineColor?: string;
lineColorSelected?: string;
fillColor?: string;
fillColorSelected?: string;
lineColorSymbol?: string;
lineColorSymbolSelected?: string;
fillColorSymbol?: string;
fillColorSymbolSelected?: string;
fillColorAlt?: string;
fillColorAltSelected?: string;
colorFunction?: (dataValue: any, itemIndex?: number, serie?: any, group?: any) => any;
labels?: ChartSeriesLabels;
formatSettings?: ChartFormatSettings;
formatFunction?: (value: any, itemIndex?: number, serieIndex?: number, groupIndex?: number, xAxisValue?: any, xAxis?: ChartXAxis) => string;
legendFormatSettings?: ChartFormatSettings;
legendFormatFunction?: (value: any, itemIndex?: number, serieIndex?: number, groupIndex?: number, xAxisValue?: any, xAxis?: ChartXAxis) => string;
legendLineColor?: string;
legnedFillColor?: string;
toolTipFormatSettings?: ChartFormatSettings;
toolTipFormatFunction?: (value: any, itemIndex?: number, serieIndex?: number, groupIndex?: number, xAxisValue?: any, xAxis?: ChartXAxis) => string;
toolTipLineColor?: string;
toolTipBackground?: string;
toolTipClass?: string;
radius?: any;
innerRadius?: any;
startAngle?: number;
endAngle?: number;
offsetX?: number;
offsetY?: number;
hiddenPointsDisplay?: boolean;
enableSeriesToggle?: boolean;
enableSelection?: boolean;
radiusDataField?: string;
minRadius?: any;
maxRadius?: any;
summary?: string;
labelRadius?: any;
initialAngle?: number;
centerOffset?: number;
}// ChartSerie
export interface ChartValueAxis {
// ChartValueAxis properties
visible?: boolean;
flip?: boolean;
position?: string;
axisSize?: any;
minValue?: number;
maxValue?: number;
baselineValue?: number;
logarithmicScale?: boolean;
logarithmicScaleBase?: number;
valuesOnTicks?: boolean;
unitInterval?: number;
title?: ChartAxisTitle;
labels?: ChartAxisLabels;
gridLines?: ChartGridLines;
tickMarks?: ChartTickMarks;
padding?: ChartPadding;
bands?: Array<ChartColorBand>;
alternatingBackgroundColor?: string;
alternatingBackgroundColor2?: string;
alternatingBackgroundOpacity?: number;
toolTipFormatSettings?: ChartFormatSettings;
formatFunction?: any;
}// ChartValueAxis
export interface ChartSeriesGroup {
// ChartSeriesGroup properties
type: string;
orientation?: string;
valueAxis?: ChartValueAxis;
series: Array<ChartSerie>;
formatSettings?: ChartFormatSettings;
toolTipFormatFunction?: any;
columnsGapPercent?: number;
seriesGapPercent?: number;
columnsMinWidth?: number;
columnsMaxWidth?: number;
columnsTopWidthPercent?: number;
columnsBottomWidthPercent?: number;
skipOverlappingPoints?: boolean;
polar?: boolean;
spider?: boolean;
radius?: any;
startAngle?: number;
endAngle?: number;
offsetX?: number;
offsetY?: number;
source?: any;
xAxis?: ChartXAxis;
colorScheme?: string;
showLabels?: boolean;
alignEndPointsWithIntervals?: boolean;
annotations?: any;
}// ChartSeriesGroup
export interface ChartLegendLayout {
// ChartLegendLayout properties
left: number;
top: number;
width: number | string;
height: number | string;
flow: string;
}// ChartLegendLayout
export interface ChartOptions {
// ChartOptions properties
title?: string;
description?: string;
source?: any;
showBorderLine?: boolean;
borderLineColor?: string;
borderLineWidth?: number;
backgroundColor?: string;
backgroundImage?: string;
showLegend?: boolean;
legendLayout?: ChartLegendLayout;
padding?: ChartPadding;
titlePadding?: ChartPadding;
colorScheme?: string;
greyScale?: boolean;
showToolTips?: boolean;
toolTipShowDelay?: number;
toolTipHideDelay?: number;
toolTipMoveDuration?: number;
drawBefore?: (renderer?: ChartDrawBefore['renderer'], rect?: ChartDrawBefore['rect']) => void;
draw?: (renderer?: ChartDraw['renderer'], rect?: ChartDraw['rect']) => void;
rtl?: boolean;
enableCrosshairs?: boolean;
crosshairsColor?: string;
crosshairsDashStyle?: string;
crosshairsLineWidth?: number;
columnSeriesOverlap?: boolean;
enabled?: boolean;
enableAnimations?: boolean;
animationDuration?: number;
enableAxisTextAnimation?: boolean;
renderEngine?: string;
xAxis?: ChartXAxis;
valueAxis?: ChartValueAxis;
categoryAxis?: any;
seriesGroups: Array<ChartSeriesGroup>;
}// ChartOptions
export interface jqxChart extends widget, ChartOptions {
// jqxChart functions
getInstance(): any;
refresh(): void;
update(): void;
destroy(): void;
addColorScheme(schemeName: string, colors: Array<string>): void;
removeColorScheme(schemeName: string): void;
getItemsCount(groupIndex: number, serieIndex: number): number;
getItemCoord(groupIndex: number, serieIndex: number, itemIndex: number): any;
getXAxisRect(groupIndex: number): ChartRect;
getXAxisLabels(groupIndex: number): Array<any>;
getValueAxisRect(groupIndex: number): ChartRect;
getValueAxisLabels(groupIndex: number): Array<any>;
getColorScheme(colorScheme: string): Array<string>;
hideSerie(groupIndex: number, serieIndex: number, itemIndex?: number): void;
showSerie(groupIndex: number, serieIndex: number, itemIndex?: number): void;
hideToolTip(hideDelay: number): void;
showToolTip(groupIndex: number, serieIndex: number, itemIndex: number, showDelay?: number, hideDelay?: number): void;
saveAsJPEG(fileName: string, exportServerUrl?: string): void;
saveAsPNG(fileName: string, exportServerUrl?: string): void;
saveAsPDF(fileName: string, exportServerUrl?: string): void;
getXAxisValue(offset: number, groupIndex: number): any;
getValueAxisValue(offset: number, groupIndex: number): any;
}// jqxChart
export interface CheckBoxOptions {
// CheckBoxOptions properties
animationShowDelay?: number;
animationHideDelay?: number;
boxSize?: number | string;
checked?: boolean | null;
disabled?: boolean;
enableContainerClick?: boolean;
groupName?: string;
height?: number | string;
hasThreeStates?: boolean;
locked?: boolean;
rtl?: boolean;
theme?: string;
width?: number | string;
}// CheckBoxOptions
export interface jqxCheckBox extends widget, CheckBoxOptions {
// jqxCheckBox functions
check(): void;
disable(): void;
destroy(): void;
enable(): void;
focus(): void;
indeterminate(): void;
render(): void;
toggle(): void;
uncheck(): void;
val(value: boolean): boolean;
}// jqxCheckBox
export interface ColorPickerOptions {
// ColorPickerOptions properties
color?: string;
colorMode?: string;
disabled?: boolean;
height?: string | number;
showTransparent?: boolean;
width?: string | number;
}// ColorPickerOptions
export interface jqxColorPicker extends widget, ColorPickerOptions {
// jqxColorPicker functions
getColor(): any;
setColor(color: any): void;
}// jqxColorPicker
export interface ComboBoxRenderer {
// ComboBoxRenderer properties
index?: number;
label?: number | string;
value?: number | string;
}// ComboBoxRenderer
export interface ComboBoxRenderSelectedItem {
// ComboBoxRenderSelectedItem properties
index?: number;
item?: any;
}// ComboBoxRenderSelectedItem
export interface ComboBoxSearch {
// ComboBoxSearch properties
searchString?: string;
}// ComboBoxSearch
export interface ComboBoxValidateSelection {
// ComboBoxValidateSelection properties
itemValue?: string;
}// ComboBoxValidateSelection
export interface ComboBoxOptions {
// ComboBoxOptions properties
animationType?: string;
autoComplete?: boolean;
autoOpen?: boolean;
autoItemsHeight?: boolean;
autoDropDownHeight?: boolean;
closeDelay?: number;
checkboxes?: boolean;
disabled?: boolean;
displayMember?: string;
dropDownHorizontalAlignment?: string;
dropDownVerticalAlignment?: string;
dropDownHeight?: number | string;
dropDownWidth?: number | string;
enableHover?: boolean;
enableSelection?: boolean;
enableBrowserBoundsDetection?: boolean;
height?: string | number;
itemHeight?: number;
multiSelect?: boolean;
minLength?: number;
openDelay?: number;
popupZIndex?: number;
placeHolder?: string;
remoteAutoComplete?: boolean;
remoteAutoCompleteDelay?: number;
renderer?: (index?: ComboBoxRenderer['index'], label?: ComboBoxRenderer['label'], value?: ComboBoxRenderer['value']) => string;
renderSelectedItem?: (index?: ComboBoxRenderSelectedItem['index'], item?: ComboBoxRenderSelectedItem['item']) => string;
rtl?: boolean;
selectedIndex?: number;
showArrow?: boolean;
showCloseButtons?: boolean;
searchMode?: string;
search?: (searchString?: ComboBoxSearch['searchString']) => void;
source?: any;
scrollBarSize?: number | string;
template?: string;
theme?: string;
validateSelection?: (itemValue?: ComboBoxValidateSelection['itemValue']) => boolean;
valueMember?: string;
width?: string | number;
}// ComboBoxOptions
export interface jqxComboBox extends widget, ComboBoxOptions {
// jqxComboBox functions
addItem(item: any): boolean;
clearSelection(): void;
clear(): void;
close(): void;
checkIndex(index: number): void;
checkItem(item: any): void;
checkAll(): void;
destroy(): void;
disableItem(item: any): void;
disableAt(index: number): void;
enableItem(item: any): void;
enableAt(index: number): void;
ensureVisible(index: number): void;
focus(): void;
getItem(index: number): any;
getItemByValue(value: string): any;
getVisibleItems(): Array<any>;
getItems(): Array<any>;
getCheckedItems(): Array<any>;
getSelectedItem(): any;
getSelectedItems(): Array<any>;
getSelectedIndex(): number;
insertAt(item: any, index: number): boolean;
isOpened(): boolean;
indeterminateIndex(index: number): void;
indeterminateItem(item: any): void;
loadFromSelect(selectTagId: string): void;
open(): void;
removeItem(item: any): boolean;
removeAt(index: number): boolean;
selectIndex(index: number): void;
selectItem(item: any): void;
searchString(): string;
updateItem(item: any, itemValue: string): void;
updateAt(item: any, index: any): void;
unselectIndex(index: number): void;
unselectItem(item: any): void;
uncheckIndex(index: number): void;
uncheckItem(item: any): void;
uncheckAll(): void;
val(value: string): string;
}// jqxComboBox
export interface ComplexInputOptions {
// ComplexInputOptions properties
decimalNotation?: string;
disabled?: boolean;
height?: string | number;
placeHolder?: string;
roundedCorners?: boolean;
rtl?: boolean;
spinButtons?: boolean;
spinButtonsStep?: number;
template?: string;
theme?: string;
value?: string;
width?: string | number;
}// ComplexInputOptions
export interface jqxComplexInput extends widget, ComplexInputOptions {
// jqxComplexInput functions
destroy(): void;
getDecimalNotation(part: string, decimalNotation: string): string;
getReal(complexnumber: number): number;
getImaginary(complexnumber: number): number;
render(): void;
refresh(): void;
val(value: any): string;
}// jqxComplexInput
export interface DataTableColumns {
// DataTableColumns properties
text: string;
dataField: string;
displayField?: string;
sortable?: boolean;
filterable?: boolean;
hidden?: boolean;
columnGroup ?: string;
autoCellHeight?: boolean;
renderer?: (text:string, align?:string, height?: string | number) => string;
rendered?: (element:any, align?:string, height?: string | number) => boolean;
cellsRenderer?: (row:number, column?:any, value?: any, rowData?:any) => string;
columnType?: string;
validation?: (cell:number, value?:any) => any;
initEditor?: (row:number, cellValue?:any, editor?:any, cellText?:string, width?:string | number, height?:string | number) => void;
createEditor?: (row:number, cellValue?:any, editor?:any, cellText?:string, width?:string | number, height?:string | number) => void;
getEditorValue?: (row:number, cellValue?:any, editor?:any) => void;
cellsFormat?: string;
aggregates?: Array<any>;
aggregatesRenderer?: (aggregates?: any, column?: any, element?: any) => string;
align?: string;
cellsAlign?: string;
width?: number | string;
minWidth?: number | string;
maxWidth?: number | string;
resizable?: boolean;
draggable?: boolean;
editable?: boolean;
className?: string;
cellClassName?: any;
pinned?: boolean;
}// DataTableColumns
export interface DataTableColumnGroups {
// DataTableColumnGroups properties
text?: string;
parentGroup?: string;
align?: string;
name?: string;
}// DataTableColumnGroups
export interface DataTableGroupsRenderer {
// DataTableGroupsRenderer properties
value?: string;
rowdata?: any;
level?: number;
}// DataTableGroupsRenderer
export interface DataTableInitRowDetails {
// DataTableInitRowDetails properties
id?: number;
row?: number;
element?: any;
rowinfo?: any;
}// DataTableInitRowDetails
export interface DataTableRenderToolbar {
// DataTableRenderToolbar properties
toolbar?: any;
}// DataTableRenderToolbar
export interface DataTableRenderStatusBar {
// DataTableRenderStatusBar properties
statusbar?: any;
}// DataTableRenderStatusBar
export interface DataTableEditSettings {
// DataTableEditSettings properties
saveOnPageChange?: boolean;
saveOnBlur?: boolean;
saveOnSelectionChange?: boolean;
cancelOnEsc?: boolean;
saveOnEnter?: boolean;
editSingleCell?: boolean;
editOnDoubleClick?: boolean;
editOnF2?: boolean;
}// DataTableEditSettings
export interface DataTableExportSettings {
// DataTableExportSettings properties
columnsHeader?: boolean;
hiddenColumns?: boolean;
serverURL?: any;
characterSet?: any;
recordsInView?: boolean;
fileName?: string;
}// DataTableExportSettings
export interface DataTableOptions {
// DataTableOptions properties
altRows?: boolean;
autoRowHeight?: boolean;
aggregatesHeight?: number;
autoShowLoadElement?: boolean;
columnsHeight?: number;
columns?: Array<DataTableColumns>;
columnGroups?: Array<DataTableColumnGroups>;
columnsResize?: boolean;
columnsReorder?: boolean;
disabled?: boolean;
editable?: boolean;
editSettings?: DataTableEditSettings;
exportSettings?: DataTableExportSettings;
enableHover?: boolean;
enableBrowserSelection?: boolean;
filterable?: boolean;
filterHeight?: number;
filterMode?: string;
groups?: Array<any>;
groupsRenderer?: (value?:DataTableGroupsRenderer['value'], rowData?:DataTableGroupsRenderer['rowdata'], level?:DataTableGroupsRenderer['level']) => string;
height?: number | string;
initRowDetails?: (id?:DataTableInitRowDetails['id'], row?:DataTableInitRowDetails['row'], element?:DataTableInitRowDetails['element'], rowInfo?:DataTableInitRowDetails['rowinfo']) => void;
incrementalSearch?: boolean;
localization?: any;
pagerHeight?: number;
pageSize?: number;
pageSizeOptions?: Array<string | number>;
pageable?: boolean;
pagerPosition?: string;
pagerMode?: string;
pagerButtonsCount?: number;
pagerRenderer?: () => any;
ready?: () => void;
rowDetails?: boolean;
renderToolbar?: (toolbar?:DataTableRenderToolbar['toolbar']) => void;
renderStatusBar?: (statusbar?:DataTableRenderStatusBar['statusbar']) => void;
rendering?: () => void;
rendered?: () => void;
rtl?: boolean;
source?: any;
sortable?: boolean;
showAggregates?: boolean;
showToolbar?: boolean;
showStatusbar?: boolean;
enableSanitizeAll?: boolean;
statusBarHeight?: number;
scrollBarSize?: number | string;
selectionMode?: string;
serverProcessing?: boolean;
showHeader?: boolean;
theme?: string;
toolbarHeight?: number;
width?: string | number;
}// DataTableOptions
export interface jqxDataTable extends widget, DataTableOptions {
// jqxDataTable functions
addRow(rowIndex: number, rowData: any, rowPosition: any): void;
addFilter(dataField: string, filerGroup: any): void;
applyFilters(): void;
beginUpdate(): void;
beginRowEdit(rowIndex: number): void;
beginCellEdit(rowIndex: number, dataField: string): void;
clearSelection(): void;
clearFilters(): void;
clear(): void;
destroy(): void;
deleteRow(rowIndex: number): void;
endUpdate(): void;
ensureRowVisible(rowIndex: number): void;
endRowEdit(rowIndex: number, cancelChanges: boolean): void;
endCellEdit(rowIndex: number, dataField: string): void;
exportData(exportDataType: any): any;
focus(): void;
getColumnProperty(dataField: string, propertyName: string): any;
goToPage(pageIndex: number): void;
goToPrevPage(): void;
goToNextPage(): void;
getSelection(): Array<any>;
getRows(): Array<any>;
getView(): Array<any>;
getCellValue(rowIndex: number, dataField: string): any;
hideColumn(dataField: string): void;
hideDetails(rowIndex: boolean): void;
isBindingCompleted(): boolean;
lockRow(rowIndex: number): void;
refresh(): void;
render(): void;
removeFilter(dataField: string): void;
scrollOffset(top: number, left: number): void;
setColumnProperty(dataField: string, propertyName: string, propertyValue: any): void;
showColumn(dataField: string): void;
selectRow(rowIndex: number): void;
showDetails(rowIndex: number): void;
setCellValue(rowIndex: number, dataField: string, value: any): void;
sortBy(dataField: string, sortOrder: any): void;
updating(): boolean;
updateBoundData(): void;
unselectRow(rowIndex: number): void;
updateRow(rowIndex: number, rowData: any): void;
unlockRow(rowIndex: number): void;
}// jqxDataTable
export interface DateTimeInputOptions {
// DateTimeInputOptions properties
animationType?: string;
allowNullDate?: boolean;
allowKeyboardDelete?: boolean;
clearString?: string;
culture?: string;
closeDelay?: number;
closeCalendarAfterSelection?: boolean;
dropDownHorizontalAlignment?: string;
dropDownVerticalAlignment?: string;
disabled?: boolean;
enableBrowserBoundsDetection?: boolean;
enableAbsoluteSelection?: boolean;
editMode?: string;
firstDayOfWeek?: number;
formatString?: string;
height?: string | number;
min?: Date;
max?: Date;
openDelay?: number;
placeHolder?: string;
popupZIndex?: number;
rtl?: boolean;
readonly?: boolean;
showFooter?: boolean;
selectionMode?: string;
showWeekNumbers?: boolean;
showTimeButton?: boolean;
showCalendarButton?: boolean;
showDeleteButton?: boolean;
theme?: string;
template?: string;
textAlign?: string;
todayString?: string;
value?: Date | null;
width?: string | number;
yearCutoff?: number;
}// DateTimeInputOptions
export interface jqxDateTimeInput extends widget, DateTimeInputOptions {
// jqxDateTimeInput functions
close(): void;
destroy(): void;
focus(): void;
getRange(): any;
getText(): string;
getDate(): any;
getMaxDate(): any;
getMinDate(): any;
open(): void;
setRange(date: any, date2: any): void;
setMinDate(date: any): void;
setMaxDate(date: any): void;
setDate(date: any): void;
val(value: any, value2: any): any;
}// jqxDateTimeInput
export interface DockingCookieOptions {
// DockingCookieOptions properties
domain?: string;
expires?: number;
}// DockingCookieOptions
export interface DockingOptions {
// DockingOptions properties
cookies?: boolean;
cookieOptions?: DockingCookieOptions;
disabled?: boolean;
floatingWindowOpacity?: number;
height?: number | string;
keyboardNavigation?: boolean;
mode?: string;
orientation?: string;
rtl?: boolean;
theme?: string;
width?: number | string;
windowsMode?: object;
windowsOffset?: number;
}// DockingOptions
export interface jqxDocking extends widget, DockingOptions {
// jqxDocking functions
addWindow(windowId: string, mode: any, panel: number, position: any): void;
closeWindow(windowId: string): void;
collapseWindow(windowId: string): void;
destroy(): void;
disableWindowResize(windowId: string): void;
disable(): void;
exportLayout(): string;
enable(): void;
expandWindow(windowId: string): void;
enableWindowResize(windowId: string): void;
focus(): void;
hideAllCloseButtons(): void;
hideAllCollapseButtons(): void;
hideCollapseButton(windowId: string): void;
hideCloseButton(windowId: string): void;
importLayout(Json: string): void;
move(windowId: string, panel: number, position: number): void;
pinWindow(windowId: string): void;
setWindowMode(windowId: string, mode: any): void;
showCloseButton(windowId: string): void;
showCollapseButton(windowId: string): void;
setWindowPosition(windowId: string, top: any, left: number): void;
showAllCloseButtons(): void;
showAllCollapseButtons(): void;
unpinWindow(windowId: string): void;
}// jqxDocking
export interface DockingLayoutLayout {
// DockingLayoutLayout properties
type: string;
alignment?: string;
allowClose?: boolean;
allowPin?: boolean;
allowUnpin?: boolean;
contentContainer?: string;
height?: number | string;
initContent?: () => void;
minHeight?: number | string;
minWidth?: number | string;
orientation?: string;
pinnedHeight?: number | string;
pinnedWidth?: number | string;
position?: DockingLayoutLayoutPosition;
selected?: boolean;
title?: string;
unpinnedHeight?: number | string;
unpinnedWidth?: number | string;
width?: number | string;
items?: Array<DockingLayoutLayout>;
}// DockingLayoutLayout
export interface DockingLayoutLayoutPosition {
// DockingLayoutLayoutPosition properties
x: number;
y: number;
}// DockingLayoutLayoutPosition
export interface DockingLayoutOptions {
// DockingLayoutOptions properties
contextMenu?: boolean;
height?: string | number;
layout?: Array<DockingLayoutLayout>;
minGroupHeight?: number | string;
minGroupWidth?: number | string;
resizable?: boolean;
rtl?: boolean;
theme?: string;
width?: string | number;
}// DockingLayoutOptions
export interface jqxDockingLayout extends widget, DockingLayoutOptions {
// jqxDockingLayout functions
addFloatGroup(width: number | string, height: number | string, position: DockingLayoutLayoutPosition, panelType: string, title: string, content: string, initContent: any): void;
destroy(): void;
loadLayout(layout: any): void;
refresh(): void;
render(): void;
saveLayout(): any;
}// jqxDockingLayout
export interface DockPanelOptions {
// DockPanelOptions properties
disabled?: boolean;
height?: string | number;
lastchildfill?: boolean;
width?: string | number;
}// DockPanelOptions
export interface jqxDockPanel extends widget, DockPanelOptions {
// jqxDockPanel functions
refresh(): void;
}// jqxDockPanel
export interface DragDropOnDrag {
// DragDropOnDrag properties
data?: any;
position?: object;
}// DragDropOnDrag
export interface DragDropOnDragStart {
// DragDropOnDragStart properties
position?: object;
}// DragDropOnDragStart
export interface DragDropOnTargetDrop {
// DragDropOnTargetDrop properties
data?: any;
}// DragDropOnTargetDrop
export interface DragDropOnDropTargetLeave {
// DragDropOnDropTargetLeave properties
data?: any;
}// DragDropOnDropTargetLeave
export interface DragDropOptions {
// DragDropOptions properties
appendTo?: string;
disabled?: boolean;
distance?: number;
data?: any;
dropAction?: string;
dropTarget?: any;
dragZIndex?: number;
feedback?: string;
initFeedback?: (feedback?:any) => void;
opacity?: number;
onDragEnd?: () => void;
onDrag?: (data?: DragDropOnDrag['data'], position?: DragDropOnDrag['position']) => void;
onDragStart?: (position?: DragDropOnDragStart['position']) => void;
onTargetDrop?: (data?: DragDropOnTargetDrop['data']) => void;
onDropTargetEnter?: () => void;
onDropTargetLeave?: (data?: DragDropOnDropTargetLeave['data']) => void;
restricter?: string | object;
revert?: boolean;
revertDuration?: number;
tolerance?: string;
}// DragDropOptions
export interface jqxDragDrop extends widget, DragDropOptions {
// jqxDragDrop functions
}// jqxDragDrop
export interface DrawOptions {
// DrawOptions properties
renderEngine?: string;
}// DrawOptions
export interface jqxDraw extends widget, DrawOptions {
// jqxDraw functions
attr(element: any, attributes: any): void;
circle(cx: number, cy: number, r: number, attributes: any): any;
clear(): void;
getAttr(element: any, attributes: any): string;
getSize(): any;
line(x1: number, y1: number, x2: number, y2: number, attributes: any): any;
measureText(text: string, angle: number, attributes: any): any;
on(element: any, event: string, func: any): void;
off(element: any, event: string, func: any): void;
path(path: string, attributes: any): any;
pieslice(cx: number, xy: number, innerRadius: any, outerRadius: any, fromAngle: number, endAngle: number, centerOffset: number, attributes: any): any;
refresh(): void;
rect(x: number, y: number, width: number | string, height: number | string, attributes: any): any;
saveAsJPEG(image: string, url: string): void;
saveAsPNG(image: string, url: string): void;
text(text: string, x: number, y: number, width: number | string, height: number | string, angle: number, attributes: any, clip: boolean, halign: string, valign: string, rotateAround: string): any;
}// jqxDraw
export interface DropDownButtonOptions {
// DropDownButtonOptions properties
animationType?: string;
arrowSize?: number;
autoOpen?: boolean;
closeDelay?: number;
disabled?: boolean;
dropDownHorizontalAlignment?: string;
dropDownVerticalAlignment?: string;
dropDownWidth?: number | string;
enableBrowserBoundsDetection?: boolean;
height?: string | number;
initContent?: () => void;
openDelay?: number;
popupZIndex?: number;
rtl?: boolean;
template?: string;
theme?: string;
width?: string | number;
}// DropDownButtonOptions
export interface jqxDropDownButton extends widget, DropDownButtonOptions {
// jqxDropDownButton functions
close(): void;
destroy(): void;
focus(): void;
getContent(): any;
isOpened(): boolean;
open(): void;
setContent(content: string): void;
}// jqxDropDownButton
export interface DropDownListItem {
// DropDownListItem properties
label?: string;
value?: any;
disabled?: boolean;
checked?: any;
hasThreeStates?: boolean;
html?: string;
group?: string;
}// DropDownListItem
export interface DropDownListRenderer {
// DropDownListRenderer properties
index?: number;
label?: string;
value?: string;
}// DropDownListRenderer
export interface DropDownListSelectionRenderer {
// DropDownListSelectionRenderer properties
element?: any;
index?: number;
label?: string;
value?: any;
}// DropDownListSelectionRenderer
export interface DropDownListOptions {
// DropDownListOptions properties
autoOpen?: boolean;
autoDropDownHeight?: boolean;
animationType?: string;
checkboxes?: boolean;
closeDelay?: number;
disabled?: boolean;
displayMember?: string;
dropDownHorizontalAlignment?: string;
dropDownVerticalAlignment?: string;
dropDownHeight?: number | string;
dropDownWidth?: number | string;
enableSelection?: boolean;
enableBrowserBoundsDetection?: boolean;
enableHover?: boolean;
filterable?: boolean;
filterHeight?: number;
filterDelay?: number;
filterPlaceHolder?: string;
height?: number | string;
incrementalSearch?: boolean;
incrementalSearchDelay?: number;
itemHeight?: number;
openDelay?: number;
placeHolder?: string;
popupZIndex?: number;
rtl?: boolean;
renderer?: (index?: DropDownListRenderer['index'], label?: DropDownListRenderer['label'], value?: DropDownListRenderer['value']) => string;
selectionRenderer?: (element?: DropDownListSelectionRenderer['element'], index?: DropDownListSelectionRenderer['index'], label?: DropDownListSelectionRenderer['label'], value?: DropDownListSelectionRenderer['value']) => string;
searchMode?: string;
source?: Array<any>;
selectedIndex?: number;
scrollBarSize?: number;
theme?: string;
template?: string;
valueMember?: string;
width?: number | string;
}// DropDownListOptions
export interface jqxDropDownList extends widget, DropDownListOptions {
// jqxDropDownList functions
addItem(item: DropDownListItem): boolean;
clearSelection(): void;
clear(): void;
close(): void;
checkIndex(index: number): void;
checkItem(item: any): void;
checkAll(): void;
clearFilter(): void;
destroy(): void;
disableItem(item: any): void;
disableAt(index: number): void;
enableItem(item: any): void;
enableAt(index: number): void;
ensureVisible(index: number): void;
focus(): void;
getItem(index: number): DropDownListItem;
getItemByValue(itemValue: string): DropDownListItem;
getItems(): Array<DropDownListItem>;
getCheckedItems(): Array<DropDownListItem>;
getSelectedItem(): DropDownListItem;
getSelectedIndex(): number;
insertAt(item: DropDownListItem, index: number): void;
isOpened(): boolean;
indeterminateIndex(index: number): void;
indeterminateItem(item: any): void;
loadFromSelect(arg: string): void;
open(): void;
removeItem(item: any): void;
removeAt(index: number): void;
selectIndex(index: number): void;
selectItem(item: DropDownListItem): void;
setContent(content: string): void;
updateItem(newItem: DropDownListItem, item: any): void;
updateAt(item: DropDownListItem, index: number): void;
unselectIndex(index: number): void;
unselectItem(item: any): void;
uncheckIndex(index: number): void;
uncheckItem(item: any): void;
uncheckAll(): void;
val(value: string): string;
}// jqxDropDownList
export interface EditorLocalization {
// EditorLocalization properties
bold?: string;
italic?: string;
underline?: string;
format?: string;
size?: number | string;
font?: string;
html?: stri