Search
Preparing search index...
The search index is not available
Swim Toolkit
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Swim Toolkit
@swim/view
ModalService
Class ModalService<V>
Type parameters
V
:
View
=
View
Hierarchy
Service
<
V
>
ModalService
Index
Constructors
constructor
Properties
matte
View
modality
modals
observer
Type
observers
roots
Accessors
attached
Methods
attach
Events
attach
Root
detach
Events
detach
Root
did
Attach
did
Attach
Root
did
Detach
did
Detach
Root
did
Dismiss
Modal
did
Displace
Modals
did
Observe
did
Present
Modal
did
Unobserve
did
Update
Modality
dismiss
Modal
dismiss
Modals
displace
Modals
for
Each
Observer
insert
Modal
View
is
Modal
observe
on
Attach
on
Attach
Root
on
Click
on
Detach
on
Detach
Root
on
Dismiss
Modal
on
Displace
Modals
on
Observe
on
Present
Modal
on
Unobserve
on
Update
Modality
present
Modal
set
Matte
View
toggle
Modal
unobserve
update
Modality
will
Attach
will
Attach
Root
will
Detach
will
Detach
Root
will
Dismiss
Modal
will
Displace
Modals
will
Observe
will
Present
Modal
will
Unobserve
will
Update
Modality
global
insert
Modal
View
Constructors
constructor
new
Modal
Service<V>
(
)
:
ModalService
<
V
>
Type parameters
V
:
View
<
V
>
=
View
Returns
ModalService
<
V
>
Properties
Readonly
matte
View
matte
View
:
null
|
View
Readonly
modality
modality
:
number
Readonly
modals
modals
:
readonly
Modal
[]
Optional
Readonly
observer
Type
observer
Type
:
Class
<
ModalServiceObserver
<
V
,
ModalService
<
V
>
>
>
Readonly
observers
observers
:
readonly
ModalServiceObserver
<
V
,
ModalService
<
V
>
>
[]
Readonly
roots
roots
:
readonly
V
[]
Accessors
attached
get
attached
(
)
:
boolean
Returns
boolean
Methods
Protected
attach
Events
attach
Events
(
view
:
V
)
:
void
Parameters
view:
V
Returns
void
attach
Root
attach
Root
(
root
:
V
)
:
void
Parameters
root:
V
Returns
void
Protected
detach
Events
detach
Events
(
view
:
V
)
:
void
Parameters
view:
V
Returns
void
detach
Root
detach
Root
(
root
:
V
)
:
void
Parameters
root:
V
Returns
void
Protected
did
Attach
did
Attach
(
)
:
void
Returns
void
Protected
did
Attach
Root
did
Attach
Root
(
root
:
V
)
:
void
Parameters
root:
V
Returns
void
Protected
did
Detach
did
Detach
(
)
:
void
Returns
void
Protected
did
Detach
Root
did
Detach
Root
(
root
:
V
)
:
void
Parameters
root:
V
Returns
void
Protected
did
Dismiss
Modal
did
Dismiss
Modal
(
modal
:
Modal
)
:
void
Parameters
modal:
Modal
Returns
void
Protected
did
Displace
Modals
did
Displace
Modals
(
event
:
null
|
Event
)
:
void
Parameters
event:
null
|
Event
Returns
void
Protected
did
Observe
did
Observe
(
observer
:
ModalServiceObserver
<
V
,
ModalService
<
V
>
>
)
:
void
Parameters
observer:
ModalServiceObserver
<
V
,
ModalService
<
V
>
>
Returns
void
Protected
did
Present
Modal
did
Present
Modal
(
modal
:
Modal
, options
:
ModalOptions
)
:
void
Parameters
modal:
Modal
options:
ModalOptions
Returns
void
Protected
did
Unobserve
did
Unobserve
(
observer
:
ModalServiceObserver
<
V
,
ModalService
<
V
>
>
)
:
void
Parameters
observer:
ModalServiceObserver
<
V
,
ModalService
<
V
>
>
Returns
void
Protected
did
Update
Modality
did
Update
Modality
(
newModality
:
number
, oldModality
:
number
)
:
void
Parameters
newModality:
number
oldModality:
number
Returns
void
dismiss
Modal
dismiss
Modal
(
modal
:
Modal
)
:
void
Parameters
modal:
Modal
Returns
void
dismiss
Modals
dismiss
Modals
(
)
:
void
Returns
void
displace
Modals
displace
Modals
(
event
:
null
|
Event
)
:
void
Parameters
event:
null
|
Event
Returns
void
Protected
for
Each
Observer
for
Each
Observer<T>
(
callback
:
(
observer
:
ModalServiceObserver
<
V
,
ModalService
<
V
>
>
)
=>
void
|
T
)
:
undefined
|
T
Type parameters
T
Parameters
callback:
(
observer
:
ModalServiceObserver
<
V
,
ModalService
<
V
>
>
)
=>
void
|
T
(
observer
:
ModalServiceObserver
<
V
,
ModalService
<
V
>
>
)
:
void
|
T
Parameters
observer:
ModalServiceObserver
<
V
,
ModalService
<
V
>
>
Returns
void
|
T
Returns
undefined
|
T
Protected
insert
Modal
View
insert
Modal
View
(
modalView
:
View
)
:
void
Parameters
modalView:
View
Returns
void
is
Modal
is
Modal
(
)
:
boolean
Returns
boolean
observe
observe
(
observer
:
ModalServiceObserver
<
V
,
ModalService
<
V
>
>
)
:
void
Parameters
observer:
ModalServiceObserver
<
V
,
ModalService
<
V
>
>
Returns
void
Protected
on
Attach
on
Attach
(
)
:
void
Returns
void
Protected
on
Attach
Root
on
Attach
Root
(
root
:
V
)
:
void
Parameters
root:
V
Returns
void
Protected
on
Click
on
Click
(
event
:
Event
)
:
void
Parameters
event:
Event
Returns
void
Protected
on
Detach
on
Detach
(
)
:
void
Returns
void
Protected
on
Detach
Root
on
Detach
Root
(
root
:
V
)
:
void
Parameters
root:
V
Returns
void
Protected
on
Dismiss
Modal
on
Dismiss
Modal
(
modal
:
Modal
)
:
void
Parameters
modal:
Modal
Returns
void
Protected
on
Displace
Modals
on
Displace
Modals
(
event
:
null
|
Event
)
:
void
Parameters
event:
null
|
Event
Returns
void
Protected
on
Observe
on
Observe
(
observer
:
ModalServiceObserver
<
V
,
ModalService
<
V
>
>
)
:
void
Parameters
observer:
ModalServiceObserver
<
V
,
ModalService
<
V
>
>
Returns
void
Protected
on
Present
Modal
on
Present
Modal
(
modal
:
Modal
, options
:
ModalOptions
)
:
void
Parameters
modal:
Modal
options:
ModalOptions
Returns
void
Protected
on
Unobserve
on
Unobserve
(
observer
:
ModalServiceObserver
<
V
,
ModalService
<
V
>
>
)
:
void
Parameters
observer:
ModalServiceObserver
<
V
,
ModalService
<
V
>
>
Returns
void
Protected
on
Update
Modality
on
Update
Modality
(
newModality
:
number
, oldModality
:
number
)
:
void
Parameters
newModality:
number
oldModality:
number
Returns
void
present
Modal
present
Modal
(
modal
:
Modal
, options
?:
ModalOptions
)
:
void
Parameters
modal:
Modal
Optional
options:
ModalOptions
Returns
void
set
Matte
View
set
Matte
View
(
matteView
:
null
|
View
)
:
void
Parameters
matteView:
null
|
View
Returns
void
toggle
Modal
toggle
Modal
(
modal
:
Modal
, options
?:
ModalOptions
)
:
void
Parameters
modal:
Modal
Optional
options:
ModalOptions
Returns
void
unobserve
unobserve
(
observer
:
ModalServiceObserver
<
V
,
ModalService
<
V
>
>
)
:
void
Parameters
observer:
ModalServiceObserver
<
V
,
ModalService
<
V
>
>
Returns
void
update
Modality
update
Modality
(
)
:
void
Returns
void
Protected
will
Attach
will
Attach
(
)
:
void
Returns
void
Protected
will
Attach
Root
will
Attach
Root
(
root
:
V
)
:
void
Parameters
root:
V
Returns
void
Protected
will
Detach
will
Detach
(
)
:
void
Returns
void
Protected
will
Detach
Root
will
Detach
Root
(
root
:
V
)
:
void
Parameters
root:
V
Returns
void
Protected
will
Dismiss
Modal
will
Dismiss
Modal
(
modal
:
Modal
)
:
void
Parameters
modal:
Modal
Returns
void
Protected
will
Displace
Modals
will
Displace
Modals
(
event
:
null
|
Event
)
:
boolean
Parameters
event:
null
|
Event
Returns
boolean
Protected
will
Observe
will
Observe
(
observer
:
ModalServiceObserver
<
V
,
ModalService
<
V
>
>
)
:
void
Parameters
observer:
ModalServiceObserver
<
V
,
ModalService
<
V
>
>
Returns
void
Protected
will
Present
Modal
will
Present
Modal
(
modal
:
Modal
, options
:
ModalOptions
)
:
void
Parameters
modal:
Modal
options:
ModalOptions
Returns
void
Protected
will
Unobserve
will
Unobserve
(
observer
:
ModalServiceObserver
<
V
,
ModalService
<
V
>
>
)
:
void
Parameters
observer:
ModalServiceObserver
<
V
,
ModalService
<
V
>
>
Returns
void
Protected
will
Update
Modality
will
Update
Modality
(
newModality
:
number
, oldModality
:
number
)
:
void
Parameters
newModality:
number
oldModality:
number
Returns
void
Static
global
global<V>
(
)
:
ModalService
<
V
>
Type parameters
V
:
View
<
V
>
Returns
ModalService
<
V
>
Static
insert
Modal
View
insert
Modal
View
(
modalView
:
View
)
:
void
Parameters
modalView:
View
Returns
void
Modules
@swim/runtime
@swim/toolkit
@swim/ui
@swim/model
@swim/style
@swim/theme
@swim/view
@swim/dom
@swim/graphics
@swim/controller
@swim/ux
@swim/vis
@swim/maps
Modal
Service
constructor
matte
View
modality
modals
observer
Type
observers
roots
attached
attach
Events
attach
Root
detach
Events
detach
Root
did
Attach
did
Attach
Root
did
Detach
did
Detach
Root
did
Dismiss
Modal
did
Displace
Modals
did
Observe
did
Present
Modal
did
Unobserve
did
Update
Modality
dismiss
Modal
dismiss
Modals
displace
Modals
for
Each
Observer
insert
Modal
View
is
Modal
observe
on
Attach
on
Attach
Root
on
Click
on
Detach
on
Detach
Root
on
Dismiss
Modal
on
Displace
Modals
on
Observe
on
Present
Modal
on
Unobserve
on
Update
Modality
present
Modal
set
Matte
View
toggle
Modal
unobserve
update
Modality
will
Attach
will
Attach
Root
will
Detach
will
Detach
Root
will
Dismiss
Modal
will
Displace
Modals
will
Observe
will
Present
Modal
will
Unobserve
will
Update
Modality
global
insert
Modal
View
Generated using
TypeDoc