larsvanbraam/transition-controller

View on GitHub
docs/typedoc/interfaces/iabstracttransitioncontrolleroptions.html

Summary

Maintainability
Test Coverage
<!doctype html>
<html class="default no-js">
<head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <title>IAbstractTransitionControllerOptions | 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="iabstracttransitioncontrolleroptions.html">IAbstractTransitionControllerOptions</a>
                </li>
            </ul>
            <h1>Interface IAbstractTransitionControllerOptions</h1>
        </div>
    </div>
</header>
<div class="container container-main">
    <div class="row">
        <div class="col-8 col-content">
            <section class="tsd-panel tsd-hierarchy">
                <h3>Hierarchy</h3>
                <ul class="tsd-hierarchy">
                    <li>
                        <span class="target">IAbstractTransitionControllerOptions</span>
                    </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 ">
                            <h3>Properties</h3>
                            <ul class="tsd-index-list">
                                <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iabstracttransitioncontrolleroptions.html#debug" class="tsd-kind-icon">debug</a></li>
                                <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iabstracttransitioncontrolleroptions.html#loopid" class="tsd-kind-icon">loop<wbr>Id</a></li>
                                <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iabstracttransitioncontrolleroptions.html#name" class="tsd-kind-icon">name</a></li>
                                <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iabstracttransitioncontrolleroptions.html#transitioncontroller" class="tsd-kind-icon">transition<wbr>Controller</a></li>
                                <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iabstracttransitioncontrolleroptions.html#transitioninid" class="tsd-kind-icon">transition<wbr>InId</a></li>
                                <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iabstracttransitioncontrolleroptions.html#transitionoutid" class="tsd-kind-icon">transition<wbr>Out<wbr>Id</a></li>
                            </ul>
                        </section>
                    </div>
                </section>
            </section>
            <section class="tsd-panel-group tsd-member-group ">
                <h2>Properties</h2>
                <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
                    <a name="debug" class="tsd-anchor"></a>
                    <h3><span class="tsd-flag ts-flagOptional">Optional</span> debug</h3>
                    <div class="tsd-signature tsd-kind-icon">debug<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/larsvanbraam/transition-controller/blob/402a1b3/src/lib/interface/IAbstractTranstitionControllerOptions.ts#L10">interface/IAbstractTranstitionControllerOptions.ts:10</a></li>
                        </ul>
                    </aside>
                    <div class="tsd-comment tsd-typography">
                        <div class="lead">
                            <p>When set to true we show logs in the flow</p>
                        </div>
                    </div>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
                    <a name="loopid" class="tsd-anchor"></a>
                    <h3><span class="tsd-flag ts-flagOptional">Optional</span> loop<wbr>Id</h3>
                    <div class="tsd-signature tsd-kind-icon">loop<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/larsvanbraam/transition-controller/blob/402a1b3/src/lib/interface/IAbstractTranstitionControllerOptions.ts#L25">interface/IAbstractTranstitionControllerOptions.ts:25</a></li>
                        </ul>
                    </aside>
                    <div class="tsd-comment tsd-typography">
                        <div class="lead">
                            <p>The active looping id that is used when creating the transition controller</p>
                        </div>
                    </div>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
                    <a name="name" class="tsd-anchor"></a>
                    <h3><span class="tsd-flag ts-flagOptional">Optional</span> name</h3>
                    <div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/larsvanbraam/transition-controller/blob/402a1b3/src/lib/interface/IAbstractTranstitionControllerOptions.ts#L5">interface/IAbstractTranstitionControllerOptions.ts:5</a></li>
                        </ul>
                    </aside>
                    <div class="tsd-comment tsd-typography">
                        <div class="lead">
                            <p>The name of the component that is used for logging, if no name is provided it uses a fallback name</p>
                        </div>
                    </div>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
                    <a name="transitioncontroller" class="tsd-anchor"></a>
                    <h3><span class="tsd-flag ts-flagOptional">Optional</span> transition<wbr>Controller</h3>
                    <div class="tsd-signature tsd-kind-icon">transition<wbr>Controller<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/larsvanbraam/transition-controller/blob/402a1b3/src/lib/interface/IAbstractTranstitionControllerOptions.ts#L30">interface/IAbstractTranstitionControllerOptions.ts:30</a></li>
                        </ul>
                    </aside>
                    <div class="tsd-comment tsd-typography">
                        <div class="lead">
                            <p>The reference to the transition controller instance on your parent controller</p>
                        </div>
                    </div>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
                    <a name="transitioninid" class="tsd-anchor"></a>
                    <h3><span class="tsd-flag ts-flagOptional">Optional</span> transition<wbr>InId</h3>
                    <div class="tsd-signature tsd-kind-icon">transition<wbr>InId<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/larsvanbraam/transition-controller/blob/402a1b3/src/lib/interface/IAbstractTranstitionControllerOptions.ts#L15">interface/IAbstractTranstitionControllerOptions.ts:15</a></li>
                        </ul>
                    </aside>
                    <div class="tsd-comment tsd-typography">
                        <div class="lead">
                            <p>The active transition in id that is used when creating the transition in timeline.</p>
                        </div>
                    </div>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
                    <a name="transitionoutid" class="tsd-anchor"></a>
                    <h3><span class="tsd-flag ts-flagOptional">Optional</span> transition<wbr>Out<wbr>Id</h3>
                    <div class="tsd-signature tsd-kind-icon">transition<wbr>Out<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/larsvanbraam/transition-controller/blob/402a1b3/src/lib/interface/IAbstractTranstitionControllerOptions.ts#L20">interface/IAbstractTranstitionControllerOptions.ts:20</a></li>
                        </ul>
                    </aside>
                    <div class="tsd-comment tsd-typography">
                        <div class="lead">
                            <p>The active transition in id that is used when creating the transition out timeline.</p>
                        </div>
                    </div>
                </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="../classes/abstracttransitioncontroller.html" class="tsd-kind-icon">Abstract<wbr>Transition<wbr>Controller</a>
                    </li>
                    <li class=" tsd-kind-class tsd-has-type-parameter">
                        <a href="../classes/transitionevent.html" class="tsd-kind-icon">Transition<wbr>Event</a>
                    </li>
                    <li class=" tsd-kind-interface tsd-has-type-parameter">
                        <a href="childcomponentselector.html" class="tsd-kind-icon">Child<wbr>Component<wbr>Selector</a>
                    </li>
                </ul>
                <ul class="current">
                    <li class="current tsd-kind-interface">
                        <a href="iabstracttransitioncontrolleroptions.html" class="tsd-kind-icon">IAbstract<wbr>Transition<wbr>Controller<wbr>Options</a>
                        <ul>
                            <li class=" tsd-kind-property tsd-parent-kind-interface">
                                <a href="iabstracttransitioncontrolleroptions.html#debug" class="tsd-kind-icon">debug</a>
                            </li>
                            <li class=" tsd-kind-property tsd-parent-kind-interface">
                                <a href="iabstracttransitioncontrolleroptions.html#loopid" class="tsd-kind-icon">loop<wbr>Id</a>
                            </li>
                            <li class=" tsd-kind-property tsd-parent-kind-interface">
                                <a href="iabstracttransitioncontrolleroptions.html#name" class="tsd-kind-icon">name</a>
                            </li>
                            <li class=" tsd-kind-property tsd-parent-kind-interface">
                                <a href="iabstracttransitioncontrolleroptions.html#transitioncontroller" class="tsd-kind-icon">transition<wbr>Controller</a>
                            </li>
                            <li class=" tsd-kind-property tsd-parent-kind-interface">
                                <a href="iabstracttransitioncontrolleroptions.html#transitioninid" class="tsd-kind-icon">transition<wbr>InId</a>
                            </li>
                            <li class=" tsd-kind-property tsd-parent-kind-interface">
                                <a href="iabstracttransitioncontrolleroptions.html#transitionoutid" class="tsd-kind-icon">transition<wbr>Out<wbr>Id</a>
                            </li>
                        </ul>
                    </li>
                </ul>
                <ul class="after-current">
                    <li class=" tsd-kind-interface">
                        <a href="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>