OmniDataEditor API
Preparing search index...
@omnidataeditor/editor
EditorRuntime
Interface EditorRuntime<T>
Coordinate sessions, integrations, external notifications and asynchronous disposal.
interface
EditorRuntime
<
T
>
{
attach
(
host
:
HostConnection
<
T
>
)
:
Disposer
;
create
(
options
?:
CreateSessionOptions
<
T
>
)
:
EditSession
<
T
>
;
destroy
()
:
Promise
<
void
>
;
edit
(
entity
:
T
)
:
EditSession
<
T
>
;
editMany
(
entities
:
readonly
T
[]
)
:
EditSession
<
T
>
;
notifyExternalEntity
(
entity
:
T
,
meta
?:
ExternalChangeMeta
)
:
void
;
notifyExternalRemoval
(
entityKey
:
EntityKey
,
meta
?:
ExternalChangeMeta
,
)
:
void
;
on
<
K
extends
keyof
EditorEventMap
<
T
>
>
(
event
:
K
,
listener
:
(
payload
:
EditorEventMap
<
T
>
[
K
]
)
=>
void
,
)
:
Unsubscribe
;
remove
(
entity
:
T
)
:
Promise
<
RemoveOutcome
>
;
use
(
presentation
:
Presentation
<
T
>
)
:
Disposer
;
}
Type Parameters
T
Index
Methods
attach
create
destroy
edit
edit
Many
notify
External
Entity
notify
External
Removal
on
remove
use
Methods
attach
attach
(
host
:
HostConnection
<
T
>
)
:
Disposer
Parameters
host
:
HostConnection
<
T
>
Returns
Disposer
create
create
(
options
?:
CreateSessionOptions
<
T
>
)
:
EditSession
<
T
>
Parameters
Optional
options
:
CreateSessionOptions
<
T
>
Returns
EditSession
<
T
>
destroy
destroy
()
:
Promise
<
void
>
Returns
Promise
<
void
>
edit
edit
(
entity
:
T
)
:
EditSession
<
T
>
Parameters
entity
:
T
Returns
EditSession
<
T
>
edit
Many
editMany
(
entities
:
readonly
T
[]
)
:
EditSession
<
T
>
Parameters
entities
:
readonly
T
[]
Returns
EditSession
<
T
>
notify
External
Entity
notifyExternalEntity
(
entity
:
T
,
meta
?:
ExternalChangeMeta
)
:
void
Parameters
entity
:
T
Optional
meta
:
ExternalChangeMeta
Returns
void
notify
External
Removal
notifyExternalRemoval
(
entityKey
:
EntityKey
,
meta
?:
ExternalChangeMeta
)
:
void
Parameters
entityKey
:
EntityKey
Optional
meta
:
ExternalChangeMeta
Returns
void
on
on
<
K
extends
keyof
EditorEventMap
<
T
>
>
(
event
:
K
,
listener
:
(
payload
:
EditorEventMap
<
T
>
[
K
]
)
=>
void
,
)
:
Unsubscribe
Type Parameters
K
extends
keyof
EditorEventMap
<
T
>
Parameters
event
:
K
listener
:
(
payload
:
EditorEventMap
<
T
>
[
K
]
)
=>
void
Returns
Unsubscribe
remove
remove
(
entity
:
T
)
:
Promise
<
RemoveOutcome
>
Parameters
entity
:
T
Returns
Promise
<
RemoveOutcome
>
use
use
(
presentation
:
Presentation
<
T
>
)
:
Disposer
Parameters
presentation
:
Presentation
<
T
>
Returns
Disposer
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
attach
create
destroy
edit
edit
Many
notify
External
Entity
notify
External
Removal
on
remove
use
OmniDataEditor API
Loading...
Coordinate sessions, integrations, external notifications and asynchronous disposal.