Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

References

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Events

Variables

Functions

References

Renames and re-exports LineUp

Type aliases

IAbortAblePromise<T>: IAbortAblePromiseImpl<T>

Type parameters

  • T

IActionColumnDesc: IColumnDesc & IActionDesc
IAggregationStrategy: "group" | "item" | "group+item" | "group+top+item" | "group+item+top"
IBooleanColumnDesc: IValueColumnDesc<boolean> & IBooleanDesc
IBooleansColumnDesc: IArrayColumnDesc<boolean>
IBuilderAdapterProps: Partial<ITaggleOptions> & IBuilderAdapterDataProps
ICategoricalColumnDesc: IValueColumnDesc<string> & ICategoricalDesc
ICategoricalMapColumnDesc: ICategoricalDesc & IMapColumnDesc<string | null>
ICategoricalsColumn: ICategoricalLikeColumn & IArrayColumn<string | null>
ICategoricalsColumnDesc: ICategoricalDesc & IArrayColumnDesc<string | null>
ICompareValue: string | number | null
ICompositeNumberColumnDesc: ICompositeNumberDesc & IColumnDesc
IDateBin: IBin<Date>
IDateColumnDesc: IValueColumnDesc<Date> & IDateDesc
IDateFilter: INumberFilter
IDateGranularity: "century" | "decade" | "year" | "month" | "week" | "day_of_week" | "day_of_month" | "day_of_year" | "hour" | "minute" | "second"
IDateHistGranularity: "year" | "month" | "day"
IDateMapColumnDesc: IDatesDesc & IMapColumnDesc<Date | null>
IDatesColumnDesc: IDatesDesc & IArrayColumnDesc<Date>
IGroupData: Readonly<IOrderedGroup>
IHierarchyColumnDesc: IHierarchyDesc & IValueColumnDesc<string>
ILinkColumnDesc: ILinkDesc & IValueColumnDesc<string | ILink>
ILinkMapColumnDesc: ILinkDesc & IMapColumnDesc<string>
ILinksColumnDesc: ILinkDesc & IArrayColumnDesc<string | ILink>
IMapColumnDesc<T>: IValueColumnDesc<IKeyValue<T>[]>

Type parameters

  • T

IMultiLevelCompositeColumnDesc: IColumnDesc & { showNestedSummaries?: boolean }
INumberBin: IBin<number>
INumberColumnDesc: INumberDesc & IValueColumnDesc<number>
INumberMapColumnDesc: INumberMapDesc & IMapColumnDesc<number>
INumbersColumnDesc: INumbersDesc & IArrayColumnDesc<number>
IOrdinalColumnDesc: ICategoricalDesc & IValueColumnDesc<number>
IRankingContext: Readonly<IRankingBodyContext>
IRankingHeaderContext: Readonly<IRankingHeaderContextContainer>
IRenderCallback: (ctx: CanvasRenderingContext2D) => void

Type declaration

    • (ctx: CanvasRenderingContext2D): void
    • Parameters

      • ctx: CanvasRenderingContext2D

      Returns void

IScriptColumnDesc: IScriptDesc
ISetColumnDesc: ISetDesc & IValueColumnDesc<string[]>
IStackColumnColumnDesc: ICompositeNumberDesc & { showNestedSummaries?: boolean }
IStringColumnDesc: IStringDesc & IValueColumnDesc<string>
IStringMapColumnDesc: IStringDesc & IMapColumnDesc<string>
IStringsColumnDesc: IStringDesc & IArrayColumnDesc<string>
IndicesArray: (ReadonlyArray<number> | UIntTypedArray) & ArrayLike<number>
UIntTypedArray: Uint8Array | Uint16Array | Uint32Array

