automizy-js-api/external/automizy-js/doc/example.html

JavaScript API library for Automizy Marketing Automation software

<div id='doc-container'>
    <h1>Module name</h1>
    <div class='description-label'>Description:
        <div class='description'>Descr.</div>
    </div>
    <section>
        <h2 class='quick-nav'>Quick navigation <a href='#moduleName/entry-examples'>Examples</a></h2>
        <table class='doc-content-table'>
            <tr>
                <td>
                    <h3>Options</h3>
                    <ul>
                        <li><a href='#moduleName/option/buttons'>buttons</a></li>
                        <li><a href='#moduleName/option/data'>data</a></li>
                        <li><a href='#moduleName/option/id'>id</a></li>
                        <li><a href='#moduleName/option/skin'>skin</a></li>
                    </ul>
                </td>
                <td>
                    <h3>Methods</h3>
                    <ul>
                        <li><a href='#moduleName/method/addButton'>addButton</a></li>
                        <li><a href='#moduleName/method/draw'>draw</a></li>
                        <li><a href='#moduleName/method/drawTo'>drawTo</a></li>
                        <li><a href='#moduleName/method/hide'>hide</a></li>
                        <li><a href='#moduleName/method/remove'>remove</a></li>
                        <li><a href='#moduleName/method/removeButton'>removeButton</a></li>
                        <li><a href='#moduleName/method/show'>show</a></li>
                        <li><a href='#moduleName/method/widget'>widget</a></li>
                    </ul>
                </td>
                <td>
                    <h3>Events</h3>
                    <ul>
                        <li><a href='#moduleName/event/create'>create</a></li>
                    </ul>
                </td>
            </tr>
        </table>
    </section>

    <section>
        <h2>Options</h2>
        
        <article id='moduleName/option/optionName'>
            <h4 class='option-name'>optionName</h4>
            <div class='option-attributes'>
                Type:<div class='option-type'>Boolean</div>
            </div>
            <div class='option-attributes'>
                Default value:<div class='option-default-value'>true</div>
            </div>
            <p class='option-use'>
                Type here how to use this option.
            </p>
            <div class='option-examples'>Code examples</div>
            Initialize the moduleName widget with the <code>optionName</code> option specified, using object in constructor<br>
            <pre class='prettyprint linenums'>
Give some examples here!
            </pre>
            Initialize the moduleName widget with the <code>optionName</code> option specified, using method chaining
            <pre class='prettyprint linenums'>
Give some examples here!
            </pre>
            <br>Get or set the <code>optionName</code> option, after initialization<br>
            <pre class='prettyprint linenums'>
Give some examples here!
            </pre>
        </article>
        
        <article id='moduleName/option/buttons'></article>
        <article id='moduleName/option/data'></article>
        <article id='moduleName/option/id'></article>
        <article id='moduleName/option/skin'></article>
    </section>
    
    <section>
        <h2>Methods</h2>
        <article id='moduleName/method/'>
            <h4 class='method-name'>Method_name</h4>
            <div class='method-attributes'>
                Returns:<div class='method-returns'>Boolean</div>
            </div>
            <p class='method-use'>
                Type here how to use this method.
            </p>                    
            <ul>
                <li>
                    <div class='method-parameter'>

                    </div>
                </li>
            </ul>
            <div class='method-examples'>Code examples</div>
            <pre class='prettyprint linenums'>
Give some examples here!
            </pre>
        </article>

        <article id='moduleName/method/addButton'></article>
        <article id='moduleName/method/draw'></article>
        <article id='moduleName/method/drawTo'></article>
        <article id='moduleName/method/hide'></article>
        <article id='moduleName/method/remove'></article>
        <article id='moduleName/method/removeButton'></article>
        <article id='moduleName/method/show'></article>
        <article id='moduleName/method/widget'></article>
        
    </section>

    <section>
        <h2>Events</h2>
        <article id='moduleName/event/'>
            <h4 class='event-name'>Event name</h4>
            <div class='event-attributes'>
                Returns:<div class='event-returns'>type</div>
            </div>
            <p class='event-use'>
                Type here how to use this event.
            </p>               
            <ul>
                <li>
                    <div class='event-parameter'>
                        event
                    </div>
                    Type: <code>function</code><br>
                    The event to be triggered
                </li>
            </ul>
            <div class='event-examples'>Code examples</div>
            <pre class='prettyprint linenums'>
Give some examples here!
            </pre>
        </article>
        
        <article id='moduleName/event/create'></article>
        
    </section>
    
    <section>
        <h2>Examples</h2>
        <article id='moduleName/entry-examples' class='last'>
            <h3>A simple module </h3>
            <pre id='module-example' class='prettyprint linenums'></pre>
            <h3>Demo:</h3>
            <div id='module-demo'></div>
        </article>
    </section>
</div>