Element: <oj-timeline-item>

Oracle® JavaScript Extension Toolkit (JET)
7.1.0

F18183-01

Signature:

class ojTimelineItem

QuickNav

Attributes


PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Version:
  • 7.1.0
Since:
  • 7.0.0
Module:
  • ojtimeline

Module usage

See JET Module Loading for an overview of module usage within JET.

Typescript Import Format
//To typecheck the element APIs, import as below.
import {ojTimelineItem} from "ojs/ojtimeline";

//For the transpiled javascript to load the element's module, import as below
import "ojs/ojtimeline";

JET In Typescript

A detailed description of working with JET elements and classes in your typescript project can be found at: JET Typescript Usage.

JET Timeline Item

The oj-timeline-item element is used to declare properties for timeline items and is only valid as the child of a template element for the itemTemplate slot of oj-timeline.


<oj-timeline data="[[dataProvider]]">
  <template slot="itemTemplate">
    <oj-timeline-item
      series-id="[[$current.data.series]]"
      start="[[$current.data.start]]"
      end="[[$current.data.end]]">
    </oj-timeline-item>
  </template>
</oj-timeline>

Attributes

description :string

The description text displayed on the timeline item. If not specified, no description will be shown.
Default Value:
  • ""

(nullable) duration-fill-color :string

The color applied to the duration bar of the timeline item. If not specified, this will be determined by the color ramp of the series.
Default Value:
  • null

end :string

The end time of this timeline item. If not specified, no duration bar will be shown. See Date and Time Formats for more details on the required string formats.
Default Value:
  • ""

label :string

The label text displayed on the timeline item. If not specified, no label will be shown.
Default Value:
  • ""

series-id :string

The id for the series the item belongs to. If no id is specified, the item will be added to the default series.

(nullable) short-desc :string

The description of the item. This is used for accessibility and for customizing the tooltip text.
Default Value:
  • null

start :string

The start time of this timeline item. This is required in order for the timeline item to properly render. See Date and Time Formats for more details on the required string formats.
Default Value:
  • ""

svg-style :CSSStyleDeclaration

The CSS style defining any additional styling of the item. If not specified, no additional styling will be applied.

thumbnail :string

An optional URI specifying the location of an image resource to be displayed on the item. The image will be rendered at 32px x 32px in size. If not specified, no thumbnail will be shown.
Default Value:
  • ""