Events

  • collapseChanged(previous: boolean, current: boolean): void
  • emitted when the collapse property changes

    asmemberof

    StackColumn

    Parameters

    • previous: boolean
    • current: boolean

    Returns void

  • collapseChanged_MC(previous: boolean, current: boolean): void
  • filterChanged_AC(previous: string | RegExp, current: string | RegExp): void
  • emitted when the filter property changes

    asmemberof

    AnnotateColumn

    Parameters

    • previous: string | RegExp
    • current: string | RegExp

    Returns void

  • filterChanged_LC(previous: string | RegExp, current: string | RegExp): void
  • emitted when the filter property changes

    asmemberof

    LinkColumn

    Parameters

    • previous: string | RegExp
    • current: string | RegExp

    Returns void

  • filterChanged_SC(previous: string | RegExp, current: string | RegExp): void
  • emitted when the filter property changes

    asmemberof

    StringColumn

    Parameters

    • previous: string | RegExp
    • current: string | RegExp

    Returns void

  • filterChanged_SEC(previous: Set<number>, current: Set<number>): void
  • emitted when the filter property changes

    asmemberof

    SelectionColumn

    Parameters

    • previous: Set<number>
    • current: Set<number>

    Returns void

  • groupingChanged_AC(previous: (string | RegExp)[][], current: (string | RegExp)[][]): void
  • emitted when the grouping property changes

    asmemberof

    AnnotateColumn

    Parameters

    • previous: (string | RegExp)[][]
    • current: (string | RegExp)[][]

    Returns void

  • groupingChanged_LC(previous: (string | RegExp)[][], current: (string | RegExp)[][]): void
  • emitted when the grouping property changes

    asmemberof

    LinkColumn

    Parameters

    • previous: (string | RegExp)[][]
    • current: (string | RegExp)[][]

    Returns void

  • groupingChanged_NC(previous: number[], current: number[]): void
  • emitted when the grouping property changes

    asmemberof

    NumberColumn

    Parameters

    • previous: number[]
    • current: number[]

    Returns void

  • groupingChanged_SC(previous: (string | RegExp)[][], current: (string | RegExp)[][]): void
  • emitted when the grouping property changes

    asmemberof

    StringColumn

    Parameters

    • previous: (string | RegExp)[][]
    • current: (string | RegExp)[][]

    Returns void

  • highlightChanged(dataIndex: number): void
  • emitted when the highlight changes

    asmemberof

    EngineRanking

    Parameters

    • dataIndex: number

      the highlighted data index or -1 for none

    Returns void

  • mappingChanged_OC(previous: number[], current: number[]): void
  • emitted when the mapping property changes

    asmemberof

    OrdinalColumn

    Parameters

    • previous: number[]
    • current: number[]

    Returns void

  • nestedChildRatio(previous: number[], current: number[]): void
  • emitted when the ratios between the children changes

    asmemberof

    StackColumn

    Parameters

    • previous: number[]
    • current: number[]

    Returns void

  • nestedChildRatio_MC(previous: number, current: number): void
  • patternChanged_LC(previous: string, current: string): void
  • emitted when the pattern property changes

    asmemberof

    LinkColumn

    Parameters

    • previous: string
    • current: string

    Returns void

  • patternChanged_LCS(previous: string, current: string): void
  • emitted when the pattern property changes

    asmemberof

    LinksColumn

    Parameters

    • previous: string
    • current: string

    Returns void

  • patternChanged_LMC(previous: string, current: string): void
  • emitted when the pattern property changes

    asmemberof

    LinkMapColumn

    Parameters

    • previous: string
    • current: string

    Returns void

  • recreate(): void
  • scriptChanged(previous: string, current: string): void
  • emitted when the script property changes

    asmemberof

    ScriptColumn

    Parameters

    • previous: string
    • current: string

    Returns void

  • select(item: any): void
  • select_SEC(dataIndex: number, value: boolean, dataIndices?: IndicesArray): void
  • emitted when rows are selected

    asmemberof

    SelectionColumn

    Parameters

    • dataIndex: number

      the (de)selected row

    • value: boolean

      true if selected else false

    • Optional dataIndices: IndicesArray

      in case of multiple rows are selected

    Returns void

  • updateData(): void
  • emitted when the data of the ranking needs to be updated

    asmemberof

    EngineRanking

    Returns void

  • valueChanged(dataIndex: number, previous: string, current: string): void
  • emitted when the value of a row changes

    asmemberof

    AnnotateColumn

    Parameters

    • dataIndex: number
    • previous: string
    • current: string

    Returns void

  • weightsChanged(previous: number[], current: number[]): void
  • emitted when the weights change

    asmemberof

    StackColumn

    Parameters

    • previous: number[]
    • current: number[]

    Returns void

  • widthChanged(): void

