TimelineChartProviderBase

This class provides a base API for the chart providers. Chart provider is responsible for actually drawing the canvas and the chart. It is provided with data and view details by the timeline chart feature.

Chart canvas (implemented by subclasses) will be sized according to the timeline size. Width will be equal to the time axis size and height - to the timeline subgrid height. Canvas will be scrollable in horizontal direction and will remain at the top of the timeline view on vertical scroll.

Configs

6

Common

listenersEvents

Other

Property allowing to customize the tooltip appearance.

tooltipTemplate: function

Template used to generate tooltip contents when chart point is hovered.

const gantt = new Gantt({
    features : {
        timelineChart : {
            chartProvider : {
                tooltipTemplate({ dataset, date }) {
                    return `
                        <div>${dataset.label}: ${dataset.percent}%</div>
                        <div>${DateHelper.format(date, this.gantt.displayDateFormat)}</div>
                    `;
                }
            }
        }
    }
});
ParameterTypeDescription
dataObject

Tooltip data

data.datasetObject

Object with data attributes and their values read from the hovered HTML element

data.dateDate

Currently hovered date rounded to the tick start

Returns: String

Misc

Properties

11

Class hierarchy

isTimelineChartProviderBase: Boolean= truereadonly
Identifies an object as an instance of TimelineChartProviderBase class, or subclass thereof.
isTimelineChartProviderBase: Boolean= truereadonlystatic
Identifies an object as an instance of TimelineChartProviderBase class, or subclass thereof.
isDelayableDelayable
isEventsEvents

Other

Property allowing to customize the tooltip appearance.

Lifecycle

configBase

Misc

Functions

25

Configuration

applyDefaultsstaticBase

Events

Lifecycle

destroystaticBase

Misc

initClassstaticBase
isOfTypeNamestaticBase
mixinstaticBase

Other

createOnFrameDelayable
onEvents
relayAllEvents
triggerEvents
unEvents

Events

3

Event handlers

3

Typedefs

2