Options
All
  • Public
  • Public/Protected
  • All
Menu

@lineup-lite/components

Index

References

Interfaces

Type Aliases

Variables

Functions

References

NumberColorProps

Renames and re-exports NumberBarProps

NumberSymbolProps

Renames and re-exports NumberBarProps

Type Aliases

ArrayAxisProps

ArrayAxisProps: DateAxisProps | NumberAxisProps | TextAxisProps

BoxPlotScaled

BoxPlotScaled: Omit<IBoxPlot, "items"> & { color: any; format: any; scale: any }

CategoricalSetValue

CategoricalSetValue: readonly string[] | Set<string>

CategoricalValueLike

CategoricalValueLike: string | null | undefined | readonly (string | null | undefined)[] | Set<string>

DateFormatter

DateFormatter: ((v: Date) => string) | { locales?: string | string[]; options?: Intl.DateTimeFormatOptions }

DateHistGranularity

DateHistGranularity: "year" | "month" | "day" | "decade"

on which granularity level is the histogram computed

DateLike

DateLike: Date | null | undefined | readonly (Date | null | undefined)[] | Set<Date>

FilterRangeBoxPlotProps

FilterRangeBoxPlotProps: BoxPlotProps & FilterRangeSliderProps<number> & { i18n?: FilterRangeSliderProps<number>["i18n"] & BoxPlotProps["i18n"] }

FilterRangeHistogramProps

FilterRangeHistogramProps<T>: HistogramProps<T> & FilterRangeSliderProps<T>

Type Parameters

  • T

NumberFormatter

NumberFormatter: ((v: number) => string) | { locales?: string | string[]; options?: Intl.NumberFormatOptions }

NumberLike

NumberLike: number | null | undefined | readonly (number | null | undefined)[] | Set<number> | Float32Array | Float64Array

Variables

Const BOXPLOT_I18N_EN

BOXPLOT_I18N_EN: { boxplot25Quantile: string; boxplot75Quantile: string; boxplotMaximum: string; boxplotMean: string; boxplotMedian: string; boxplotMinimum: string; boxplotNrItems: string } = ...

Type declaration

  • boxplot25Quantile: string
  • boxplot75Quantile: string
  • boxplotMaximum: string
  • boxplotMean: string
  • boxplotMedian: string
  • boxplotMinimum: string
  • boxplotNrItems: string

Const FILTER_BIN_I18N_EN

FILTER_BIN_I18N_EN: { filterBin: string; removeFilterBin: string } = ...

Type declaration

  • filterBin: string
  • removeFilterBin: string

Const FILTER_RANGE_I18N_EN

FILTER_RANGE_I18N_EN: { filterRangeMaxFilter: string; filterRangeMinFilter: string } = ...

Type declaration

  • filterRangeMaxFilter: string
  • filterRangeMinFilter: string

Const FILTER_SET_I18N_EN

FILTER_SET_I18N_EN: { filterMaybeSet: string; filterMustNotSet: string; filterMustSet: string } = ...

Type declaration

  • filterMaybeSet: string
  • filterMustNotSet: string
  • filterMustSet: string

Const TEXT_SUMMARY_I18N_EN

TEXT_SUMMARY_I18N_EN: { filterTextPlaceholder: string; textSummaryItems: string; textSummaryUniqueItems: string } = ...

Type declaration

  • filterTextPlaceholder: string
  • textSummaryItems: string
  • textSummaryUniqueItems: string

Const UPSET_LINE_I18N_EN

UPSET_LINE_I18N_EN: { upsetHas: string; upsetHasAll: string; upsetHasNone: string; upsetHasNot: string; upsetHasSome: string } = ...

Type declaration

  • upsetHas: string
  • upsetHasAll: string
  • upsetHasNone: string
  • upsetHasNot: string
  • upsetHasSome: string

Const schemeTableau10

schemeTableau10: string[] = ...

Functions

ALWAYS_TRUE

  • ALWAYS_TRUE(): boolean

ArrayAxis

  • renders a summary axis

    Parameters

    Returns JSX.Element

BoxPlot

  • renders a boxplot

    Parameters

    Returns JSX.Element