Variables

DEFAULT_CATEGORICAL_COLOR_FUNCTION: ICategoricalColorMappingFunction = ...
DEFAULT_COLOR: "#C1C1C1" = '#C1C1C1'

default color that should be used

DEFAULT_COLOR_FUNCTION: SolidColorFunction = ...
FIRST_IS_MISSING: 1 = 1
FIRST_IS_NAN: -1 = -1
SCHEMA_REF: "https://lineup.js.org/develop/schema.4.0.0.json" = ...
categories: Categories = ...
defaultGroup: IGroup = ...
missingGroup: IGroup = ...
othersGroup: IGroup = ...

Functions

  • Category(cat: keyof Categories): { (target: Function): void; (target: Object, propertyKey: string | symbol): void }
  • Parameters

    Returns { (target: Function): void; (target: Object, propertyKey: string | symbol): void }

      • (target: Function): void
      • (target: Object, propertyKey: string | symbol): void
      • Parameters

        • target: Function

        Returns void

      • Parameters

        • target: Object
        • propertyKey: string | symbol

        Returns void

  • SortByDefault(order?: "ascending" | "descending"): { (target: Function): void; (target: Object, propertyKey: string | symbol): void }
  • Parameters

    • order: "ascending" | "descending" = 'ascending'

    Returns { (target: Function): void; (target: Object, propertyKey: string | symbol): void }

      • (target: Function): void
      • (target: Object, propertyKey: string | symbol): void
      • Parameters

        • target: Function

        Returns void

      • Parameters

        • target: Object
        • propertyKey: string | symbol

        Returns void

  • SupportType(): { (target: Function): void; (target: Object, propertyKey: string | symbol): void }
  • Returns { (target: Function): void; (target: Object, propertyKey: string | symbol): void }

      • (target: Function): void
      • (target: Object, propertyKey: string | symbol): void
      • Parameters

        • target: Function

        Returns void

      • Parameters

        • target: Object
        • propertyKey: string | symbol

        Returns void

  • asLineUp(node: HTMLElement, data: any[], ...columns: string[]): LineUp
  • build a new LineUp instance in the given node for the given data

    Parameters

    • node: HTMLElement

      DOM node to attach to

    • data: any[]

      data to visualize

    • Rest ...columns: string[]

      optional enforced column order

    Returns LineUp

  • asTaggle(node: HTMLElement, data: any[], ...columns: string[]): Taggle
  • build a new Taggle instance in the given node for the given data

    Parameters

    • node: HTMLElement

      DOM node to attach to

    • data: any[]

      data to visualize

    • Rest ...columns: string[]

      optional enforced column order

    Returns Taggle

  • buildActionsColumn(): default
  • buildBooleanColumn(column: string): default
  • buildCategoricalColumn(column: string, categories?: (string | Partial<ICategory>)[]): default
  • buildDateColumn(column: string): default
  • buildNumberColumn(column: string, domain?: [number, number]): default
  • builds numerical column builder

    Parameters

    • column: string

      column which contains the associated data

    • Optional domain: [number, number]

      domain (min, max) of this column

    Returns default

  • buildStringColumn(column: string): default
  • createActionDesc(label?: string, actions?: Readonly<IAction>[], groupActions?: Readonly<IGroupAction>[]): { actions: Readonly<IAction>[]; fixed: boolean; groupActions: Readonly<IGroupAction>[]; label: string; type: string }
  • utility for creating an action description with optional label

    Parameters

    • label: string = 'actions'
    • actions: Readonly<IAction>[] = []
    • groupActions: Readonly<IGroupAction>[] = []

    Returns { actions: Readonly<IAction>[]; fixed: boolean; groupActions: Readonly<IGroupAction>[]; label: string; type: string }

    • actions: Readonly<IAction>[]
    • fixed: boolean
    • groupActions: Readonly<IGroupAction>[]
    • label: string
    • type: string
  • createAggregateDesc(label?: string): { fixed: boolean; label: string; type: string }
  • factory for creating a description creating a rank column

    Parameters

    • label: string = 'Aggregate Groups'

    Returns { fixed: boolean; label: string; type: string }

    • fixed: boolean
    • label: string
    • type: string
  • createGroupDesc(label?: string): { label: string; type: string }
  • Parameters

    • label: string = 'Group Name'

    Returns { label: string; type: string }

    • label: string
    • type: string
  • createImpositionBoxPlotDesc(label?: string): { label: string; type: string }
  • factory for creating a description creating a max column

    Parameters

    • label: string = 'Imposition'

    Returns { label: string; type: string }

    • label: string
    • type: string
  • createImpositionDesc(label?: string): { label: string; type: string }
  • factory for creating a description creating a max column

    Parameters

    • label: string = 'Imposition'

    Returns { label: string; type: string }

    • label: string
    • type: string
  • createImpositionsDesc(label?: string): { label: string; type: string }
  • factory for creating a description creating a max column

    Parameters

    • label: string = 'Imposition'

    Returns { label: string; type: string }

    • label: string
    • type: string
  • Parameters

    • container: HTMLElement

      the html element lineup should be built in

    • data: DataProvider

      the data provider

    • config: Partial<ILineUpOptions> = {}

      lineup configuration overrides

    Returns LineUp

    the created lineup instance

  • createRankDesc(label?: string): { label: string; type: string }
  • factory for creating a description creating a rank column

    Parameters

    • label: string = 'Rank'

    Returns { label: string; type: string }

    • label: string
    • type: string
  • createReduceDesc(label?: string): { label: string; type: string }
  • factory for creating a description creating a max column

    Parameters

    • label: string = 'Reduce'

    Returns { label: string; type: string }

    • label: string
    • type: string
  • createScriptDesc(label?: string): { label: string; script: string; type: string }
  • factory for creating a description creating a mean column

    Parameters

    • label: string = 'script'

    Returns { label: string; script: string; type: string }

    • label: string
    • script: string
    • type: string
  • createSelectionDesc(label?: string): { fixed: boolean; label: string; type: string }
  • factory for creating a description creating a rank column

    Parameters

    • label: string = 'Selections'

    Returns { fixed: boolean; label: string; type: string }

    • fixed: boolean
    • label: string
    • type: string
  • defineColumn<T>(name: string, functions?: any): typeof Column
  • dialogAddons(key: string, ...keys: string[]): { (target: Function): void; (target: Object, propertyKey: string | symbol): void }
  • Parameters

    • key: string
    • Rest ...keys: string[]

    Returns { (target: Function): void; (target: Object, propertyKey: string | symbol): void }

      • (target: Function): void
      • (target: Object, propertyKey: string | symbol): void
      • Parameters

        • target: Function

        Returns void

      • Parameters

        • target: Object
        • propertyKey: string | symbol

        Returns void

  • getSortType(col: Column): "abc" | "num" | undefined
  • isHierarchical(categories: (string | Partial<ICategory>)[]): boolean
  • isMissingValue(v: any): boolean
  • isSortingAscByDefault(col: Column): boolean
  • isSupportType(col: Column): boolean
  • isUnknown(v?: number): boolean
  • renderMissingCanvas(ctx: CanvasRenderingContext2D, col: Column, d: IDataRow, width: number, x?: number, y?: number): boolean
  • renderMissingDOM(node: HTMLElement, col: Column, d: IDataRow): boolean
  • spaceFillingRule(config: { groupHeight: number; groupPadding: number; rowHeight: number }): IRule
  • Parameters

    • config: { groupHeight: number; groupPadding: number; rowHeight: number }
      • groupHeight: number
      • groupPadding: number
      • rowHeight: number

    Returns IRule

  • toCategories(desc: Pick<ICategoricalDesc, "categories">): { color: string; label: string; name: string; value: number }[]
  • toolbar(...keys: string[]): { (target: Function): void; (target: Object, propertyKey: string | symbol): void }
  • Parameters

    • Rest ...keys: string[]

    Returns { (target: Function): void; (target: Object, propertyKey: string | symbol): void }

      • (target: Function): void
      • (target: Object, propertyKey: string | symbol): void
      • Parameters

        • target: Function

        Returns void

      • Parameters

        • target: Object
        • propertyKey: string | symbol

        Returns void

  • updateLodRules(style: default, overviewMode: boolean, options: Readonly<ITaggleOptions>): void