Search
Preparing search index...
The search index is not available
Builder plugin API reference
Options
All
Public
Public/Protected
All
Inherited
Only exported
Menu
Modules
"Preloader"
Preloader
Class Preloader
Hierarchy
Dialog
Preloader
Index
Constructors
constructor
Properties
base
Elem
buttons
content
dialog
fields
header
Elem
primary
Button
title
x
Button
Methods
__construct
add
Button
clear
Notifications
hide
monitor
on
Close
on
Show
property
Dialog
Apply
property
Dialog
Close
property
Dialog
Field
remove
All
Buttons
reset
set
Auto
Resize
set
Center
Buttons
set
Content
set
Footer
Visible
set
Maximised
set
Message
set
NoScroll
set
Notification
set
Progress
set
Size
set
Size
Class
set
Title
set
Title
Visible
set
Visible
show
close
All
Constructors
constructor
new
Preloader
(
title
?:
undefined
|
string
, isStatic
?:
undefined
|
false
|
true
, content
?:
UIComponent
|
null
, keepXBtn
?:
undefined
|
false
|
true
)
:
Preloader
Parameters
Optional
title:
undefined
|
string
Optional
isStatic:
undefined
|
false
|
true
Optional
content:
UIComponent
|
null
Optional
keepXBtn:
undefined
|
false
|
true
Returns
Preloader
Properties
base
Elem
base
Elem
:
JQuery
buttons
buttons
:
JQuery
content
content
:
JQuery
dialog
dialog
:
JQuery
fields
fields
:
object
Type declaration
[
key:
string
]:
any
header
Elem
header
Elem
:
JQuery
primary
Button
primary
Button
:
JQuery
|
null
title
title
:
JQuery
x
Button
x
Button
:
JQuery
Methods
__construct
__construct
(
title
:
string
, isStatic
?:
undefined
|
false
|
true
, content
?:
UIComponent
, keepXBtn
?:
undefined
|
false
|
true
)
:
void
Parameters
title:
string
Optional
isStatic:
undefined
|
false
|
true
Optional
content:
UIComponent
Optional
keepXBtn:
undefined
|
false
|
true
Returns
void
add
Button
add
Button
(
name
:
string
, callback
?:
undefined
|
function
, primary
?:
undefined
|
false
|
true
, cssClass
?:
undefined
|
string
)
:
JQuery
Parameters
name:
string
Optional
callback:
undefined
|
function
Optional
primary:
undefined
|
false
|
true
Optional
cssClass:
undefined
|
string
Returns
JQuery
clear
Notifications
clear
Notifications
(
)
:
void
Returns
void
hide
hide
(
)
:
void
Returns
void
monitor
monitor
(
url
:
PreloaderMonitorUrl
|
string
, callback
:
PreloaderMonitorCallback
, noReset
:
boolean
, keepOpen
:
boolean
, errorHandler
?:
PreloaderMonitorErrorHandler
)
:
void
Parameters
url:
PreloaderMonitorUrl
|
string
callback:
PreloaderMonitorCallback
noReset:
boolean
keepOpen:
boolean
Optional
errorHandler:
PreloaderMonitorErrorHandler
Returns
void
on
Close
on
Close
(
)
:
void
Returns
void
on
Show
on
Show
(
)
:
void
Returns
void
property
Dialog
Apply
property
Dialog
Apply
(
close
?:
undefined
|
false
|
true
)
:
void
Parameters
Optional
close:
undefined
|
false
|
true
Returns
void
property
Dialog
Close
property
Dialog
Close
(
)
:
void
Returns
void
property
Dialog
Field
property
Dialog
Field
(
field
:
string
)
:
UIComponent
|
null
Parameters
field:
string
Returns
UIComponent
|
null
remove
All
Buttons
remove
All
Buttons
(
)
:
void
Returns
void
reset
reset
(
)
:
void
Returns
void
set
Auto
Resize
set
Auto
Resize
(
autoResize
:
boolean
, callback
?:
undefined
|
function
)
:
void
Parameters
autoResize:
boolean
Optional
callback:
undefined
|
function
Returns
void
set
Center
Buttons
set
Center
Buttons
(
value
:
boolean
)
:
void
Parameters
value:
boolean
Returns
void
set
Content
set
Content
(
htmlContent
:
UIComponent
|
string
|
JQuery
, keepFields
?:
undefined
|
false
|
true
)
:
void
Parameters
htmlContent:
UIComponent
|
string
|
JQuery
Optional
keepFields:
undefined
|
false
|
true
Returns
void
set
Footer
Visible
set
Footer
Visible
(
visible
:
boolean
)
:
void
Parameters
visible:
boolean
Returns
void
set
Maximised
set
Maximised
(
maximised
:
boolean
)
:
void
Parameters
maximised:
boolean
Returns
void
set
Message
set
Message
(
message
:
string
, title
?:
undefined
|
string
, type
?:
PreloaderMessageType
)
:
void
Parameters
message:
string
Optional
title:
undefined
|
string
Optional
type:
PreloaderMessageType
Returns
void
set
NoScroll
set
NoScroll
(
)
:
void
Returns
void
set
Notification
set
Notification
(
message
:
string
, title
:
string
)
:
void
Parameters
message:
string
title:
string
Returns
void
set
Progress
set
Progress
(
percents
:
number
)
:
void
Parameters
percents:
number
Returns
void
set
Size
set
Size
(
width
:
number
, height
?:
number
|
null
)
:
void
Parameters
width:
number
Optional
height:
number
|
null
Returns
void
set
Size
Class
set
Size
Class
(
sizeClass
:
""
|
"modal-sm"
|
"modal-md"
|
"modal-lg"
|
string
)
:
void
Parameters
sizeClass:
""
|
"modal-sm"
|
"modal-md"
|
"modal-lg"
|
string
Returns
void
set
Title
set
Title
(
title
:
string
)
:
void
Parameters
title:
string
Returns
void
set
Title
Visible
set
Title
Visible
(
visible
:
boolean
)
:
void
Parameters
visible:
boolean
Returns
void
set
Visible
set
Visible
(
visible
:
boolean
, noAction
?:
undefined
|
false
|
true
, ignoreEvent
?:
undefined
|
false
|
true
)
:
void
Parameters
visible:
boolean
Optional
noAction:
undefined
|
false
|
true
Optional
ignoreEvent:
undefined
|
false
|
true
Returns
void
show
show
(
htmlContent
?:
string
|
JQuery
)
:
void
Parameters
Optional
htmlContent:
string
|
JQuery
Returns
void
Static
close
All
close
All
(
)
:
void
Returns
void
Modules
"
Preloader"
Preloader
constructor
base
Elem
buttons
content
dialog
fields
header
Elem
primary
Button
title
x
Button
__construct
add
Button
clear
Notifications
hide
monitor
on
Close
on
Show
property
Dialog
Apply
property
Dialog
Close
property
Dialog
Field
remove
All
Buttons
reset
set
Auto
Resize
set
Center
Buttons
set
Content
set
Footer
Visible
set
Maximised
set
Message
set
NoScroll
set
Notification
set
Progress
set
Size
set
Size
Class
set
Title
set
Title
Visible
set
Visible
show
close
All
Preloader
Monitor
Callback
Preloader
Monitor
Error
Handler
Preloader
Message
Type