TimelineView

The Timeline view

Description

The Timeline view displays an event timeline of a given search and allows interactive modification of the search time range. This view is modified by its search manager.

Note  To allow the Timeline view to modify its search manager, you must set up a change handler in JavaScript as shown in the examples below.

Documentation

Library path

Properties

Name

Default value

Description

id Required. The unique ID for this control.
data"timeline"The type of data to retrieve from the search results
results | preview | events | summary | timeline ).
manageridnullThe ID of the search manager to bind this view to.
minimizefalseIndicates whether to display the timeline in "mini" form, requiring less vertical space.

Methods

Name

Description

renderDraws the view to the screen. Called only when you create the view manually in JavaScript.
valReturns the view's value if passed no parameters. Sets the view's value if passed a single parameter.

Events

Name

Description

changeFired when the value of the view changes.

Example (Django tag)

{% block content %}
    {% timeline id="example-timeline" managerid="example-search" %}
{% endblock content %}

{% block managers %}
    {% searchmanager id="example-search" 
        search="index=_internal | head 100"
        preview=True required_field_list="*" status_buckets=300 %}
{% endblock managers %}

{% block js %}
    <script>
        var deps = [
            "splunkjs/ready!"
        ];
        require(deps, function(mvc) {
            // Get instances of the timeline and search manager
            var mytimeline = splunkjs.mvc.Components.getInstance("example-timeline");
            var mysearch = splunkjs.mvc.Components.getInstance("example-search");

            // Update the search manager when the timeline changes
            mytimeline.on("change", function() {
                mysearch.search.set(mytimeline.val());
            });
        });
    </script>
{% endblock js %}

Example (JavaScript)

<script>
    var deps = [
        "splunkjs/ready!",
        "splunkjs/mvc/searchmanager",
        "splunkjs/mvc/timelineview"
    ];
    require(deps, function(mvc) {
        var SearchManager = require("splunkjs/mvc/searchmanager");
        var TimelineView = require("splunkjs/mvc/timelineview");

        // Instantiate components
        var mysearch = new SearchManager({
            id: "example-search",
            preview: true,
            search: "index=_internal | head 50",
            status_buckets: 300,
            required_field_list: "*"
        });
        var mytimeline = new TimelineView({
            id: "example-timeline",
            managerid: "example-search",
            el: $("#mytimelineview")
        }).render();

        // Update the search manager when the timeline changes
        mytimeline.on("change", function() {
            mysearch.search.set(mytimeline.val());
        });

    });
</script>

Code examples