DataFrame | Data-Forge

Constructors

constructor

new DataFrame(config?: Iterator<ValueT> | Iterable<ValueT> | IDataFrameConfig<IndexT, ValueT> | DataFrameConfigFn<IndexT, ValueT>): DataFrame

Parameters
- Optional config: Iterator<ValueT> | Iterable<ValueT> | IDataFrameConfig<IndexT, ValueT> | DataFrameConfigFn<IndexT, ValueT>
Returns DataFrame

Methods

__@iterator

__@iterator(): Iterator<any>

Returns Iterator<any>

An iterator for the dataframe.

after

after(indexValue: IndexT): IDataFrame<IndexT, ValueT>

Parameters
- indexValue: IndexT
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe containing all rows after the specified index value.

aggregate

aggregate<ToT>(seedOrSelector: AggregateFn<ValueT, ToT> | ToT | IColumnAggregateSpec, selector?: AggregateFn<ValueT, ToT>): ToT

Type parameters
- ToT
Parameters
- seedOrSelector: AggregateFn<ValueT, ToT> | ToT | IColumnAggregateSpec
- Optional selector: AggregateFn<ValueT, ToT>
Returns ToT

Returns a new value that has been aggregated from the dataframe using the 'selector' function.

all

all(predicate: PredicateFn<ValueT>): boolean

Parameters
- predicate: PredicateFn<ValueT>
Returns boolean

Returns true if the predicate has returned true or truthy for every row in the dataframe, otherwise returns false. Returns false for an empty dataframe.

any

any(predicate?: PredicateFn<ValueT>): boolean

Parameters
- Optional predicate: PredicateFn<ValueT>
Returns boolean

Returns true if the predicate has returned truthy for any row in the dataframe, otherwise returns false. If no predicate is passed it returns true if the dataframe contains any rows at all. Returns false for an empty dataframe.

appendPair

appendPair(pair: [IndexT, ValueT]): IDataFrame<IndexT, ValueT>

Parameters
- pair: [IndexT, ValueT]
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe with the specified pair appended.

at

at(index: IndexT): ValueT | undefined

Parameters
- index: IndexT
Returns ValueT | undefined

Returns the row from the specified index in the dataframe or undefined if there is no such index in the present in the dataframe.

bake

bake(): IDataFrame<IndexT, ValueT>

Returns IDataFrame<IndexT, ValueT>

Returns a dataframe that has been 'baked', all lazy evaluation has completed.

before

before(indexValue: IndexT): IDataFrame<IndexT, ValueT>

Parameters
- indexValue: IndexT
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe containing all rows up to (but not including) the specified index value.

between

between(startIndexValue: IndexT, endIndexValue: IndexT): IDataFrame<IndexT, ValueT>

Parameters
- startIndexValue: IndexT
- endIndexValue: IndexT
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe containing all values between the specified index values (inclusive).

bringToBack

bringToBack(columnOrColumns: string | string[]): IDataFrame<IndexT, ValueT>

Parameters
- columnOrColumns: string | string[]
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe with 1 or more columns bought to the back of the column ordering.

bringToFront

bringToFront(columnOrColumns: string | string[]): IDataFrame<IndexT, ValueT>

Parameters
- columnOrColumns: string | string[]
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe with 1 or more columns bought to the front of the column ordering.

cast

cast<NewValueT>(): IDataFrame<IndexT, NewValueT>

Type parameters
- NewValueT
Returns IDataFrame<IndexT, NewValueT>

The same dataframe, but with the type changed.

concat

concat(...dataframes: (IDataFrame<IndexT, ValueT> | IDataFrame<IndexT, ValueT>[])[]): IDataFrame<IndexT, ValueT>

Parameters
- Rest ...dataframes: (IDataFrame<IndexT, ValueT> | IDataFrame<IndexT, ValueT>[])[]
Returns IDataFrame<IndexT, ValueT>

Returns a single dataframes concatenated from multiple input dataframes.

count

count(): number

Returns number

Returns the count of all rows.

defaultIfEmpty

defaultIfEmpty(defaultDataFrame: ValueT[] | IDataFrame<IndexT, ValueT>): IDataFrame<IndexT, ValueT>

Parameters
- defaultDataFrame: ValueT[] | IDataFrame<IndexT, ValueT>
Returns IDataFrame<IndexT, ValueT>

Returns 'defaultDataFrame' if the dataframe is empty.

deflate

deflate<ToT>(selector?: SelectorWithIndexFn<ValueT, ToT>): ISeries<IndexT, ToT>

