ngx-editor-plus

<!doctype html> <html class="no-js" lang=""> <head> <meta charset="utf-8"> <meta http-equiv="x-ua-compatible" content="ie=edge"> <title>NgxEditor</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="icon" type="image/x-icon" href="../images/favicon.ico"> <link rel="stylesheet" href="../styles/style.css"> </head> <body> <div class="navbar navbar-default navbar-fixed-top visible-xs"> <a href="../" class="navbar-brand">NgxEditor</a> <button type="button" class="btn btn-default btn-menu fa fa-bars" id="btn-menu"></button> </div> <div class="xs-menu menu" id="mobile-menu"> <div id="book-search-input" role="search"> <input type="text" placeholder="Type to search"> </div> <nav> <ul class="list"> <li class="title"> <a href="../index.html">NgxEditor</a> </li> <li class="divider"></li> <li class="chapter"> <a data-type="chapter-link" href="../index.html"><span class="fa fa-home"></span>Getting started</a> <ul class="links"> <li class="link"> <a href="../overview.html" href="../overview.html" > <span class="fa fa-th"></span>Overview </a> </li> <li class="link"> <a href="../index.html" ><span class="fa fa-file-text-o"></span>README</a> </li> <li class="link"> <a href="../license.html" > <span class="fa fa-file-text-o"></span>LICENSE </a> </li> </ul> </li> <li class="chapter"> <a data-type="chapter-link" href="../modules.html" > <div class="menu-toggler linked" data-toggle="collapse" data-target="#xs-modules-links" > <span class="fa fa-archive"></span> <span class="link-name">Modules</span> <span class="fa fa-angle-down"></span> </div> </a> <ul class="links collapse " id="xs-modules-links" > <li class="link"> <a href="../modules/NgxEditorModule.html" >NgxEditorModule</a> </li> </ul> </li> <li class="chapter"> <div class="simple menu-toggler" data-toggle="collapse" data-target="#xs-components-links" > <span class="fa fa-cogs"></span> <span>Components</span> <span class="fa fa-angle-down"></span> </div> <ul class="links collapse " id="xs-components-links" > <li class="link"> <a href="../components/NgxEditorComponent.html" >NgxEditorComponent</a> </li> <li class="link"> <a href="../components/NgxEditorMessageComponent.html" >NgxEditorMessageComponent</a> </li> <li class="link"> <a href="../components/NgxEditorToolbarComponent.html" >NgxEditorToolbarComponent</a> </li> <li class="link"> <a href="../components/NgxGrippieComponent.html" >NgxGrippieComponent</a> </li> </ul> </li> <li class="chapter"> <div class="simple menu-toggler" data-toggle="collapse" data-target="#xs-injectables-links" > <span class="fa fa-long-arrow-down"></span> <span>Injectables</span> <span class="fa fa-angle-down"></span> </div> <ul class="links collapse " id="xs-injectables-links" > <li class="link"> <a href="../injectables/CommandExecutorService.html" >CommandExecutorService</a> </li> <li class="link"> <a href="../injectables/MessageService.html" data-type="entity-link" class="active" >MessageService</a> </li> </ul> </li> <li class="chapter"> <div class="simple menu-toggler" data-toggle="collapse" data-target="#xs-miscellaneous-links" > <span class="fa fa-cubes"></span> <span>Miscellaneous</span> <span class="fa fa-angle-down"></span> </div> <ul class="links collapse " id="xs-miscellaneous-links" > <li class="link"> <a href="../miscellaneous/functions.html" data-type="entity-link" >Functions</a> </li> <li class="link"> <a href="../miscellaneous/variables.html" data-type="entity-link" >Variables</a> </li> </ul> </li> </ul> </nav> </div> <div class="container-fluid main"> <div class="row main"> <div class="hidden-xs menu"> <nav> <ul class="list"> <li class="title"> <a href="../index.html">NgxEditor</a> </li> <li class="divider"></li> <div id="book-search-input" role="search"> <input type="text" placeholder="Type to search"> </div> <li class="chapter"> <a data-type="chapter-link" href="../index.html"><span class="fa fa-home"></span>Getting started</a> <ul class="links"> <li class="link"> <a href="../overview.html" href="../overview.html" > <span class="fa fa-th"></span>Overview </a> </li> <li class="link"> <a href="../index.html" ><span class="fa fa-file-text-o"></span>README</a> </li> <li class="link"> <a href="../license.html" > <span class="fa fa-file-text-o"></span>LICENSE </a> </li> </ul> </li> <li class="chapter"> <a data-type="chapter-link" href="../modules.html" > <div class="menu-toggler linked" data-toggle="collapse" data-target="#modules-links" > <span class="fa fa-archive"></span> <span class="link-name">Modules</span> <span class="fa fa-angle-down"></span> </div> </a> <ul class="links collapse " id="modules-links" > <li class="link"> <a href="../modules/NgxEditorModule.html" >NgxEditorModule</a> </li> </ul> </li> <li class="chapter"> <div class="simple menu-toggler" data-toggle="collapse" data-target="#components-links" > <span class="fa fa-cogs"></span> <span>Components</span> <span class="fa fa-angle-down"></span> </div> <ul class="links collapse " id="components-links" > <li class="link"> <a href="../components/NgxEditorComponent.html" >NgxEditorComponent</a> </li> <li class="link"> <a href="../components/NgxEditorMessageComponent.html" >NgxEditorMessageComponent</a> </li> <li class="link"> <a href="../components/NgxEditorToolbarComponent.html" >NgxEditorToolbarComponent</a> </li> <li class="link"> <a href="../components/NgxGrippieComponent.html" >NgxGrippieComponent</a> </li> </ul> </li> <li class="chapter"> <div class="simple menu-toggler" data-toggle="collapse" data-target="#injectables-links" > <span class="fa fa-long-arrow-down"></span> <span>Injectables</span> <span class="fa fa-angle-down"></span> </div> <ul class="links collapse " id="injectables-links" > <li class="link"> <a href="../injectables/CommandExecutorService.html" >CommandExecutorService</a> </li> <li class="link"> <a href="../injectables/MessageService.html" data-type="entity-link" class="active" >MessageService</a> </li> </ul> </li> <li class="chapter"> <div class="simple menu-toggler" data-toggle="collapse" data-target="#miscellaneous-links" > <span class="fa fa-cubes"></span> <span>Miscellaneous</span> <span class="fa fa-angle-down"></span> </div> <ul class="links collapse " id="miscellaneous-links" > <li class="link"> <a href="../miscellaneous/functions.html" data-type="entity-link" >Functions</a> </li> <li class="link"> <a href="../miscellaneous/variables.html" data-type="entity-link" >Variables</a> </li> </ul> </li> </ul> </nav> </div> <div class="content injectable"> <div class="content-data"> <ol class="breadcrumb"> <li>Injectables</li> <li>MessageService</li> </ol> <ul class="nav nav-tabs" role="tablist"> <li class="active"> <a href="#info" id="info-tab" role="tab" data-toggle="tab" data-link="info">Info</a> </li> <li> <a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a> </li> </ul> <div class="tab-content"> <div class="tab-pane fade active in" id="c-info"> <p class="comment"> <h3>File</h3> </p> <p class="comment"> <code>src/app/ngx-editor/common/services/message.service.ts</code> </p> <section> <h3 id="index">Index</h3> <table class="table table-sm table-bordered index-table"> <tbody> <tr> <td class="col-md-4"> <h6><b>Methods</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <a href="#getMessage">getMessage</a> </li> <li> <a href="#sendMessage">sendMessage</a> </li> </ul> </td> </tr> </tbody> </table> </section> <section> <h3 id="constructor">Constructor</h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <code>constructor()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="11" class="link-to-prism">src/app/ngx-editor/common/services/message.service.ts:11</a></div> </td> </tr> </tbody> </table> </section> <section> <h3 id="methods"> Methods </h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="getMessage"></a> <span class="name"> <b> getMessage </b> <a href="#getMessage"><span class="fa fa-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>getMessage()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="15" class="link-to-prism">src/app/ngx-editor/common/services/message.service.ts:15</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Returns : </b> <code>Observable<string></code> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="sendMessage"></a> <span class="name"> <b> sendMessage </b> <a href="#sendMessage"><span class="fa fa-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>sendMessage(message: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="24" class="link-to-prism">src/app/ngx-editor/common/services/message.service.ts:24</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>sends message to the editor</p> </div> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> <td>Description</td> </tr> </thead> <tbody> <tr> <td>message</td> <td> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code> </td> <td> </td> <td><p>message to be sent</p> </td> </tr> </tbody> </table> </div> <div> </div> <div class="io-description"> <b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> </section> </div> <div class="tab-pane fade tab-source-code" id="c-source"> <pre class="line-numbers"><code class="language-typescript">import { Injectable } from '@angular/core'; import { Subject } from 'rxjs/Subject'; import { Observable } from 'rxjs/Observable'; import 'rxjs/add/operator/map'; const FIVE_SECONDS = 5000; @Injectable() export class MessageService { private message: Subject<string> = new Subject(); constructor() { } getMessage(): Observable<string> { return this.message.asObservable(); } /** * sends message to the editor * * @param message message to be sent */ sendMessage(message: string): void { this.message.next(message); this.clearMessageIn(FIVE_SECONDS); return; } /** * a short interval to clear message * * @param milliseconds time in seconds in which the message has to be cleared */ private clearMessageIn(milliseconds: number): void { setTimeout(() => { this.message.next(undefined); }, milliseconds); return; } } </code></pre> </div> </div> </div><div class="search-results"> <div class="has-results"> <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1> <ul class="search-results-list"></ul> </div> <div class="no-results"> <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1> </div> </div> </div> </div> </div> <script src="../js/libs/bootstrap-native.js"></script> <script src="../js/libs/es6-shim.min.js"></script> <script src="../js/libs/EventDispatcher.js"></script> <script src="../js/libs/promise.min.js"></script> <script src="../js/libs/zepto.min.js"></script> <script src="../js/compodoc.js"></script> <script>var COMPODOC_CURRENT_PAGE_DEPTH = 1;</script> <script src="../js/search/search.js"></script> <script src="../js/search/lunr.min.js"></script> <script src="../js/search/search-lunr.js"></script> <script src="../js/tabs.js"></script> <script src="../js/menu.js"></script> <script src="../js/libs/prism.js"></script> <script src="../js/sourceCode.js"></script> <script src="../js/search/search_index.js"></script> </body> </html>