1.0.0Type: Object
Type: Object
(string)
(string)
: The text to be displayed in the Timeline item.
(string)
: The group layer name.
((string | Date)?)
: A valid date. Required if
type
will be
range
. Otherwise, not required nor used for
type
of
box
or `point.
(string?)
: The timeline item type to be displayed. See
https://visjs.github.io/vis-timeline/docs/timeline/#items
.
Stores references to FeatureGroup layers that are used to manage and store markers into logical groups.
Note that these FeatureGroup layers are used as the overlay layers in the Leaflet map.
Type: L.Control
Type: boolean
(L.Map)
An instance of a Leaflet map
(HTMLElement)
(Object?
= {})
Creates a leaflet control (if it does not exist) for handling the toggling of marker and timeline item groups.
Register a callback function on map marker click event.
(function (x: MouseEvent): any)
Function that will be
provided a click event object when some map marker is clicked.
Register a callback function on timeline item click event.
(function (x: MouseEvent): any)
Function that will be
provided click event details of some timeline item.
(string)
(string)
A method intended to be used by api consumers to manually pan the map and the timeline to a common data item.
(string)
An identifier used to group and organize similar
markers and Timeline items.
(function (x: Object): CreatedMarkerPropertiesType)
A callback function that takes an object from
dataset
and returns
another object of with the expected type.
(function (x: Object): CreatedTimelineItemType)
A callback function that takes an item of
dataset
and returns the
expected object type.
Note that it is the user's responsibility to provide values for start
and end that comply with the type of Timeline item.
For example, box and point only require the start date whereas
both the start and end properties are required for timeline items of
type range.
(Function?)
A callback function that will be
provided the current datum of
dataset
and is expected to return an
html string.
void:
(Object)
The data object used to create the marker and
the timeline item.
(string)
An identifier used to group and organize similar
markers and Timeline items.
(function (x: Object): CreatedMarkerPropertiesType)
A callback function that takes an object from
dataset
and returns
another object of with the expected type.
(function (x: Object): CreatedTimelineItemType)
A callback function that takes an item of
dataset
and returns the
expected object type.
Note that it is the user's responsibility to provide values for start
and end that comply with the type of Timeline item.
For example, box and point only require the start date whereas
both the start and end properties are required for timeline items of
type range.
(Function?)
A callback function that will be
provided the current datum of
dataset
and is expected to return an
html string.
void:
The user must handle the creation of the leaflet marker on their own. The intended use case is for users that want to use an external leaflet marker library or otherwise want to fully control how the marker is created.
(string)
An identifier used to group and organize similar
markers and Timeline items.
(function (x: Object): L.marker)
A callback function
that takes an object from
dataset
and returns a leaflet marker.
(function (x: Object): CreatedTimelineItemType)
A callback function that takes an item of
dataset
and returns the
expected object type.
Note that it is the user's responsibility to provide values for start
and end that comply with the type of Timeline item.
For example, box and point only require the start date whereas
both the start and end properties are required for timeline items of
type range.
void:
(Object)
(string)
(function (x: Object): L.marker)
A callback function
that takes an object and returns a leaflet marker.
(function (x: Object): CreatedTimelineItemType)
A callback function that takes an object and returns the expected type.
Fits map viewport to show all markers from all layers.
Clears all existing Leaflet LayerGroups including their markers as well as removing the LayerGroup from the Layer Control and the Leaflet Map instance.
Determines whether or not a marker exists within the grouping layers.
(string)
boolean:
Determines whether or not an item exists in the Timeline.
(string)
boolean:
(string)
Removes an entire group at once.
(string)
Cleans up the Leaflet and Timeline instances as well as the associated event listeners.
(any)