Type parameters
- ToT
Parameters
- Optional selector: SelectorWithIndexFn<ValueT, ToT>
Returns ISeries<IndexT, ToT>

Returns a series that was created from the deflated from the original dataframe.

detectTypes

detectTypes(): IDataFrame<number, ITypeFrequency>

Returns IDataFrame<number, ITypeFrequency>

Returns a dataframe with rows that confirm to ITypeFrequency that describes the data types contained in the original dataframe.

detectValues

detectValues(): IDataFrame<number, IValueFrequency>

Returns IDataFrame<number, IValueFrequency>

Returns a dataframe with rows that conform to IValueFrequency that describes the values contained in the dataframe.

distinct

distinct<ToT>(selector?: SelectorFn<ValueT, ToT>): IDataFrame<IndexT, ValueT>

Type parameters
- ToT
Parameters
- Optional selector: SelectorFn<ValueT, ToT>
Returns IDataFrame<IndexT, ValueT>

Returns a dataframe containing only unique values as determined by the 'selector' function.

dropSeries

dropSeries<NewValueT>(columnOrColumns: string | string[]): IDataFrame<IndexT, NewValueT>

Type parameters
- NewValueT
Parameters
- columnOrColumns: string | string[]
Returns IDataFrame<IndexT, NewValueT>

Returns a new dataframe with a particular named column or columns removed.

endAt

endAt(indexValue: IndexT): IDataFrame<IndexT, ValueT>

Parameters
- indexValue: IndexT
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe containing all rows up until and including the specified index value.

ensureSeries

ensureSeries<SeriesValueT>(columnNameOrSpec: string | IColumnGenSpec, series?: ISeries<IndexT, SeriesValueT> | SeriesSelectorFn<IndexT, ValueT, SeriesValueT>): IDataFrame<IndexT, ValueT>

Type parameters
- SeriesValueT
Parameters
- columnNameOrSpec: string | IColumnGenSpec
- Optional series: ISeries<IndexT, SeriesValueT> | SeriesSelectorFn<IndexT, ValueT, SeriesValueT>
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe with the specified series added, if the series didn't already exist. Otherwise if the requested series already exists the same dataframe is returned.

except

except<InnerIndexT, InnerValueT, KeyT>(inner: IDataFrame<InnerIndexT, InnerValueT>, outerSelector?: SelectorFn<ValueT, KeyT>, innerSelector?: SelectorFn<InnerValueT, KeyT>): IDataFrame<IndexT, ValueT>

Type parameters
- InnerIndexT
- InnerValueT
- KeyT
Parameters
- inner: IDataFrame<InnerIndexT, InnerValueT>
- Optional outerSelector: SelectorFn<ValueT, KeyT>
- Optional innerSelector: SelectorFn<InnerValueT, KeyT>
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe that contains only the rows from the 1st dataframe that don't appear in the 2nd dataframe.

expectSeries

expectSeries<SeriesValueT>(columnName: string): ISeries<IndexT, SeriesValueT>

Type parameters
- SeriesValueT
Parameters
- columnName: string
Returns ISeries<IndexT, SeriesValueT>

Returns the Series for the column if it exists, otherwise it throws an exception.

fillGaps

fillGaps(comparer: ComparerFn<[IndexT, ValueT], [IndexT, ValueT]>, generator: GapFillFn<[IndexT, ValueT], [IndexT, ValueT]>): IDataFrame<IndexT, ValueT>

Parameters
- comparer: ComparerFn<[IndexT, ValueT], [IndexT, ValueT]>
- generator: GapFillFn<[IndexT, ValueT], [IndexT, ValueT]>
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe with gaps filled in.

filter

filter(predicate: PredicateFn<ValueT>): IDataFrame<IndexT, ValueT>

Parameters
- predicate: PredicateFn<ValueT>
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe containing only the values from the original dataframe that matched the predicate.

first

first(): ValueT

Returns ValueT

Returns the first row of the dataframe.

flatMap

flatMap<ToT>(transformer: SelectorWithIndexFn<ValueT, Iterable<ToT>>): IDataFrame<IndexT, ToT>

Type parameters
- ToT
Parameters
- transformer: SelectorWithIndexFn<ValueT, Iterable<ToT>>
Returns IDataFrame<IndexT, ToT>

Returns a new dataframe generated by calling the transformer function over each element of the input.

forEach

forEach(callback: CallbackFn<ValueT>): IDataFrame<IndexT, ValueT>

Parameters
- callback: CallbackFn<ValueT>
Returns IDataFrame<IndexT, ValueT>

