Element: <oj-timeline-item>

Oracle® JavaScript Extension Toolkit (JET)
13.0.1
F52697-01

Since:
  • 7.0.0
Module:
  • ojtimeline

QuickNav

Attributes


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>


Usage

Signature:

interface TimelineItemElement<K=any, D=any>

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

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

For additional information visit:


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:
  • ""

item-type :"event"|"duration-bar"|"duration-event"|"auto"

Note: This attribute is not supported in the following themes: Alta

The item type for the bubble. If not specified, defaults to auto behavior.
  • event: item bubble using only the start date
  • duration-bar: item bubble with a bar on the time-axis that matches the duration of the event using the start/end dates
  • duration-event: item bubble with width equal to the duration and edges of the event matching the start/end date (only available on horizontal timeline)
  • auto (default behavior): event item-type if end date not specified, duration-bar if end date specified.
Supported Values:
Value
auto
duration-bar
duration-event
event
Default Value:
  • "auto"
Since:
  • 11.1.0

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 | ((context: ojTimeline.ItemShortDescContext<K,D) => string)) :(string | ((context: ojTimeline.ItemShortDescContext<K,D>) => string)) :(string | ((context: ojTimeline.ItemShortDescContext<K,D>) => 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:
  • ""

(nullable) svg-style :Partial<CSSStyleDeclaration>

The CSS style defining any additional styling of the item. If not specified, no additional styling will be applied. Only SVG CSS style properties are supported.

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:
  • ""