Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ILineUpOptions

Hierarchy

Index

Properties

animated: boolean

option to enable/disable animated transitions

default

true

copyableRows: boolean

option to enable to copy selected rows using ctrl-c

default

false

defaultSlopeGraphMode: "item" | "band"

option to specify the default slope graph mode

default

'item'

expandLineOnHover: boolean

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

default

false

flags: Partial<ILineUpFlags>

custom flags for optimization

groupHeight: number

height of an aggregated group in pixel

default

40

groupPadding: number

padding between two groups in pixel

default

5

hierarchyIndicator: boolean

show the sorting and grouping hierarchy indicators in the side panel

default

true

ignoreUnsupportedBrowser: boolean

ignore incompatible browser and always show (on own risk)

default

false

instanceId: string

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

default

random string

labelRotation: number

how many degrees should a label be rotated in case of narrow columns

default

0 no rotation

livePreviews: Partial<ILivePreviewOptions>

flag whether to shows filter previews as soon as the user changes the filter in the dialog

default

{search: true,filter: true, vis: true,sort: true, group: true, groupSort: true, colorMapping: true}

onDialogBackgroundClick: "cancel" | "confirm"

flag whether dialogs should confirm or cancel on clicking the background

default

cancel

renderers: {}

register custom renderer factories

Type declaration

rowHeight: number

height of a row

default

18

rowPadding: number

padding between two rows

default

2

sidePanel: boolean

option to enable/disable the panel

default

true

sidePanelCollapsed: boolean

option to specify whether the panel should be collapsed by default

default

false

summaryHeader: boolean

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

default

true

register custom toolbar actions and dialog addons

toolbarDialogAddons: IToolbarLookup<IToolbarDialogAddon>

Methods

  • customRowUpdate(row: HTMLElement, rowIndex: number): void
  • custom function to be called when updating a HTML row

    Parameters

    • row: HTMLElement

      node element to be updated

    • rowIndex: number

      row index to be rendered in the row

    Returns void

  • levelOfDetail(rowIndex: number): "high" | "low"
  • custom function to compute the level of detail for a row

    Parameters

    • rowIndex: number

      the current row index to be rendered

    Returns "high" | "low"