5 lines
54 KiB
JSON
5 lines
54 KiB
JSON
{
|
|
"id": "api/platform-browser/EventManager",
|
|
"title": "EventManager",
|
|
"contents": "\n\n<article>\n <div class=\"breadcrumb-container\">\n <div class=\"breadcrumb\">\n <script type=\"application/ld+json\">\n {\n \"@context\": \"http://schema.org\",\n \"@type\": \"BreadcrumbList\",\n \"itemListElement\": [\n { \"@type\": \"ListItem\", \"position\": 1, \"item\": { \"@id\": \"https://angular.io//api\", \"name\": \"API\" } },\n { \"@type\": \"ListItem\", \"position\": 2, \"item\": { \"@id\": \"https://angular.io/api/platform-browser\", \"name\": \"@angular/platform-browser\" } },\n { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://angular.io/api/platform-browser/EventManager\", \"name\": \"EventManager\" } }\n ]\n }\n </script>\n <a href=\"/api\">API</a> > <a href=\"api/platform-browser\">@angular/platform-browser</a>\n </div>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/platform-browser/src/dom/events/event_manager.ts?message=docs(platform-browser)%3A%20describe%20your%20change...#L19-L91\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/platform-browser/src/dom/events/event_manager.ts#L19-L91\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n \n <header class=\"api-header\">\n <h1 id=\"eventmanager\">EventManager<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-browser/EventManager#eventmanager\"><i class=\"material-icons\">link</i></a></h1>\n \n <label class=\"api-type-label class\">class</label>\n \n \n \n </header>\n \n <aio-toc class=\"embedded\"></aio-toc>\n\n <div class=\"api-body\">\n \n <section class=\"short-description\">\n <p>An injectable service that provides event management for Angular\nthrough a browser plug-in.</p>\n\n \n </section>\n \n \n \n <section class=\"class-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\nclass <a href=\"api/platform-browser/EventManager\" class=\"code-anchor\">EventManager</a> {\n <a class=\"code-anchor\" href=\"api/platform-browser/EventManager#constructor()\"><span class=\"member-name\">constructor</span>(plugins: EventManagerPlugin[], _zone: NgZone)</a>\n <a class=\"code-anchor\" href=\"api/platform-browser/EventManager#addEventListener\"><span class=\"member-name\">addEventListener</span>(element: HTMLElement, eventName: string, handler: Function): Function</a>\n <a class=\"code-anchor\" href=\"api/platform-browser/EventManager#addGlobalEventListener\"><span class=\"member-name\">addGlobalEventListener</span>(target: string, eventName: string, handler: Function): Function</a>\n <a class=\"code-anchor\" href=\"api/platform-browser/EventManager#getZone\"><span class=\"member-name\">getZone</span>(): NgZone</a>\n}\n</code-example>\n\n \n \n\n</section>\n\n\n \n\n \n \n \n\n\n\n\n\n\n<h2 id=\"constructor\">Constructor<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-browser/EventManager#constructor\"><i class=\"material-icons\">link</i></a></h2>\n<a id=\"constructor()\"></a>\n<table class=\"is-full-width method-table constructor\">\n \n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Initializes an instance of the event-manager service.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">constructor</span>(plugins: EventManagerPlugin[], _zone: <a href=\"api/core/NgZone\" class=\"code-anchor\">NgZone</a>)</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table constructor-overload-parameters\">\n <tbody>\n \n <tr class=\"constructor-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>plugins</code>\n </td>\n <td class=\"param-type\"><code>EventManagerPlugin[]</code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n <tr class=\"constructor-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>_zone</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/core/NgZone\" class=\"code-anchor\">NgZone</a></code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n </tbody>\n</table>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n\n\n\n\n\n\n\n<section class=\"instance-methods\">\n <h2 id=\"methods\">Methods<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-browser/EventManager#methods\"><i class=\"material-icons\">link</i></a></h2>\n \n <a id=\"addEventListener\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"addeventlistener\">\n addEventListener()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-browser/EventManager#addeventlistener\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/platform-browser/src/dom/events/event_manager.ts?message=docs(platform-browser)%3A%20describe%20your%20change...#L38-L51\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/platform-browser/src/dom/events/event_manager.ts#L38-L51\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Registers a handler for a specific element and event.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">addEventListener</span>(element: HTMLElement, eventName: string, handler: Function): Function</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-1\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>element</code>\n </td>\n <td class=\"param-type\"><code>HTMLElement</code></td>\n <td class=\"param-description\">\n <p>The HTML element to receive event notifications.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>eventName</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The name of the event to listen for.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>handler</code>\n </td>\n <td class=\"param-type\"><code>Function</code></td>\n <td class=\"param-description\">\n <p>A function to call when the notification occurs. Receives the\nevent object as an argument.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns\">Returns</h6>\n <p><code>Function</code>: A callback function that can be used to remove the handler.</p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"addGlobalEventListener\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"addglobaleventlistener\">\n addGlobalEventListener()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-browser/EventManager#addglobaleventlistener\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/platform-browser/src/dom/events/event_manager.ts?message=docs(platform-browser)%3A%20describe%20your%20change...#L52-L65\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/platform-browser/src/dom/events/event_manager.ts#L52-L65\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Registers a global handler for an event in a target view.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">addGlobalEventListener</span>(target: string, eventName: string, handler: Function): Function</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-2\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>target</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>A target for global event notifications. One of \"window\", \"document\", or \"body\".</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>eventName</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The name of the event to listen for.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>handler</code>\n </td>\n <td class=\"param-type\"><code>Function</code></td>\n <td class=\"param-description\">\n <p>A function to call when the notification occurs. Receives the\nevent object as an argument.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-1\">Returns</h6>\n <p><code>Function</code>: A callback function that can be used to remove the handler.</p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"getZone\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"getzone\">\n getZone()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-browser/EventManager#getzone\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/platform-browser/src/dom/events/event_manager.ts?message=docs(platform-browser)%3A%20describe%20your%20change...#L66-L72\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/platform-browser/src/dom/events/event_manager.ts#L66-L72\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Retrieves the compilation zone in which event listeners are registered.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">getZone</span>(): <a href=\"api/core/NgZone\" class=\"code-anchor\">NgZone</a></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-3\">Parameters</h6>\n <p>There are no parameters.</p>\n\n \n <h6 class=\"no-anchor\" id=\"returns-2\">Returns</h6>\n <p><code><a href=\"api/core/NgZone\" class=\"code-anchor\">NgZone</a></code></p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n</section>\n\n\n\n \n\n\n </div>\n</article>\n\n<!-- links to this doc:\n - api/platform-browser\n-->\n<!-- links from this doc:\n - /api\n - api/core/NgZone\n - api/platform-browser\n - api/platform-browser/EventManager#addEventListener\n - api/platform-browser/EventManager#addGlobalEventListener\n - api/platform-browser/EventManager#addeventlistener\n - api/platform-browser/EventManager#addglobaleventlistener\n - api/platform-browser/EventManager#constructor\n - api/platform-browser/EventManager#constructor()\n - api/platform-browser/EventManager#eventmanager\n - api/platform-browser/EventManager#getZone\n - api/platform-browser/EventManager#getzone\n - api/platform-browser/EventManager#methods\n - https://github.com/angular/angular/edit/master/packages/platform-browser/src/dom/events/event_manager.ts?message=docs(platform-browser)%3A%20describe%20your%20change...#L19-L91\n - https://github.com/angular/angular/edit/master/packages/platform-browser/src/dom/events/event_manager.ts?message=docs(platform-browser)%3A%20describe%20your%20change...#L38-L51\n - https://github.com/angular/angular/edit/master/packages/platform-browser/src/dom/events/event_manager.ts?message=docs(platform-browser)%3A%20describe%20your%20change...#L52-L65\n - https://github.com/angular/angular/edit/master/packages/platform-browser/src/dom/events/event_manager.ts?message=docs(platform-browser)%3A%20describe%20your%20change...#L66-L72\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/platform-browser/src/dom/events/event_manager.ts#L19-L91\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/platform-browser/src/dom/events/event_manager.ts#L38-L51\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/platform-browser/src/dom/events/event_manager.ts#L52-L65\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/platform-browser/src/dom/events/event_manager.ts#L66-L72\n-->"
|
|
} |