Punchcard

Punchcard

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Simple XML for punchcards

Custom visualizations use a namespaced syntax for Simple XML. Specific visualization properties are appended to the app and visualization context.


Add a punchcard to a dashboard panel

You can add a punchcard to a dashboard panel using Simple XML. Use this syntax to specify the app and visualization context.

<viz type="punchcard_app.punchcard">
</viz>


Configure punchcard properties

To configure a punchcard property, append any of the following property names to this context.

<option name=
    "punchcard_app.punchcard.[property_name]">[property_value]
</option>
Option name Accepted values Default Example
radiusScale [local | global] local
<option name="punchcard_app.punchcard.radiusScale">global</option>
useColors [true | false] false
<option name="punchcard_app.punchcard.useColors">true</option>
colorMode [categorical | sequential] categorical
<option name="punchcard_app.punchcard.colorMode">sequential</option>
minColor Any CSS hex value #d93f3c
<option name="punchcard_app.punchcard.minColor">#3fc77a</option>
maxColor Any CSS hex value #3fc77a
<option name="punchcard_app.punchcard.maxColor">#d93f3c</option>
numOfBins Any number from 3 to 9 6
<option name="punchcard_app.punchcard.numOfBins">7</option>
labelAlignmentMode [horizontal | angle] horizontal
<option name="punchcard_app.punchcard.labelAlignmentMode">angle</option>


Example Simple XML source

Here is an example dashboard panel.


<dashboard>
  <label>Punchcard Dashboard</label>
  <row>
    <panel>
      <title>My example punchcard panel</title>
      <viz type="punchcard_app.punchcard">
        <search>
          <query>| inputlookup bikeshare.csv
| eval duration = duration_ms/60000
| stats count median(duration) by date_hour date_wday</query>
          <earliest></earliest>
          <latest></latest>
        </search>
        <option name="punchcard_app.punchcard.useColors">true</option>
        <option name="punchcard_app.punchcard.colorMode">sequential</option>
        [...]
        <option name="punchcard_app.punchcard.radiusScale">local</option>
        <option name="punchcard_app.punchcard.minColor">#f7bc38</option>
        <option name="punchcard_app.punchcard.maxColor">#d93f3c</option>
        <option name="punchcard_app.punchcard.numOfBins">7</option>
        <option name="punchcard_app.punchcard.labelAlignmentMode">angle</option>
        <option name="drilldownRedirect">true</option>
        <option name="resizable">true</option>
      </viz>
    </panel>
</row>
</dashboard>
Last modified on 12 August, 2016
PREVIOUS
Add a punchcard to a dashboard
  NEXT
Release notes

This documentation applies to the following versions of Punchcard: 1.0.0, 1.1.0, 1.2.0, 1.3.0, 1.4.0, 1.5.0


Was this documentation topic helpful?

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters