docs/typedoc/classes/transitionevent.html
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>TransitionEvent | VueTransitionComponent</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">VueTransitionComponent</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">Globals</a>
</li>
<li>
<a href="transitionevent.html">TransitionEvent</a>
</li>
</ul>
<h1>Class TransitionEvent<TDataType, TEventType></h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<h3 id="transitionevent">TransitionEvent</h3>
<p>The transitionController uses the seng-event module to dispatch events to notify parent classes about
certain events. The following events can be listened to.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>TDataType</h4>
</li>
<li>
<h4>TEventType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseEvent</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">TransitionEvent</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"><a href="transitionevent.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="transitionevent.html#bubbles" class="tsd-kind-icon">bubbles</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="transitionevent.html#cancelable" class="tsd-kind-icon">cancelable</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="transitionevent.html#currenttarget" class="tsd-kind-icon">current<wbr>Target</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="transitionevent.html#data" class="tsd-kind-icon">data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="transitionevent.html#defaultprevented" class="tsd-kind-icon">default<wbr>Prevented</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="transitionevent.html#eventphase" class="tsd-kind-icon">event<wbr>Phase</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="transitionevent.html#target" class="tsd-kind-icon">target</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="transitionevent.html#timestamp" class="tsd-kind-icon">time<wbr>Stamp</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"><a href="transitionevent.html#type" class="tsd-kind-icon">type</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="transitionevent.html#calllistener" class="tsd-kind-icon">call<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"><a href="transitionevent.html#clone" class="tsd-kind-icon">clone</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="transitionevent.html#preventdefault" class="tsd-kind-icon">prevent<wbr>Default</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="transitionevent.html#stopimmediatepropagation" class="tsd-kind-icon">stop<wbr>Immediate<wbr>Propagation</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="transitionevent.html#stoppropagation" class="tsd-kind-icon">stop<wbr>Propagation</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Transition<wbr>Event<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TEventType</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TDataType</span>, bubbles<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, cancelable<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, setTimeStamp<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="transitionevent.html" class="tsd-signature-type">TransitionEvent</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from BaseEvent.__constructor</p>
<p>Overrides AbstractEvent.__constructor</p>
<ul>
<li>Defined in /Users/lars/Projects/_private/modules/transition-controller/node_modules/seng-event/lib/BaseEvent.d.ts:16</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>type: <span class="tsd-signature-type">TEventType</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The event type</p>
</div>
</div>
</li>
<li>
<h5>data: <span class="tsd-signature-type">TDataType</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The data to attach to the event</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> bubbles: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>see [[AbstractEvent]]</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> cancelable: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>see [[AbstractEvent]]</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> setTimeStamp: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>see [[AbstractEvent]]</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="transitionevent.html" class="tsd-signature-type">TransitionEvent</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="bubbles" class="tsd-anchor"></a>
<h3>bubbles</h3>
<div class="tsd-signature tsd-kind-icon">bubbles<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from AbstractEvent.bubbles</p>
<ul>
<li>Defined in /Users/lars/Projects/_private/modules/transition-controller/node_modules/seng-event/lib/AbstractEvent.d.ts:23</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If true, the event will also go through a bubbling phase. See [[EventDispatcher.dispatchEvent]]
for more information on the event phases.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="cancelable" class="tsd-anchor"></a>
<h3>cancelable</h3>
<div class="tsd-signature tsd-kind-icon">cancelable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from AbstractEvent.cancelable</p>
<ul>
<li>Defined in /Users/lars/Projects/_private/modules/transition-controller/node_modules/seng-event/lib/AbstractEvent.d.ts:30</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Indicates if <a href="transitionevent.html#preventdefault">preventDefault</a> can be called on this event. This will prevent the 'default
action' of the event from being executed. It is up to the [[EventDispatcher]] instance that dispatches the
event to stop the default action from executing when the [[EventDispatcher.dispatchEvent|dispatchEvent]]
method returns <code>false</code></p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="currenttarget" class="tsd-anchor"></a>
<h3>current<wbr>Target</h3>
<div class="tsd-signature tsd-kind-icon">current<wbr>Target<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventDispatcher</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
<aside class="tsd-sources">
<p>Inherited from AbstractEvent.currentTarget</p>
<ul>
<li>Defined in /Users/lars/Projects/_private/modules/transition-controller/node_modules/seng-event/lib/AbstractEvent.d.ts:36</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Will be updated by [[EventDispatcher]] during the dispatch of an event to the target that
listeners are currently being called on. After completion of an event dispatch this value
will be reset to <code>null</code>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="data" class="tsd-anchor"></a>
<h3>data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TDataType</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseEvent.data</p>
<ul>
<li>Defined in /Users/lars/Projects/_private/modules/transition-controller/node_modules/seng-event/lib/BaseEvent.d.ts:16</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="defaultprevented" class="tsd-anchor"></a>
<h3>default<wbr>Prevented</h3>
<div class="tsd-signature tsd-kind-icon">default<wbr>Prevented<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from AbstractEvent.defaultPrevented</p>
<ul>
<li>Defined in /Users/lars/Projects/_private/modules/transition-controller/node_modules/seng-event/lib/AbstractEvent.d.ts:59</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p> <code>true</code> if <a href="transitionevent.html#cancelable">cancelable</a> is true and <a href="transitionevent.html#preventdefault">preventDefault</a> has been called on this event.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="eventphase" class="tsd-anchor"></a>
<h3>event<wbr>Phase</h3>
<div class="tsd-signature tsd-kind-icon">event<wbr>Phase<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventPhase</span></div>
<aside class="tsd-sources">
<p>Inherited from AbstractEvent.eventPhase</p>
<ul>
<li>Defined in /Users/lars/Projects/_private/modules/transition-controller/node_modules/seng-event/lib/AbstractEvent.d.ts:49</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The current event phase of this event. During event dispatch, this value will be either
[[EventPhase.CAPTURING_PHASE|CAPTURING_PHASE]], [[EventPhase.AT_TARGET|AT_TARGET]] or
[[EventPhase.BUBBLING_PHASE|BUBBLING_PHASE]]. If this event is not currently being dispatched this will be
set to [[EventPhase.NONE|NONE]].</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="target" class="tsd-anchor"></a>
<h3>target</h3>
<div class="tsd-signature tsd-kind-icon">target<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventDispatcher</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
<aside class="tsd-sources">
<p>Inherited from AbstractEvent.target</p>
<ul>
<li>Defined in /Users/lars/Projects/_private/modules/transition-controller/node_modules/seng-event/lib/AbstractEvent.d.ts:42</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Will be updated by [[EventDispatcher]] when [[EventDispatcher.dispatchEvent|dispatchEvent]] is
called with this event. The value will be set to the EventDispatcher instance that dispatched
the event.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="timestamp" class="tsd-anchor"></a>
<h3>time<wbr>Stamp</h3>
<div class="tsd-signature tsd-kind-icon">time<wbr>Stamp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from AbstractEvent.timeStamp</p>
<ul>
<li>Defined in /Users/lars/Projects/_private/modules/transition-controller/node_modules/seng-event/lib/AbstractEvent.d.ts:55</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Indicates the time this event is dispatched in the number of milliseconds elapsed since
<em>1 January 1970 00:00:00 UTC</em>. This value will only be set if the setTimestamp parameter in the constructor
is set to <code>true</code>. Otherwise, this value will be <em>0</em>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited">
<a name="type" class="tsd-anchor"></a>
<h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TEventType</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseEvent.type</p>
<p>Overrides AbstractEvent.type</p>
<ul>
<li>Defined in /Users/lars/Projects/_private/modules/transition-controller/node_modules/seng-event/lib/BaseEvent.d.ts:15</li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="calllistener" class="tsd-anchor"></a>
<h3>call<wbr>Listener</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">call<wbr>Listener<span class="tsd-signature-symbol">(</span>handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventHandlerForEvent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallListenerResult</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from AbstractEvent.callListener</p>
<ul>
<li>Defined in /Users/lars/Projects/_private/modules/transition-controller/node_modules/seng-event/lib/AbstractEvent.d.ts:96</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Calls the given event handler, and returns an enum value that indicates if <a href="transitionevent.html#stoppropagation">stopPropagation</a> or
<a href="transitionevent.html#stopimmediatepropagation">stopImmediatePropagation</a> have been called on this event during the execution of that handler.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>handler: <span class="tsd-signature-type">EventHandlerForEvent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">></span></h5>
<div class="tsd-comment tsd-typography">
<p>The event handler to execute</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CallListenerResult</span></h4>
<p>An enum value, see [[CallListenerResult]]</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited">
<a name="clone" class="tsd-anchor"></a>
<h3>clone</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">clone<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BaseEvent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TDataType</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TEventType</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from BaseEvent.clone</p>
<p>Overrides AbstractEvent.clone</p>
<ul>
<li>Defined in /Users/lars/Projects/_private/modules/transition-controller/node_modules/seng-event/lib/BaseEvent.d.ts:26</li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BaseEvent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TDataType</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TEventType</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="preventdefault" class="tsd-anchor"></a>
<h3>prevent<wbr>Default</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">prevent<wbr>Default<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from AbstractEvent.preventDefault</p>
<ul>
<li>Defined in /Users/lars/Projects/_private/modules/transition-controller/node_modules/seng-event/lib/AbstractEvent.d.ts:89</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>May only be called when the <a href="transitionevent.html#cancelable">cancelable</a> property of an event is set to <code>true</code>. Indicates to the
instance that dispatched the event that the default action for the event should not be executed.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="stopimmediatepropagation" class="tsd-anchor"></a>
<h3>stop<wbr>Immediate<wbr>Propagation</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">stop<wbr>Immediate<wbr>Propagation<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from AbstractEvent.stopImmediatePropagation</p>
<ul>
<li>Defined in /Users/lars/Projects/_private/modules/transition-controller/node_modules/seng-event/lib/AbstractEvent.d.ts:84</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>When called during the dispatch of an event, will prevent any other event listener from being
called for this event.</p>
</div>
<dl class="tsd-comment-tags">
<dt>see</dt>
<dd><p>[[EventDispatcher.dispatchEvent]]</p>
</dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="stoppropagation" class="tsd-anchor"></a>
<h3>stop<wbr>Propagation</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">stop<wbr>Propagation<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from AbstractEvent.stopPropagation</p>
<ul>
<li>Defined in /Users/lars/Projects/_private/modules/transition-controller/node_modules/seng-event/lib/AbstractEvent.d.ts:78</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>When called during the dispatch of an event, will prevent any targets further in the event chain
from being processed. All listeners on the current target will still be executed.</p>
</div>
<dl class="tsd-comment-tags">
<dt>see</dt>
<dd><p>[[EventDispatcher.dispatchEvent]]</p>
</dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../index.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="../enums/timelinetype.html" class="tsd-kind-icon">Timeline<wbr>Type</a>
</li>
<li class=" tsd-kind-enum">
<a href="../enums/transitiondirection.html" class="tsd-kind-icon">Transition<wbr>Direction</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="abstracttransitioncontroller.html" class="tsd-kind-icon">Abstract<wbr>Transition<wbr>Controller</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-has-type-parameter">
<a href="transitionevent.html" class="tsd-kind-icon">Transition<wbr>Event</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited">
<a href="transitionevent.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="transitionevent.html#bubbles" class="tsd-kind-icon">bubbles</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="transitionevent.html#cancelable" class="tsd-kind-icon">cancelable</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="transitionevent.html#currenttarget" class="tsd-kind-icon">current<wbr>Target</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="transitionevent.html#data" class="tsd-kind-icon">data</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="transitionevent.html#defaultprevented" class="tsd-kind-icon">default<wbr>Prevented</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="transitionevent.html#eventphase" class="tsd-kind-icon">event<wbr>Phase</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="transitionevent.html#target" class="tsd-kind-icon">target</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="transitionevent.html#timestamp" class="tsd-kind-icon">time<wbr>Stamp</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited">
<a href="transitionevent.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="transitionevent.html#calllistener" class="tsd-kind-icon">call<wbr>Listener</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited">
<a href="transitionevent.html#clone" class="tsd-kind-icon">clone</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="transitionevent.html#preventdefault" class="tsd-kind-icon">prevent<wbr>Default</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="transitionevent.html#stopimmediatepropagation" class="tsd-kind-icon">stop<wbr>Immediate<wbr>Propagation</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="transitionevent.html#stoppropagation" class="tsd-kind-icon">stop<wbr>Propagation</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="../interfaces/childcomponentselector.html" class="tsd-kind-icon">Child<wbr>Component<wbr>Selector</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/iabstracttransitioncontrolleroptions.html" class="tsd-kind-icon">IAbstract<wbr>Transition<wbr>Controller<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/icreatetimelineoptions.html" class="tsd-kind-icon">ICreate<wbr>Timeline<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../index.html#componentselector" class="tsd-kind-icon">Component<wbr>Selector</a>
</li>
<li class=" tsd-kind-function">
<a href="../index.html#cleartimeline" class="tsd-kind-icon">clear<wbr>Timeline</a>
</li>
<li class=" tsd-kind-function">
<a href="../index.html#clonetimeline" class="tsd-kind-icon">clone<wbr>Timeline</a>
</li>
<li class=" tsd-kind-function">
<a href="../index.html#createtimeline" class="tsd-kind-icon">create<wbr>Timeline</a>
</li>
<li class=" tsd-kind-function">
<a href="../index.html#killandcleartimeline" class="tsd-kind-icon">kill<wbr>And<wbr>Clear<wbr>Timeline</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>