arlas-d3 / Exports / Timeline

Class: Timeline

Hierarchy

• DrawableObject

↳ Timeline

Table of contents

Constructors

• constructor

Properties

• boundDates
• context
• dimensions
• element
• hoveredData
• selectedData

Methods

• moveCursor
• onClick
• onMouseenter
• onMouseleave
• onMousemove
• plot
• remove
• setBoundDates
• setClimatological
• setData
• setDimensions
• setGranularity
• dateToString

Constructors

constructor

• new Timeline(svg)

Parameters

Name	Type
svg	any

Overrides

DrawableObject.constructor

Defined in

src/calendar-timeline/timeline.ts:56

Properties

boundDates

• boundDates: Date[]

Defined in

src/calendar-timeline/timeline.ts:45

---

context

• Protected context: Selection<SVGGElement, TimelineData, BaseType, TimelineData>

the context is the parent element to which the current element is appended

Inherited from

DrawableObject.context

Defined in

src/calendar-timeline/lib/classes/drawable.object.ts:27

---

dimensions

• Protected dimensions: Dimensions

Inherited from

DrawableObject.dimensions

Defined in

src/calendar-timeline/lib/classes/drawable.object.ts:28

---

element

• Protected element: Selection<SVGGElement, TimelineData, BaseType, TimelineData>

the element contains the drawing of this current object

Inherited from

DrawableObject.element

Defined in

src/calendar-timeline/lib/classes/drawable.object.ts:25

---

hoveredData

• hoveredData: Subject<TimelineTooltip>

Defined in

src/calendar-timeline/timeline.ts:53

---

selectedData

• selectedData: Subject<TimelineData>

Defined in

src/calendar-timeline/timeline.ts:54

Methods

moveCursor

▸ moveCursor(d): void

Parameters

Name	Type
d	Date

Returns

void

Defined in

src/calendar-timeline/timeline.ts:121

---

onClick

▸ onClick(e): void

Parameters

Name	Type
e	PointerEvent

Returns

void

Overrides

DrawableObject.onClick

Defined in

src/calendar-timeline/timeline.ts:153

---

onMouseenter

▸ onMouseenter(e): void

Parameters

Name	Type
e	PointerEvent

Returns

void

Defined in

src/calendar-timeline/timeline.ts:160

---

onMouseleave

▸ onMouseleave(e): void

Parameters

Name	Type
e	PointerEvent

Returns

void

Defined in

src/calendar-timeline/timeline.ts:163

---

onMousemove

▸ onMousemove(e): void

Parameters

Name	Type
e	PointerEvent

Returns

void

Defined in

src/calendar-timeline/timeline.ts:174

---

plot

▸ plot(emitSelectedData?): void

Parameters

Name	Type	Default value
emitSelectedData	boolean	false

Returns

void

Overrides

DrawableObject.plot

Defined in

src/calendar-timeline/timeline.ts:126

---

remove

▸ remove(): void

Returns

void

Inherited from

DrawableObject.remove

Defined in

src/calendar-timeline/lib/classes/drawable.object.ts:45

---

setBoundDates

▸ setBoundDates(dates): Timeline

Parameters

Name	Type
dates	Date[]

Returns

Timeline

Defined in

src/calendar-timeline/timeline.ts:106

---

setClimatological

▸ setClimatological(climatological): Timeline

Parameters

Name	Type
climatological	boolean

Returns

Timeline

Defined in

src/calendar-timeline/timeline.ts:111

---

setData

▸ setData(data): Timeline

Parameters

Name	Type
data	any

Returns

Timeline

Defined in

src/calendar-timeline/timeline.ts:116

---

setDimensions

▸ setDimensions(dimensions): DrawableObject

Parameters

Name	Type
dimensions	Dimensions

Returns

DrawableObject

Inherited from

DrawableObject.setDimensions

Defined in

src/calendar-timeline/lib/classes/drawable.object.ts:52

---

setGranularity

▸ setGranularity(granularity): Timeline

Parameters

Name	Type
granularity	Granularity

Returns

Timeline

Defined in

src/calendar-timeline/timeline.ts:100

---

dateToString

▸ Static dateToString(d, granularity, climatological?): string

Parameters

Name	Type
d	Date
granularity	Granularity
climatological?	boolean

Returns

string

Defined in

src/calendar-timeline/timeline.ts:178