Class DataBuilder

builder for a LocalDataProvider along with LineUp configuration options

Hierarchy

  • default
    • DataBuilder

Constructors

Properties

options: Partial<ITaggleOptions> = ...

Methods

  • builds LineUp at the given parent DOM node

    Returns

    Parameters

    • node: HTMLElement

      parent DOM node to attach

    Returns LineUp

  • builds Taggle at the given parent DOM node

    Returns

    Parameters

    • node: HTMLElement

      parent DOM node to attach

    Returns Taggle

  • add the default ranking (all columns) to this data provider

    Parameters

    • addSupportTypes: boolean = true

      add support types, too, default: true

    Returns DataBuilder

  • option to specify the default slope graph mode

    Default

    'item'

    Parameters

    • mode: "item" | "band"

    Returns DataBuilder

  • triggers to derive the column descriptions for the given data

    Parameters

    • Rest ...columns: (string | string[])[]

      optional enforced order of columns

    Returns DataBuilder

  • option to enforce that the whole row is shown upon hover without overflow hidden

    Default

    false

    Parameters

    • enable: boolean

    Returns DataBuilder

  • height and padding of an aggregated group in pixel

    Default

    40 and 5

    Parameters

    • groupHeight: number
    • groupPadding: number = 5

    Returns DataBuilder

  • show the sorting and grouping hierarchy indicator in the side panel

    Parameters

    • enable: boolean

      enable flag

    Returns DataBuilder

  • identifier for this LineUp instance. by default a random id is generated.

    Default

    random string

    Parameters

    • instanceId: string

    Returns DataBuilder

  • option to rotate labels on demand in narrow columns

    Default

    0 - disabled

    Parameters

    • rotation: number

      rotation in degrees

    Returns DataBuilder

  • height and padding of a row

    Default

    18 and 2

    Parameters

    • rowHeight: number
    • rowPadding: number = 2

    Returns DataBuilder

  • option to enable/disable the side panel

    Parameters

    • enable: boolean

      enable flag

    • collapsed: boolean = false

      whether collapsed by default

    Returns DataBuilder

  • option to enable/disable showing a summary (histogram, ...) in the header

    Default

    true

    Parameters

    • enable: boolean

    Returns DataBuilder