Time Marker

FusionTime lets you mark events on the time axis. A time marker appears as an overlay on the canvas. When you hover the mouse pointer over a time marker, a tooltip appears with the information about the marker.

A time marker can be of two types:

• Time instance marker - It occurs at a given instance of time.
• Time band marker - It occurs over a span of time.

Time instance marker

To create a single time instance marker follow the steps below:

• Create a timeMarker object under xAxis object

• Within the timeMarker object use the start attribute to define the time instance at which the marker should be drawn.

• Within the timeMarker object use the timeFormat attribute to define the format of the time specified in the start attribute.

• Within the timeMarker object use the label attribute to define the label for the time marker.

Refer to the code below:

"xAxis": {
    "timemarker": [{
        "start": 'Mar-1982',
        "label": 'Economic downturn was triggered by {br} tight monetary policy in an effort to {br} fight mounting inflation.',
        "timeFormat": "%b-%Y"
    }],
}COPY

A sample chart with a time marker is shown below:

To create repeatable time instance markers, follow the steps given below:

• Set the above attributes and the specify the following attribute:
  • Within the timeMarker object create the repeat object to define the frequency, at which the cyclic time marker will be repeated.
  • Use the unit attribute to define the time unit for the time marker inside the repeat object. You can set its value as Year, Quarter, Month, Week, Day, Hour, Minute, Second, or Millisecond. You can also set its value as one of the weekdays (Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday).
  • Use the multiplier attribute to define the multiplier of the time unit. By default, this value is 1.
  • Use the end attribute to define the end time for the marker. Note that if you set the end of the date/time, then the marker will be presented as a band. If you omit it instead, the marker will be represented as a line.

Refer to the code below:

xAxis: {
  plot: 'Time',
  timemarker: [{
    start: 'Mar-1980',
    label: 'US inflation peaked at 14.8%.',
    timeFormat: "%b-%Y",
    repeat: {
      unit: 'Year',
      multiplier: 5
    },
    style: {
      marker: {
        fill: '#f8b8b7'
      }
    }
  },
}COPY

The sample chart with repeated time instance markers is shown below:

In the above sample, the time marker is a specific point on the time axis. You can also render the time marker from top to bottom (vertically) of the canvas by setting the value of type attribute to full within the time marker object.

Refer to the code given below:

xAxis: {
    plot: 'Time',
    timemarker: [{
        start: 'Mar-1980',
        label: 'US inflation peaked at 14.8%.',
        timeFormat: "%b-%Y",
        repeat: {
            unit: 'Year',
            multiplier: 5,
            type: 'full'
        },
        style: {
            marker: {
                fill: '#f8b8b7'
            }
        }
    }]
}COPY

A sample chart is shown below:

Time span marker

To create the marker just include the end attribute along with the other attributes of the single time instance marker under the timemarker object within the xAxis object. Refer to the code below:

Refer to the code below:

xAxis: {
    plot: 'Time',
    timemarker: [{
        start: 'Mar-1980',
        end: 'Jun-1983',
        label: 'US inflation peaked at 14.8%.',
        timeFormat: "%b-%Y",
        style: {
            marker: {
                fill: '#f8b8b7'
            }
        }
    }]
}COPY

A sample chart with time span markers is shown below:

In the above sample, the time marker has a specific height according to the width and height of the chart. You can also render the time span marker with a line from top to bottom (vertically) of the canvas by setting the value of type attribute to full within the timeMarker object.

Refer to the code given below:

xAxis: {
    plot: 'Time',
    timemarker: [{
        start: 'Mar-1980',
        end: 'Jun-1983',
        label: 'US inflation peaked at 14.8%.',
        timeFormat: "%b-%Y",
        type: 'full',
        style: {
            marker: {
                fill: '#f8b8b7'
            }
        }
    }]
}COPY

A sample chart is shown below:

Style Definition

You can set the cosmetic properties of all the parts of a time marker using familiar CSS styling approach by specifying the different style parameters in the 'style' object' of the 'timeMarker' object. Even the cosmetic properties for the hover state of each time marker element can be specified.

The image below highlights the marker-box, marker-line, and the marker-notch of the time marker.

The image below highlights the time marker and the text of the time marker.

Refer to the code given below:

"dataSource": {
    "yAxis": [{
        "timemarker": [{
            "style": {
                "marker": { }, // Affects style of marker box, line and notch
                "marker:hover": { }, // Affects hover style of marker box, line and
                // notch
                "marker-box": { },
                "marker-box:hover": { },
                "marker-line": { },
                "marker-line:hover": { },
                "marker-notch": { },
                "marker-notch:hover": { },
                "text": { },
                "text:hover": { }
            }
        }]
    }]
}COPY

In the above code:

• Create a style object under timemarker object to add styling to the different elements of timemarker.
• In the style object:
  • marker is used to style the marker box, line, and notch.
  • marker:hover is used to style the marker box, line, and notch when hovered.
  • marker-box is used to style the marker box of the time marker.
  • marker-box:hover is used to style the marker box of the time marker when hovered.
  • marker-line is used to style the marker line of the time marker.
  • marker-line:hover is used to style the marker line of the time marker when hovered.
  • marker-notch is used to style the notch of the time marker.
  • marker-notch:hover is used to style the notch of the time marker when hovered.
  • text is used to style the text of the time marker.
  • text:hover is used to style the text of the time marker when hovered.