media-embed/utils
module
Type Definitions
-
module:media-embed/utils~MediaOptions
Functions
-
createMediaFigureElement( writer, registry, url, options ) → ViewContainerElementinternalmodule:media-embed/utils~createMediaFigureElementCreates a view element representing the media. Either a "semantic" one for the data pipeline:
<figure class="media"> <oembed url="foo"></oembed> </figure>Copy codeor a "non-semantic" (for the editing view pipeline):
<figure class="media"> <div data-oembed-url="foo">[ non-semantic media preview for "foo" ]</div> </figure>Copy codeParameters
writer : ViewDowncastWriterregistry : MediaRegistryurl : stringoptions : MediaOptions
Returns
-
getSelectedMediaModelWidget( selection ) → null | ModelElementinternalmodule:media-embed/utils~getSelectedMediaModelWidgetReturns a selected media element in the model, if any.
Parameters
selection : ModelSelection | ModelDocumentSelection
Returns
null | ModelElement
-
getSelectedMediaViewWidget( selection ) → null | ViewElementinternalmodule:media-embed/utils~getSelectedMediaViewWidgetReturns a media widget editing view element if one is selected.
Parameters
selection : ViewDocumentSelection
Returns
null | ViewElement
-
insertMedia( model, url, selectable, findOptimalPosition ) → voidinternalmodule:media-embed/utils~insertMediaCreates a media element and inserts it into the model.
Note: This method will use
model.insertContent()logic of inserting content if noinsertPositionis passed.Parameters
model : Modelurl : stringAn URL of an embeddable media.
selectable : ModelSelectablefindOptimalPosition : booleanIf true it will try to find optimal position to insert media without breaking content in which a selection is.
Returns
void
-
isMediaWidget( viewElement ) → booleaninternalmodule:media-embed/utils~isMediaWidgetChecks if a given view element is a media widget.
Parameters
viewElement : ViewElement
Returns
boolean
-
toMediaWidget( viewElement, writer, label ) → ViewElementinternalmodule:media-embed/utils~toMediaWidgetConverts a given
ViewElementto a media embed widget:- Adds a custom property allowing to recognize the media widget element.
- Calls the
toWidgetfunction with the proper element's label creator.
Parameters
viewElement : ViewElementwriter : ViewDowncastWriterAn instance of the view writer.
label : stringThe element's label.
Returns