NUKnightLab / NUKnightLab/TimelineJS3

Control timeline display period and auto-scroll to today

Open
#845 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
3.2k
Forks
645
PR merge metrics
No merged PRs in 30d

Description

Hello,

I am using Javascript to instantiate a Timeline3 object and populate it with my own JSON. This working fine.

I have reviewed the API documentation and cannot find a way to:

(a) precisely control the time period displayed initially (e.g. I want to be able to say "Show me all events between 1/1/2023 and 31/12/2024")

(b) alternatively, specify to show a 24 month forward looking period, automatically starting from today

(c) I'd also love to be able to show over-lapping Eras. Default behaviour seems to be for the later Era to overwrite any earlier Eras when there is a time overlap.

Any assistance with this would be much appreciated!

Kind regards,
James

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Timeline3 initialization API and the existing API documentation, then trace how the supplied JSON events and eras determine the initial view. Define and document support for an explicit date range or a forward-looking period from today, and clarify the expected behavior for overlapping eras. Done means these display options work with user-provided JSON and overlapping eras no longer unexpectedly replace one another.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.