TimelineGroupingOptions

Interface

projects/common/timeline/grouping.ts

Info
API

Import#

import { TimelineGroupingOptions } from '@cngx/common/timeline'

Description#

Inputs to createTimelineGrouping. Every reactive knob is a zero-arg accessor, so a Signal (or an input()) can be passed directly and a constant is just () => 'day'.

Index#

Properties

dateAccessor direction groupBy items

Instance Properties#

dateAccessor#TimelineDateAccessor

Readonly

Timestamp accessor. Not a signal itself, but it is called inside the groups computation, so a caller that closes over one - as the organism does over its [dateAccessor] input - has those reads tracked like any other and re-groups when the accessor is rebound.

direction#function

ReadonlyOptional

Sort direction. Defaults to 'desc'.

groupBy#function

ReadonlyOptional

Bucketing mode. Defaults to 'day'.

items#function

Readonly

Source list. Read inside the groups computation, so it is tracked.