Returns the original dataframe with no modifications.

generateSeries

generateSeries<NewValueT>(generator: SelectorWithIndexFn<any, any> | IColumnTransformSpec): IDataFrame<IndexT, NewValueT>

Type parameters
- NewValueT
Parameters
- generator: SelectorWithIndexFn<any, any> | IColumnTransformSpec
Returns IDataFrame<IndexT, NewValueT>

Returns a new dataframe with 1 or more new columns.

getColumnNames

getColumnNames(): string[]

Returns string[]

Returns an array of the column names in the dataframe.

getColumns

getColumns(): ISeries<number, IColumn>

Returns ISeries<number, IColumn>

Returns a Series containing the names of the columns in the dataframe.

getIndex

getIndex(): IIndex<IndexT>

Returns IIndex<IndexT>

The Index for the dataframe.

getSeries

getSeries<SeriesValueT>(columnName: string): ISeries<IndexT, SeriesValueT>

Type parameters
- SeriesValueT
Parameters
- columnName: string
Returns ISeries<IndexT, SeriesValueT>

Returns the Series extracted from the named column in the dataframe.

getTypeCode

getTypeCode(): string

Returns string

Returns the string "dataframe".

groupBy

groupBy<GroupT>(selector: SelectorWithIndexFn<ValueT, GroupT>): ISeries<number, IDataFrame<IndexT, ValueT>>

Type parameters
- GroupT
Parameters
- selector: SelectorWithIndexFn<ValueT, GroupT>
Returns ISeries<number, IDataFrame<IndexT, ValueT>>

Returns a Series of groups. Each group is a dataframe with values that have been grouped by the 'selector' function.

groupSequentialBy

groupSequentialBy<GroupT>(selector?: SelectorFn<ValueT, GroupT>): ISeries<number, IDataFrame<IndexT, ValueT>>

Type parameters
- GroupT
Parameters
- Optional selector: SelectorFn<ValueT, GroupT>
Returns ISeries<number, IDataFrame<IndexT, ValueT>>

Returns a Series of groups. Each group is a dataframe with values that have been grouped by the 'selector' function.

hasSeries

hasSeries(columnName: string): boolean

Parameters
- columnName: string
Returns boolean

Returns true if the dataframe contains the requested Series, otherwise returns false.

head

head(numValues: number): IDataFrame<IndexT, ValueT>

Parameters
- numValues: number
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe that has only the specified number of rows taken from the start of the original dataframe.

inflateSeries

inflateSeries<NewValueT>(columnName: string, selector?: SelectorWithIndexFn<IndexT, any>): IDataFrame<IndexT, ValueT>

Type parameters
- NewValueT
Parameters
- columnName: string
- Optional selector: SelectorWithIndexFn<IndexT, any>
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe with a column inflated to 1 or more new columns.

insertPair

insertPair(pair: [IndexT, ValueT]): IDataFrame<IndexT, ValueT>

Parameters
- pair: [IndexT, ValueT]
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe with the specified pair inserted.

intersection

intersection<InnerIndexT, InnerValueT, KeyT>(inner: IDataFrame<InnerIndexT, InnerValueT>, outerSelector?: SelectorFn<ValueT, KeyT>, innerSelector?: SelectorFn<InnerValueT, KeyT>): IDataFrame<IndexT, ValueT>

Type parameters
- InnerIndexT
- InnerValueT
- KeyT
Parameters
- inner: IDataFrame<InnerIndexT, InnerValueT>
- Optional outerSelector: SelectorFn<ValueT, KeyT>
- Optional innerSelector: SelectorFn<InnerValueT, KeyT>
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe that contains the intersection of rows from the two input dataframes.

join

join<KeyT, InnerIndexT, InnerValueT, ResultValueT>(inner: IDataFrame<InnerIndexT, InnerValueT>, outerKeySelector: SelectorFn<ValueT, KeyT>, innerKeySelector: SelectorFn<InnerValueT, KeyT>, resultSelector: JoinFn<ValueT, InnerValueT, ResultValueT>): IDataFrame<number, ResultValueT>

Type parameters
- KeyT
- InnerIndexT
- InnerValueT
- ResultValueT
Parameters
- inner: IDataFrame<InnerIndexT, InnerValueT>
- outerKeySelector: SelectorFn<ValueT, KeyT>
- innerKeySelector: SelectorFn<InnerValueT, KeyT>
- resultSelector: JoinFn<ValueT, InnerValueT, ResultValueT>
Returns IDataFrame<number, ResultValueT>

Returns the new merged dataframe.

joinOuter

joinOuter<KeyT, InnerIndexT, InnerValueT, ResultValueT>(inner: IDataFrame<InnerIndexT, InnerValueT>, outerKeySelector: SelectorFn<ValueT, KeyT>, innerKeySelector: SelectorFn<InnerValueT, KeyT>, resultSelector: JoinFn<ValueT | null, InnerValueT | null, ResultValueT>): IDataFrame<number, ResultValueT>

Type parameters
- KeyT
- InnerIndexT
- InnerValueT
- ResultValueT
Parameters
- inner: IDataFrame<InnerIndexT, InnerValueT>
- outerKeySelector: SelectorFn<ValueT, KeyT>
- innerKeySelector: SelectorFn<InnerValueT, KeyT>
- resultSelector: JoinFn<ValueT | null, InnerValueT | null, ResultValueT>
Returns IDataFrame<number, ResultValueT>

Returns the new merged dataframe.

joinOuterLeft

joinOuterLeft<KeyT, InnerIndexT, InnerValueT, ResultValueT>(inner: IDataFrame<InnerIndexT, InnerValueT>, outerKeySelector: SelectorFn<ValueT, KeyT>, innerKeySelector: SelectorFn<InnerValueT, KeyT>, resultSelector: JoinFn<ValueT | null, InnerValueT | null, ResultValueT>): IDataFrame<number, ResultValueT>

Type parameters
- KeyT
- InnerIndexT
- InnerValueT
- ResultValueT
Parameters
- inner: IDataFrame<InnerIndexT, InnerValueT>
- outerKeySelector: SelectorFn<ValueT, KeyT>
- innerKeySelector: SelectorFn<InnerValueT, KeyT>
- resultSelector: JoinFn<ValueT | null, InnerValueT | null, ResultValueT>
Returns IDataFrame<number, ResultValueT>

Returns the new merged dataframe.

joinOuterRight

joinOuterRight<KeyT, InnerIndexT, InnerValueT, ResultValueT>(inner: IDataFrame<InnerIndexT, InnerValueT>, outerKeySelector: SelectorFn<ValueT, KeyT>, innerKeySelector: SelectorFn<InnerValueT, KeyT>, resultSelector: JoinFn<ValueT | null, InnerValueT | null, ResultValueT>): IDataFrame<number, ResultValueT>

Type parameters
- KeyT
- InnerIndexT
- InnerValueT
- ResultValueT
Parameters
- inner: IDataFrame<InnerIndexT, InnerValueT>
- outerKeySelector: SelectorFn<ValueT, KeyT>
- innerKeySelector: SelectorFn<InnerValueT, KeyT>
- resultSelector: JoinFn<ValueT | null, InnerValueT | null, ResultValueT>
Returns IDataFrame<number, ResultValueT>

Returns the new merged dataframe.

last

last(): ValueT

Returns ValueT

Returns the last row of the dataframe.

map

map<ToT>(transformer: SelectorWithIndexFn<ValueT, ToT>): IDataFrame<IndexT, ToT>

Type parameters
- ToT
Parameters
- transformer: SelectorWithIndexFn<ValueT, ToT>
Returns IDataFrame<IndexT, ToT>

Returns a new dataframe generated by calling the transformer function over each element of the input.

melt

melt<ValueT>(idColumnOrColumns: string | Iterable<string>, valueColumnOrColumns: string | Iterable<string>): IDataFrame<IndexT, ValueT>

Type parameters
- ValueT
Parameters
- idColumnOrColumns: string | Iterable<string>
- valueColumnOrColumns: string | Iterable<string>
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe that has been unpivoted based on a particular column's values.

merge

merge<MergedValueT>(...otherDataFrames: IDataFrame<IndexT, any>[]): IDataFrame<IndexT, MergedValueT>

Type parameters
- MergedValueT
Parameters
- Rest ...otherDataFrames: IDataFrame<IndexT, any>[]
Returns IDataFrame<IndexT, MergedValueT>

The merged data frame.

none

none(predicate?: PredicateFn<ValueT>): boolean

Parameters
- Optional predicate: PredicateFn<ValueT>
Returns boolean

Returns true if the predicate has returned truthy for zero rows in the dataframe, otherwise returns false. Returns false for an empty dataframe.

orderBy

orderBy<SortT>(selector: SelectorWithIndexFn<ValueT, SortT>): IOrderedDataFrame<IndexT, ValueT, SortT>

Type parameters
- SortT
Parameters
- selector: SelectorWithIndexFn<ValueT, SortT>
Returns IOrderedDataFrame<IndexT, ValueT, SortT>

Returns a new dataframe that has been ordered accorrding to the value chosen by the selector function.

orderByDescending

orderByDescending<SortT>(selector: SelectorWithIndexFn<ValueT, SortT>): IOrderedDataFrame<IndexT, ValueT, SortT>

Type parameters
- SortT
Parameters
- selector: SelectorWithIndexFn<ValueT, SortT>
Returns IOrderedDataFrame<IndexT, ValueT, SortT>

Returns a new dataframe that has been ordered accorrding to the value chosen by the selector function.

parseDates

parseDates(columnNameOrNames: string | string[], formatString?: undefined | string): IDataFrame<IndexT, ValueT>

Parameters
- columnNameOrNames: string | string[]
- Optional formatString: undefined | string
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe with values of particular named column(s) parsed from strings to dates.

parseFloats

parseFloats(columnNameOrNames: string | string[]): IDataFrame<IndexT, ValueT>

Parameters
- columnNameOrNames: string | string[]
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe with values of particular named column(s) parsed from strings to floats.

parseInts

parseInts(columnNameOrNames: string | string[]): IDataFrame<IndexT, ValueT>

Parameters
- columnNameOrNames: string | string[]
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe with values of particular named column(s) parsed from strings to ints.

pivot

pivot<NewValueT>(columnOrColumns: string | Iterable<string>, valueColumnNameOrSpec: string | IMultiColumnAggregatorSpec, aggregator?: undefined | function): IDataFrame<number, NewValueT>

Type parameters
- NewValueT
Parameters
- columnOrColumns: string | Iterable<string>
- valueColumnNameOrSpec: string | IMultiColumnAggregatorSpec
- Optional aggregator: undefined | function
Returns IDataFrame<number, NewValueT>

Returns a new dataframe that has been pivoted based on a particular column's values.

reduce

reduce<ToT>(reducer: AggregateFn<ValueT, ToT>, seed?: ToT): ToT

Type parameters
- ToT
Parameters
- reducer: AggregateFn<ValueT, ToT>
- Optional seed: ToT
Returns ToT

Returns a value that has been reduced from the input dataframe by passing each element through the reducer function.

renameSeries

renameSeries<NewValueT>(newColumnNames: IColumnRenameSpec): IDataFrame<IndexT, NewValueT>

Type parameters
- NewValueT
Parameters
- newColumnNames: IColumnRenameSpec
Returns IDataFrame<IndexT, NewValueT>

Returns a new dataframe with specified columns renamed.

reorderSeries

reorderSeries<NewValueT>(columnNames: string[]): IDataFrame<IndexT, NewValueT>

Type parameters
- NewValueT
Parameters
- columnNames: string[]
Returns IDataFrame<IndexT, NewValueT>

Returns a new dataframe with columns reordered according to the order of the array of column names that is passed in.

resetIndex

resetIndex(): IDataFrame<number, ValueT>

Returns IDataFrame<number, ValueT>

Returns a new dataframe with the Index reset to the default zero-based index.

reverse

reverse(): IDataFrame<IndexT, ValueT>

Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe that is the reverse of the input.

rollingWindow

rollingWindow(period: number): ISeries<number, IDataFrame<IndexT, ValueT>>

Parameters
- period: number
Returns ISeries<number, IDataFrame<IndexT, ValueT>>

Returns a new series, each value of which is a rolling chunk of the original dataframe.

round

round(numDecimalPlaces?: undefined | number): IDataFrame<IndexT, ValueT>

Parameters
- Optional numDecimalPlaces: undefined | number
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe with all number values rounded to the specified number of places.

select

select<ToT>(transformer: SelectorWithIndexFn<ValueT, ToT>): IDataFrame<IndexT, ToT>

Type parameters
- ToT
Parameters
- transformer: SelectorWithIndexFn<ValueT, ToT>
Returns IDataFrame<IndexT, ToT>

Returns a new dataframe generated by calling the transformer function over each element of the input.

selectMany

selectMany<ToT>(transformer: SelectorWithIndexFn<ValueT, Iterable<ToT>>): IDataFrame<IndexT, ToT>

Type parameters
- ToT
Parameters
- transformer: SelectorWithIndexFn<ValueT, Iterable<ToT>>
Returns IDataFrame<IndexT, ToT>

Returns a new dataframe generated by calling the transformer function over each element of the input.

sequentialDistinct

sequentialDistinct<ToT>(selector?: SelectorFn<ValueT, ToT>): IDataFrame<IndexT, ValueT>

