arlas-d3 / Exports / Cursor

Class: Cursor

Hierarchy

• TemporalObject

↳ Cursor

Table of contents

Constructors

• constructor

Properties

• axis
• climatological
• colors
• context
• dimensions
• element
• granularity
• hoveredBucket
• selectedDate
• verticalLine

Methods

• moveTo
• moveToDate
• onClick
• onMouseenter
• onMouseleave
• onMousemove
• plot
• remove
• round
• setAxis
• setClimatological
• setColors
• setCursorOffset
• setDimensions
• setGranularity
• setVerticalLine

Constructors

constructor

• new Cursor(context, granularity)

Parameters

Name	Type
context	Selection<SVGGElement, TimelineData, BaseType, TimelineData>
granularity	Granularity

Overrides

TemporalObject.constructor

Defined in

src/calendar-timeline/lib/classes/cursor/cursor.ts:35

Properties

axis

• Protected axis: Axis

Inherited from

TemporalObject.axis

Defined in

src/calendar-timeline/lib/classes/temporal.object.ts:26

---

climatological

• Protected climatological: boolean

Inherited from

TemporalObject.climatological

Defined in

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

---

colors

• Protected colors: DrawableObjectColors

Inherited from

TemporalObject.colors

Defined in

src/calendar-timeline/lib/classes/temporal.object.ts:29

---

context

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

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

Inherited from

TemporalObject.context

Defined in

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

---

dimensions

• Protected dimensions: Dimensions

Inherited from

TemporalObject.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

TemporalObject.element

Defined in

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

---

granularity

• Protected granularity: Granularity

Inherited from

TemporalObject.granularity

Defined in

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

---

hoveredBucket

• hoveredBucket: Subject<Bucket>

Defined in

src/calendar-timeline/lib/classes/cursor/cursor.ts:32

---

selectedDate

• selectedDate: Subject<Date>

Defined in

src/calendar-timeline/lib/classes/cursor/cursor.ts:30

---

verticalLine

• verticalLine: VerticalLine

Defined in

src/calendar-timeline/lib/classes/cursor/cursor.ts:31

Methods

moveTo

▸ moveTo(p): void

Parameters

Name	Type
p	number

Returns

void

Defined in

src/calendar-timeline/lib/classes/cursor/cursor.ts:110

---

moveToDate

▸ moveToDate(d): void

Parameters

Name	Type
d	Date

Returns

void

Defined in

src/calendar-timeline/lib/classes/cursor/cursor.ts:124

---

onClick

▸ onClick(e): void

Parameters

Name	Type
e	any

Returns

void

Inherited from

TemporalObject.onClick

Defined in

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

---

onMouseenter

▸ onMouseenter(e): void

Parameters

Name	Type
e	PointerEvent

Returns

void

Defined in

src/calendar-timeline/lib/classes/cursor/cursor.ts:130

---

onMouseleave

▸ onMouseleave(e): void

Parameters

Name	Type
e	PointerEvent

Returns

void

Defined in

src/calendar-timeline/lib/classes/cursor/cursor.ts:134

---

onMousemove

▸ onMousemove(e): void

Parameters

Name	Type
e	PointerEvent

Returns

void

Defined in

src/calendar-timeline/lib/classes/cursor/cursor.ts:139

---

plot

▸ plot(): void

Returns

void

Overrides

TemporalObject.plot

Defined in

src/calendar-timeline/lib/classes/cursor/cursor.ts:62

---

remove

▸ remove(): void

Returns

void

Inherited from

TemporalObject.remove

Defined in

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

---

round

▸ Protected round(d): Date

Parameters

Name	Type
d	Date

Returns

Date

Inherited from

TemporalObject.round

Defined in

src/calendar-timeline/lib/classes/temporal.object.ts:64

---

setAxis

▸ setAxis(axis): TemporalObject

Parameters

Name	Type
axis	Axis

Returns

TemporalObject

Inherited from

TemporalObject.setAxis

Defined in

src/calendar-timeline/lib/classes/temporal.object.ts:31

---

setClimatological

▸ setClimatological(climatological): TemporalObject

Parameters

Name	Type
climatological	boolean

Returns

TemporalObject

Inherited from

TemporalObject.setClimatological

Defined in

src/calendar-timeline/lib/classes/temporal.object.ts:42

---

setColors

▸ Protected setColors(granularity): Cursor

Parameters

Name	Type
granularity	Granularity

Returns

Cursor

Overrides

TemporalObject.setColors

Defined in

src/calendar-timeline/lib/classes/cursor/cursor.ts:149

---

setCursorOffset

▸ setCursorOffset(granularity): void

Parameters

Name	Type
granularity	Granularity

Returns

void

Defined in

src/calendar-timeline/lib/classes/cursor/cursor.ts:40

---

setDimensions

▸ setDimensions(dimensions): DrawableObject

Parameters

Name	Type
dimensions	Dimensions

Returns

DrawableObject

Inherited from

TemporalObject.setDimensions

Defined in

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

---

setGranularity

▸ setGranularity(granularity): TemporalObject

Parameters

Name	Type
granularity	Granularity

Returns

TemporalObject

Inherited from

TemporalObject.setGranularity

Defined in

src/calendar-timeline/lib/classes/temporal.object.ts:36

---

setVerticalLine

▸ setVerticalLine(verticalLine): Cursor

Parameters

Name	Type
verticalLine	VerticalLine

Returns

Cursor

Defined in

src/calendar-timeline/lib/classes/cursor/cursor.ts:144