BoxPlotArray

  • Parameters

    Returns JSX.Element

BoxPlotChart

  • renders a boxplot as a SVG chart

    Parameters

    Returns JSX.Element

BoxPlotChartVertical

  • renders a boxplot as a SVG chart

    Parameters

    Returns JSX.Element

CategoricalColor

  • Parameters

    Returns JSX.Element

DateLabel

  • renders a date

    Parameters

    Returns JSX.Element

DivergingNumberBar

  • renders a numeric value along with a diverging bar

    Parameters

    Returns JSX.Element

FilterBinHistogram

  • Type Parameters

    • T

    Parameters

    Returns JSX.Element

FilterRangeBoxPlot

  • renders a boxplot along with a range filter

    Parameters

    Returns JSX.Element

FilterRangeHistogram

  • renders a histogram along with a range filter

    Type Parameters

    • T

    Parameters

    Returns JSX.Element

FilterRangeWrapper

  • Type Parameters

    • T

    Parameters

    Returns JSX.Element

FilterSetHistogram

  • Type Parameters

    • T

    Parameters

    Returns JSX.Element

FilterTextSummary

  • Parameters

    Returns JSX.Element

HeatMap1D

  • renders a numeric 1d heatmap

    Parameters

    Returns JSX.Element

Histogram

  • renders a number or date histogram

    Type Parameters

    • T

    Parameters

    Returns JSX.Element

LineChart

  • renders a line chart

    Parameters

    Returns JSX.Element

MultiLineChart

  • renders multiple line charts

    Parameters

    Returns JSX.Element

NumberBar

  • renders a numeric value along with a bar

    Parameters

    Returns JSX.Element

NumberColor

  • renders a numeric value along with a colored rect

    Parameters

    Returns JSX.Element

NumberSymbol

  • renders a numeric value along with a circle whose area is proportional to the value

    Parameters

    Returns JSX.Element

StackedBar

  • renders a numeric value along with a bar

    Parameters

    Returns JSX.Element

TextLabel

  • renders a date

    Parameters

    Returns JSX.Element

TextSummary

  • Parameters

    Returns JSX.Element

UpSetLine

  • Parameters

    Returns JSX.Element

UpSetPartialLine

  • Parameters

    Returns JSX.Element

asStackedValue

  • asStackedValue(value: number, stack: readonly { color: string; ratio: number }[]): StackedValue

  • wraps the given information as a StackedValue

    Parameters

    • value: number

      the value of the stacked bar

    • stack: readonly { color: string; ratio: number }[]

      the ratios and colors of the stacked bar

    Returns StackedValue

autoAssignColors

  • autoAssignColors(colors: readonly string[], start?: number): ((v: string) => string)

  • helper function to assign categorical values to colors

    Parameters

    • colors: readonly string[]

      color array to assign

    • start: number = 0

      offset in the array to start

    Returns ((v: string) => string)

      • (v: string): string

      • helper function to assign categorical values to colors

        Parameters

        • v: string

        Returns string

categoricalSetDegree

  • Parameters

    Returns number

categoricalStatsGenerator

clsx

  • clsx(...args: (undefined | null | string | boolean)[]): string

  • Parameters

    • Rest ...args: (undefined | null | string | boolean)[]

    Returns string

computeWeightedSum

  • computeWeightedSum(stack: readonly number[]): StackedValue
  • computeWeightedSum(stack: readonly number[], colors: readonly string[]): StackedValue
  • computeWeightedSum(stack: readonly { color?: string; value: number; weight?: number }[], colors?: readonly string[]): StackedValue

  • computes the StackedValue of the given parameters

    Parameters

    • stack: readonly number[]

      the stack to compute the value

    Returns StackedValue

  • Parameters

    • stack: readonly number[]
    • colors: readonly string[]

    Returns StackedValue

  • Parameters

    • stack: readonly { color?: string; value: number; weight?: number }[]
    • Optional colors: readonly string[]

    Returns StackedValue

computeWeightedSumFactory

  • computeWeightedSumFactory(weights: readonly number[]): ((vs: readonly number[]) => StackedValue)
  • computeWeightedSumFactory(weights: readonly number[]): ((vs: readonly number[]) => StackedValue)
  • computeWeightedSumFactory(weights: readonly number[], colors: readonly string[]): ((vs: readonly number[]) => StackedValue)
  • computeWeightedSumFactory(stack: readonly { color?: string; weight: number }[]): ((vs: readonly number[]) => StackedValue)

  • returns a compute function for StackedValues

    Parameters

    • weights: readonly number[]

      the stack to compute the value

    Returns ((vs: readonly number[]) => StackedValue)

      • returns a compute function for StackedValues

        Parameters

        • vs: readonly number[]

        Returns StackedValue

  • Parameters

    • weights: readonly number[]

    Returns ((vs: readonly number[]) => StackedValue)

  • Parameters

    • weights: readonly number[]
    • colors: readonly string[]

    Returns ((vs: readonly number[]) => StackedValue)

  • Parameters

    • stack: readonly { color?: string; weight: number }[]

    Returns ((vs: readonly number[]) => StackedValue)

dateStatsGenerator

deNormalize

  • deNormalize(min: number, max: number): ((v: number) => number)

  • helper function to invert the normalization to a given min/max range

    Parameters

    • min: number
    • max: number

    Returns ((v: number) => number)

      • (v: number): number

      • helper function to invert the normalization to a given min/max range

        Parameters

        • v: number

        Returns number

defaultCategoricalColorScale

  • defaultCategoricalColorScale(): ((v: string) => string)

  • default

    Returns ((v: string) => string)

      • (v: string): string

      • default

        Parameters

        • v: string

        Returns string

defaultColorScale

  • defaultColorScale(v: number): string

  • default numeric color scale converting a number between 0..1 to a color

    Parameters

    • v: number

    Returns string

defaultColorScale2

  • defaultColorScale2(v: number): string

  • Parameters

    • v: number

    Returns string

defaultConstantColorScale

  • defaultConstantColorScale(): string

  • a color scale returning a constant value

    Returns string

defaultConstantDarkColorScale

  • defaultConstantDarkColorScale(): string

  • a color scale returning a constant value

    Returns string

defaultDarkColorScale

  • defaultDarkColorScale(v: number): string

  • default numeric color scale converting a number between 0..1 to a color for dark themes

    Parameters

    • v: number

    Returns string

defaultDarkColorScale2

  • defaultDarkColorScale2(v: number): string

  • Parameters

    • v: number

    Returns string

defaultDivergingColorScale

  • defaultDivergingColorScale(v: number): string

  • default diverging numeric color scale converting a number between 0..1 to a color where 0.5 is the center

    Parameters

    • v: number

    Returns string

defaultDivergingDarkColorScale

  • defaultDivergingDarkColorScale(v: number): string

  • Parameters

    • v: number

    Returns string

defaultScale

  • defaultScale(v: number): number

filterByCategoricalFilter

  • filterByCategoricalFilter(filterValue?: null | readonly string[]): ((value?: string | null) => boolean)

  • filter function by a set of filter values

    Parameters

    • Optional filterValue: null | readonly string[]

    Returns ((value?: string | null) => boolean)

      • (value?: string | null): boolean

      • filter function by a set of filter values

        Parameters

        • Optional value: string | null

        Returns boolean

filterByCategoricalSetFilter

  • filterByCategoricalSetFilter(filterValue?: null | readonly FilterSetValue<string>[]): ((value?: readonly string[] | ReadonlySet<string> | null) => boolean)

  • filter function by a set of filter values

    Parameters

    Returns ((value?: readonly string[] | ReadonlySet<string> | null) => boolean)

      • (value?: readonly string[] | ReadonlySet<string> | null): boolean

      • filter function by a set of filter values

        Parameters

        • Optional value: readonly string[] | ReadonlySet<string> | null

        Returns boolean

filterByRangeFilter

  • filterByRangeFilter<T>(filterValue?: null | readonly [T, T]): ((v?: T | null) => boolean)

  • a range numeric filter

    Type Parameters

    • T

    Parameters

    • Optional filterValue: null | readonly [T, T]

    Returns ((v?: T | null) => boolean)

      • (v?: T | null): boolean

      • a range numeric filter

        Parameters

        • Optional v: T | null

        Returns boolean

format

  • format<T>(value: T, formatter?: string | ((v: T) => string)): string

  • Type Parameters

    • T

    Parameters

    • value: T
    • Optional formatter: string | ((v: T) => string)

    Returns string

formatCategories

  • formatCategories(...categoryLabel: [string, string][]): ((v: string) => string)

  • helper function to create a formatter between a category value and a category label

    Parameters

    • Rest ...categoryLabel: [string, string][]

      tuple list of [category, label] to map

    Returns ((v: string) => string)

      • (v: string): string

      • helper function to create a formatter between a category value and a category label

        Parameters

        • v: string

        Returns string

getNumberOfBins

  • getNumberOfBins(length: number): number

  • computes the optimal number of bins for a given array length

    Parameters

    • length: number

    Returns number

invertColorScale

  • invertColorScale(scale: ((v: number) => string)): ((v: number) => string)

  • inverts the give color scale by handing in an inverted value (1-v)

    Parameters

    • scale: ((v: number) => string)
        • (v: number): string

        • Parameters

          • v: number

          Returns string

    Returns ((v: number) => string)

      • (v: number): string

      • inverts the give color scale by handing in an inverted value (1-v)

        Parameters

        • v: number

        Returns string

isCategoricalSetValue

isCategoricalStats

  • Parameters

    • obj: unknown

    Returns obj is ICategoricalStats

isDateStats

  • Parameters

    • obj: unknown

    Returns obj is IDateStats

isNumberStats

  • Parameters

    • obj: unknown

    Returns obj is INumberStats

isTextStats

  • Parameters

    • obj: unknown

    Returns obj is ITextStats

maxHistBin

  • maxHistBin<T>(hist: readonly Readonly<IBin<T>>[]): Readonly<IBin<T>> | null

  • Type Parameters

    • T

    Parameters

    • hist: readonly Readonly<IBin<T>>[]

    Returns Readonly<IBin<T>> | null

mergeStyles

  • mergeStyles(...args: (undefined | null | boolean | CSSProperties)[]): CSSProperties | undefined

  • Parameters

    • Rest ...args: (undefined | null | boolean | CSSProperties)[]

    Returns CSSProperties | undefined

normalize

  • normalize(min: number, max: number): ((v: number) => number)

numberStatsGenerator

resolveDateFormatter

  • resolveDateFormatter(format?: DateFormatter): ((v: Date) => string)

  • helper function to resolve a date formatter

    Parameters

    Returns ((v: Date) => string)

      • (v: Date): string

      • helper function to resolve a date formatter

        Parameters

        • v: Date

        Returns string

resolveNumberFormatter

  • helper function to resolve the number formatter

    Parameters

    Returns ((v: number) => string)

      • (v: number): string

      • helper function to resolve the number formatter

        Parameters

        • v: number

        Returns string

simpleStats

  • simpleStats(values: readonly number[]): { count: number; max: number; min: number; missing: number }

  • Parameters

    • values: readonly number[]

    Returns { count: number; max: number; min: number; missing: number }

    • count: number
    • max: number
    • min: number
    • missing: number

textStatsGenerator

  • text statistics generator

    Parameters

    Returns ((arr: readonly string[]) => ITextStats)

      • text statistics generator

        Parameters

        • arr: readonly string[]

        Returns ITextStats

toHistString

  • toHistString<T>(hist: readonly Readonly<IBin<T>>[]): string

  • Type Parameters

    • T

    Parameters

    • hist: readonly Readonly<IBin<T>>[]

    Returns string

toLocaleString

  • toLocaleString(v?: null | number | Date): string

  • Parameters

    • Optional v: null | number | Date

    Returns string

useI18N

  • useI18N<T>(original: T, overrides?: Partial<T>): Record<keyof T, ((...args: unknown[]) => string)>

  • Type Parameters

    • T extends Record<string, string>

    Parameters

    • original: T
    • Optional overrides: Partial<T>

    Returns Record<keyof T, ((...args: unknown[]) => string)>

Generated using TypeDoc