Type parameters
- ToT
Parameters
- Optional selector: SelectorFn<ValueT, ToT>
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe with groups of adjacent duplicate rows collapsed to a single row per group.

serialize

serialize(): ISerializedDataFrame

Returns ISerializedDataFrame

Returns a JavaScript data structure conforming to {@link ISerializedDataFrame} that represents the dataframe and its internal structure.

setIndex

setIndex<NewIndexT>(columnName: string): IDataFrame<NewIndexT, ValueT>

Type parameters
- NewIndexT
Parameters
- columnName: string
Returns IDataFrame<NewIndexT, ValueT>

Returns a new dataframe with the values of the specified column as the new Index.

skip

skip(numValues: number): IDataFrame<IndexT, ValueT>

Parameters
- numValues: number
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe with the specified number of rows skipped.

skipUntil

skipUntil(predicate: PredicateFn<ValueT>): IDataFrame<IndexT, ValueT>

Parameters
- predicate: PredicateFn<ValueT>
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe with all initial sequential rows removed until the predicate returned true/truthy.

skipWhile

skipWhile(predicate: PredicateFn<ValueT>): IDataFrame<IndexT, ValueT>

Parameters
- predicate: PredicateFn<ValueT>
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe with all initial sequential rows removed while the predicate returned true/truthy.

startAt

startAt(indexValue: IndexT): IDataFrame<IndexT, ValueT>

Parameters
- indexValue: IndexT
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe containing all rows starting at or after the specified index value.

subset

subset<NewValueT>(columnNames: string[]): IDataFrame<IndexT, NewValueT>

Type parameters
- NewValueT
Parameters
- columnNames: string[]
Returns IDataFrame<IndexT, NewValueT>

Returns a dataframe with a subset of columns from the original dataframe.

summarize

summarize<OutputValueT>(spec?: IMultiColumnAggregatorSpec): OutputValueT

Type parameters
- OutputValueT
Parameters
- Optional spec: IMultiColumnAggregatorSpec
Returns OutputValueT

A object with fields that summary the values in the dataframe.

tail

tail(numValues: number): IDataFrame<IndexT, ValueT>

Parameters
- numValues: number
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe that has only the specified number of rows taken from the end of the original dataframe.

take

take(numRows: number): IDataFrame<IndexT, ValueT>

Parameters
- numRows: number
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe with only the specified number of rows taken from the original dataframe.

takeUntil

takeUntil(predicate: PredicateFn<ValueT>): IDataFrame<IndexT, ValueT>

Parameters
- predicate: PredicateFn<ValueT>
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe with only the initial sequential rows taken until the predicate returned true/truthy.

takeWhile

takeWhile(predicate: PredicateFn<ValueT>): IDataFrame<IndexT, ValueT>

Parameters
- predicate: PredicateFn<ValueT>
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe with only the initial sequential rows that were taken while the predicate returned true/truthy.

toArray

toArray(): any[]

Returns any[]

Returns an array of the values contained within the dataframe.

toCSV

toCSV(options?: ICSVOutputOptions): string

Parameters
- Optional options: ICSVOutputOptions
Returns string

Returns a string in the CSV data format that represents the dataframe.

toHTML

toHTML(): string

Returns string

Returns a string in HTML format that represents the dataframe.

toJSON

toJSON(): string

Returns string

Returns a string in the JSON data format that represents the dataframe.

toJSON5

toJSON5(): string

Returns string

Returns a string in the JSON5 data format that represents the dataframe.

toObject

toObject<KeyT, FieldT, OutT>(keySelector: function, valueSelector: function): OutT

Type parameters
- KeyT
- FieldT
- OutT
Parameters
- keySelector: function
  - - (value: ValueT): KeyT
    - Parameters
      - value: ValueT
      Returns KeyT
- valueSelector: function
  - - (value: ValueT): FieldT
    - Parameters
      - value: ValueT
      Returns FieldT
Returns OutT

Returns a JavaScript object generated from the dataframe by applying the key and value selector functions.

toPairs

toPairs(): Object[]

Returns Object[]

Returns an array of pairs that contains the dataframe content. Each pair is a two element array that contains an index and a value.

toRows

toRows(): any[][]

Returns any[][]

Returns an array of rows. Each row is an array of values in column order.

toString

toString(): string

Returns string

Generates and returns a string representation of the dataframe.

toStrings

toStrings(columnNames: string | string[] | IFormatSpec, formatString?: undefined | string): IDataFrame<IndexT, ValueT>

Parameters
- columnNames: string | string[] | IFormatSpec
- Optional formatString: undefined | string
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe with a particular named column converted from values to strings.

transformSeries

transformSeries<NewValueT>(columnSelectors: IColumnTransformSpec): IDataFrame<IndexT, NewValueT>

Type parameters
- NewValueT
Parameters
- columnSelectors: IColumnTransformSpec
Returns IDataFrame<IndexT, NewValueT>

Returns a new dataframe with 1 or more columns transformed.

truncateStrings

truncateStrings(maxLength: number): IDataFrame<IndexT, ValueT>

Parameters
- maxLength: number
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe with all strings truncated to the specified maximum length.

union

union<KeyT>(other: IDataFrame<IndexT, ValueT>, selector?: SelectorFn<ValueT, KeyT>): IDataFrame<IndexT, ValueT>

Type parameters
- KeyT
Parameters
- other: IDataFrame<IndexT, ValueT>
- Optional selector: SelectorFn<ValueT, KeyT>
Returns IDataFrame<IndexT, ValueT>

Returns the union of the two dataframes.

variableWindow

variableWindow(comparer: ComparerFn<ValueT, ValueT>): ISeries<number, IDataFrame<IndexT, ValueT>>

Parameters
- comparer: ComparerFn<ValueT, ValueT>
Returns ISeries<number, IDataFrame<IndexT, ValueT>>

Returns a new series, each value of which is a chunk of data from the original dataframe.

where

where(predicate: PredicateFn<ValueT>): IDataFrame<IndexT, ValueT>

Parameters
- predicate: PredicateFn<ValueT>
Returns IDataFrame<IndexT, ValueT>

Returns a new dataframe containing only the values from the original dataframe that matched the predicate.

window

window(period: number): ISeries<number, IDataFrame<IndexT, ValueT>>

Parameters
- period: number
Returns ISeries<number, IDataFrame<IndexT, ValueT>>

Returns a new series, each value of which is a chunk of the original dataframe.

withIndex

withIndex<NewIndexT>(newIndex: Iterable<NewIndexT> | SelectorFn<ValueT, NewIndexT>): IDataFrame<NewIndexT, ValueT>

Type parameters
- NewIndexT
Parameters
- newIndex: Iterable<NewIndexT> | SelectorFn<ValueT, NewIndexT>
Returns IDataFrame<NewIndexT, ValueT>

Returns a new dataframe or dataframe with the specified Index attached.

withSeries

withSeries<OutputValueT, SeriesValueT>(columnNameOrSpec: string | IColumnGenSpec, series?: ISeries<IndexT, SeriesValueT> | SeriesSelectorFn<IndexT, ValueT, SeriesValueT>): IDataFrame<IndexT, OutputValueT>

Type parameters
- OutputValueT
- SeriesValueT
Parameters
- columnNameOrSpec: string | IColumnGenSpec
- Optional series: ISeries<IndexT, SeriesValueT> | SeriesSelectorFn<IndexT, ValueT, SeriesValueT>
Returns IDataFrame<IndexT, OutputValueT>

Returns a new dataframe replacing or adding a particular named column.

zip

zip<Index2T, Value2T, ResultT>(s2: IDataFrame<Index2T, Value2T>, zipper: Zip2Fn<ValueT, Value2T, ResultT>): IDataFrame<IndexT, ResultT>
zip<Index2T, Value2T, Index3T, Value3T, ResultT>(s2: IDataFrame<Index2T, Value2T>, s3: IDataFrame<Index3T, Value3T>, zipper: Zip3Fn<ValueT, Value2T, Value3T, ResultT>): IDataFrame<IndexT, ResultT>
zip<Index2T, Value2T, Index3T, Value3T, Index4T, Value4T, ResultT>(s2: IDataFrame<Index2T, Value2T>, s3: IDataFrame<Index3T, Value3T>, s4: IDataFrame<Index4T, Value4T>, zipper: Zip3Fn<ValueT, Value2T, Value3T, ResultT>): IDataFrame<IndexT, ResultT>

Type parameters
- Index2T
- Value2T
- ResultT
Parameters
- s2: IDataFrame<Index2T, Value2T>
- zipper: Zip2Fn<ValueT, Value2T, ResultT>
Returns IDataFrame<IndexT, ResultT>

Returns a single dataframe zipped (or merged) from multiple input dataframes.
Type parameters
- Index2T
- Value2T
- Index3T
- Value3T
- ResultT
Parameters
- s2: IDataFrame<Index2T, Value2T>
- s3: IDataFrame<Index3T, Value3T>
- zipper: Zip3Fn<ValueT, Value2T, Value3T, ResultT>
Returns IDataFrame<IndexT, ResultT>
Type parameters
- Index2T
- Value2T
- Index3T
- Value3T
- Index4T
- Value4T
- ResultT
Parameters
- s2: IDataFrame<Index2T, Value2T>
- s3: IDataFrame<Index3T, Value3T>
- s4: IDataFrame<Index4T, Value4T>
- zipper: Zip3Fn<ValueT, Value2T, Value3T, ResultT>
Returns IDataFrame<IndexT, ResultT>

Static concat

concat<IndexT, ValueT>(dataframes: IDataFrame<IndexT, ValueT>[]): IDataFrame<IndexT, ValueT>

Type parameters
- IndexT
- ValueT
Parameters
- dataframes: IDataFrame<IndexT, ValueT>[]
Returns IDataFrame<IndexT, ValueT>

Returns a single dataframe concatenated from multiple input dataframes.

Static deserialize

deserialize<IndexT, ValueT>(input: ISerializedDataFrame): IDataFrame<IndexT, ValueT>

Type parameters
- IndexT
- ValueT
Parameters
- input: ISerializedDataFrame
Returns IDataFrame<IndexT, ValueT>

Returns the deserialized/reconstituted dataframe.

Static merge

merge<MergedValueT, IndexT, ValueT>(dataFrames: Iterable<IDataFrame<IndexT, ValueT>>): IDataFrame<IndexT, MergedValueT>

Type parameters
- MergedValueT
- IndexT
- ValueT
Parameters
- dataFrames: Iterable<IDataFrame<IndexT, ValueT>>
Returns IDataFrame<IndexT, MergedValueT>

The merged data frame.

Static zip

zip<IndexT, ValueT, ResultT>(dataframes: Iterable<IDataFrame<IndexT, ValueT>>, zipper: ZipNFn<ValueT, ResultT>): IDataFrame<IndexT, ResultT>

Type parameters
- IndexT
- ValueT
- ResultT
Parameters
- dataframes: Iterable<IDataFrame<IndexT, ValueT>>
- zipper: ZipNFn<ValueT, ResultT>
Returns IDataFrame<IndexT, ResultT>

Returns a single dataframe zipped (or merged) from multiple input dataframes.

Constructors

constructor

Parameters

Optional config: Iterator<ValueT> | Iterable<ValueT> | IDataFrameConfig<IndexT, ValueT> | DataFrameConfigFn<IndexT, ValueT>

Returns DataFrame

Methods

__@iterator

Returns Iterator<any>

after

Parameters

indexValue: IndexT

Returns IDataFrame<IndexT, ValueT>

aggregate

Type parameters

ToT

Parameters

seedOrSelector: AggregateFn<ValueT, ToT> | ToT | IColumnAggregateSpec

Optional selector: AggregateFn<ValueT, ToT>

Returns ToT

all

Parameters

predicate: PredicateFn<ValueT>

Returns boolean

any

Parameters

Optional predicate: PredicateFn<ValueT>

Returns boolean

appendPair

Parameters

pair: [IndexT, ValueT]

Returns IDataFrame<IndexT, ValueT>

at

Parameters

index: IndexT

Returns ValueT | undefined

bake

Returns IDataFrame<IndexT, ValueT>

before

Parameters

indexValue: IndexT

Returns IDataFrame<IndexT, ValueT>

between

Parameters

startIndexValue: IndexT

endIndexValue: IndexT

Returns IDataFrame<IndexT, ValueT>

bringToBack

Parameters

columnOrColumns: string | string[]

Returns IDataFrame<IndexT, ValueT>

bringToFront

Parameters

columnOrColumns: string | string[]

Returns IDataFrame<IndexT, ValueT>

cast

Type parameters

NewValueT

Returns IDataFrame<IndexT, NewValueT>

concat

Parameters

Rest ...dataframes: (IDataFrame<IndexT, ValueT> | IDataFrame<IndexT, ValueT>[])[]

Returns IDataFrame<IndexT, ValueT>

count

Returns number

defaultIfEmpty

Parameters

defaultDataFrame: ValueT[] | IDataFrame<IndexT, ValueT>

Returns IDataFrame<IndexT, ValueT>

deflate

Type parameters

ToT

Parameters

Optional selector: SelectorWithIndexFn<ValueT, ToT>

Returns ISeries<IndexT, ToT>

detectTypes

Returns IDataFrame<number, ITypeFrequency>

detectValues

Returns IDataFrame<number, IValueFrequency>

distinct

Type parameters