Series | Data-Forge

Constructors

constructor

new Series(config?: Iterator<ValueT> | Iterable<ValueT> | ISeriesConfig<IndexT, ValueT> | SeriesConfigFn<IndexT, ValueT>): Series

Parameters
- Optional config: Iterator<ValueT> | Iterable<ValueT> | ISeriesConfig<IndexT, ValueT> | SeriesConfigFn<IndexT, ValueT>
Returns Series

Methods

__@iterator

__@iterator(): Iterator<ValueT>

Returns Iterator<ValueT>

An iterator for the series.

after

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

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

Returns a new series containing all values after the specified index value.

aggregate

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

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

Returns a new value that has been reduced from the input series by passing it through the 'reducer' 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 value in the series, otherwise returns false. Returns false for an empty series.

amountChange

amountChange(period?: undefined | number, whichIndex?: WhichIndex): ISeries<IndexT, number>

Parameters
- Optional period: undefined | number
- Optional whichIndex: WhichIndex
Returns ISeries<IndexT, number>

Returns a new series where each value indicates the amount of change from the previous number value in the original series.

amountRange

amountRange(period: number, whichIndex?: WhichIndex): ISeries<IndexT, number>

Parameters
- period: number
- Optional whichIndex: WhichIndex
Returns ISeries<IndexT, number>

Returns a new series where each value indicates the absolute range of values for each period in the original series.

any

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

Parameters
- Optional predicate: PredicateFn<ValueT>
Returns boolean

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

appendPair

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

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

Returns a new series with the specified pair appended.

at

at(index: IndexT): ValueT | undefined

Parameters
- index: IndexT
Returns ValueT | undefined

Returns the value from the specified index in the series or undefined if there is no such index in the present in the series.

average

average(): number

Returns number

Returns the average of the number values in the series.

bake

bake(): ISeries<IndexT, ValueT>

Returns ISeries<IndexT, ValueT>

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

before

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

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

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

between

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

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

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

bucket

bucket(numBuckets: number): IDataFrame<IndexT, IBucket>

Parameters
- numBuckets: number
Returns IDataFrame<IndexT, IBucket>

Returns a dataframe containing bucketed values. The input values are divided up into these buckets.

cast

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

Type parameters
- NewValueT
Returns ISeries<IndexT, NewValueT>

The same series, but with the type changed.

concat

concat(...series: (ISeries<IndexT, ValueT> | ISeries<IndexT, ValueT>[])[]): ISeries<IndexT, ValueT>

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

Returns a single series concatenated from multiple input series.

count

count(): number

Returns number

Returns the count of all values.

counter

counter(predicate: PredicateFn<ValueT>): ISeries<IndexT, number>

Parameters
- predicate: PredicateFn<ValueT>
Returns ISeries<IndexT, number>

Returns a new series that counts up the number of sequential values where the predicate evaluates to truthy. 0 values appear when the prediate evaluates to falsy.

cumsum

cumsum(): ISeries<IndexT, number>

Returns ISeries<IndexT, number>

Returns a new series that is the cumulative sum of values across the input series.

defaultIfEmpty

defaultIfEmpty(defaultSequence: ValueT[] | ISeries<IndexT, ValueT>): ISeries<IndexT, ValueT>

Parameters
- defaultSequence: ValueT[] | ISeries<IndexT, ValueT>
Returns ISeries<IndexT, ValueT>

Returns 'defaultSequence' if the input series is empty.

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 series.

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 original series.

distinct

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

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

Returns a series containing only unique values in the series.

endAt

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

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

Returns a new series containing all values up until and including the specified index value.

except

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

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

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

fillGaps

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

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

Returns a new series with gaps filled in.

filter

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

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

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

first

first(): ValueT

Returns ValueT

Returns the first value of the series.

flatMap

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

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

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

forEach

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

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

Returns the original series with no modifications.

frequency

frequency(options?: IFrequencyTableOptions): IDataFrame<number, IFrequencyTableEntry>

Parameters
- Optional options: IFrequencyTableOptions
Returns IDataFrame<number, IFrequencyTableEntry>

Returns a dataframe for the frequency table showing the frequency for the band of values in each group.

getIndex

getIndex(): IIndex<IndexT>

Returns IIndex<IndexT>

The Index for the series.

getTypeCode

getTypeCode(): string

Returns string

Returns the string "series".

groupBy

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

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

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

groupSequentialBy

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

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

Returns a new series of groups. Each group is a series with values that are the same or have been grouped by the 'selector' function.

head

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

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

Returns a new series that has only the specified number of values taken from the start of the original series.

inflate

inflate<ToT>(selector?: SelectorWithIndexFn<ValueT, ToT>): IDataFrame<IndexT, ToT>

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

Returns a dataframe that was created from the original series.

insertPair

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

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

Returns a new series with the specified pair inserted.

intersection

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

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

Returns a new series that contains the intersection of values from the two input series.

invert

invert(): ISeries<IndexT, number>

Returns ISeries<IndexT, number>

Returns a new series with all number values inverted.

join

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

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

Returns the new merged series.

joinOuter

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

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

Returns the new merged series.

joinOuterLeft

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

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

Returns the new merged series.

joinOuterRight

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

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

Returns the new merged series.

last

last(): ValueT

Returns ValueT

Returns the last value of the series.

map

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

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

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

max

max(): number

Returns number

Returns the maximum of the number values in the series.

mean

mean(): number

Returns number

Returns the mean of the number values in the series.

median

median(): number

Returns number

Returns the median of the values in the series.

merge

merge<MergedValueT>(...args: any[]): ISeries<IndexT, MergedValueT[]>

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

The merged series.

min

min(): number

Returns number

Returns the minimum of the number values in the series.

mode

mode(): any

Returns any

Returns the mode of the values in the series.

none

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

Parameters
- Optional predicate: PredicateFn<ValueT>
Returns boolean

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

orderBy

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

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

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

orderByDescending

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

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

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

parseDates

parseDates(formatString?: undefined | string): ISeries<IndexT, Date>

Parameters
- Optional formatString: undefined | string
Returns ISeries<IndexT, Date>

Returns a new series with values parsed from strings to dates.

parseFloats

parseFloats(): ISeries<IndexT, number>

Returns ISeries<IndexT, number>

Returns a new series with values parsed from strings to floats.

parseInts

parseInts(): ISeries<IndexT, number>

Returns ISeries<IndexT, number>

Returns a new series with values parsed from strings to ints.

percentChange

percentChange(period?: undefined | number, whichIndex?: WhichIndex): ISeries<IndexT, number>

Parameters
- Optional period: undefined | number
- Optional whichIndex: WhichIndex
Returns ISeries<IndexT, number>

Returns a new series where each value indicates the percent change from the previous number value in the original series.

percentRange

percentRange(period: number, whichIndex?: WhichIndex): ISeries<IndexT, number>

Parameters
- period: number
- Optional whichIndex: WhichIndex
Returns ISeries<IndexT, number>

Returns a new series where each value indicates the proportion change from the previous number value in the original series.

percentRank

percentRank(period?: undefined | number): ISeries<IndexT, number>

Parameters
- Optional period: undefined | number
Returns ISeries<IndexT, number>

Returns a new series where each value indicates the percent rank value for that period.

proportionChange

proportionChange(period?: undefined | number, whichIndex?: WhichIndex): ISeries<IndexT, number>

Parameters
- Optional period: undefined | number
- Optional whichIndex: WhichIndex
Returns ISeries<IndexT, number>

Returns a new series where each value indicates the proportion change from the previous number value in the original series.

proportionRange

proportionRange(period: number, whichIndex?: WhichIndex): ISeries<IndexT, number>

Parameters
- period: number
- Optional whichIndex: WhichIndex
Returns ISeries<IndexT, number>

Returns a new series where each value indicates the proportion change from the previous number value in the original series.

proportionRank

proportionRank(period?: undefined | number): ISeries<IndexT, number>

Parameters
- Optional period: undefined | number
Returns ISeries<IndexT, number>

Returns a new series where each value indicates the proportion rank value for that period.

range

range(): number

Returns number

Returns the range of the number values in the series.

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 series by passing each element through the reducer function.

resetIndex

resetIndex(): ISeries<number, ValueT>

Returns ISeries<number, ValueT>

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

reverse

reverse(): ISeries<IndexT, ValueT>

Returns ISeries<IndexT, ValueT>

Returns a new series that is the reverse of the original.

rollingWindow

rollingWindow(period: number, whichIndex?: WhichIndex): ISeries<IndexT, ISeries<IndexT, ValueT>>

Parameters
- period: number
- Optional whichIndex: WhichIndex
Returns ISeries<IndexT, ISeries<IndexT, ValueT>>

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

round

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

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

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

sampleStandardize

sampleStandardize(): ISeries<IndexT, number>

Returns ISeries<IndexT, number>

A new series containing Z scores computed from the input series.

sampleStd

sampleStd(): number

Returns number

Returns the (sample) standard deviation of the values in the series.

sampleVariance

sampleVariance(): number

Returns number

Returns the (sample) variance of the values in the series.

select

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

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

Returns the series generated by calling the transformer function over each value in the input series.

selectMany

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

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

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

sequentialDistinct

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

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

Returns a new series with groups of adjacent duplicate vlaues collapsed to a single value per group.

skip

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

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

Returns a new series with the specified number of values skipped.

skipUntil

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

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

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

skipWhile

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

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

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

standardize

standardize(): ISeries<IndexT, number>

Returns ISeries<IndexT, number>

A new series containing Z scores computed from the input series.

startAt

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

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

Returns a new series containing all values starting at or after the specified index value.

std

std(): number

Returns number

Returns the (population) standard deviation of the values in the series.

sum

sum(): number

Returns number

Returns the sum of the number values in the series.

tail

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

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

Returns a new series that has only the specified number of values taken from the end of the original series.

take

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

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

Returns a new series with only the specified number of values taken from the original series.

takeUntil

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

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

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

takeWhile

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

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

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

toArray

toArray(): any[]

Returns any[]

Returns an array of the values contained within the series.

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 series by applying the key and value selector functions.

toPairs

toPairs(): Object[]

Returns Object[]

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

toString

toString(): string

Returns string

Generates and returns a string representation of the series.

toStrings

toStrings(formatString?: undefined | string): ISeries<IndexT, string>

Parameters
- Optional formatString: undefined | string
Returns ISeries<IndexT, string>

Returns a new series values converted from values to strings.

truncateStrings

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

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

Returns a new series with strings that are truncated to the specified maximum length.

union

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

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

Returns the union of the two series.

variableWindow

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

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

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

variance

variance(): number

Returns number

Returns the (population) variance of the values in the series.

where

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

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

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

window

window(period: number, whichIndex?: WhichIndex): ISeries<IndexT, ISeries<IndexT, ValueT>>

Parameters
- period: number
- Optional whichIndex: WhichIndex
Returns ISeries<IndexT, ISeries<IndexT, ValueT>>

Returns a new series, each value of which is a chunk (data window) of the original series.

withIndex

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

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

Returns a new series with the specified Index attached.

zip

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

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

Returns a single series merged from multiple input series.
Type parameters
- Index2T
- Value2T
- Index3T
- Value3T
- ResultT
Parameters
- s2: ISeries<Index2T, Value2T>
- s3: ISeries<Index3T, Value3T>
- zipper: Zip3Fn<ValueT, Value2T, Value3T, ResultT>
Returns ISeries<IndexT, ResultT>
Type parameters
- Index2T
- Value2T
- Index3T
- Value3T
- Index4T
- Value4T
- ResultT
Parameters
- s2: ISeries<Index2T, Value2T>
- s3: ISeries<Index3T, Value3T>
- s4: ISeries<Index4T, Value4T>
- zipper: Zip3Fn<ValueT, Value2T, Value3T, ResultT>
Returns ISeries<IndexT, ResultT>

Static average

average<IndexT>(series: ISeries<IndexT, number>): number

Type parameters
- IndexT
Parameters
- series: ISeries<IndexT, number>
Returns number

Returns the average of the number values in the series.

Static concat

concat<IndexT, ValueT>(series: ISeries<IndexT, ValueT>[]): ISeries<IndexT, ValueT>

Type parameters
- IndexT
- ValueT
Parameters
- series: ISeries<IndexT, ValueT>[]
Returns ISeries<IndexT, ValueT>

Returns a single series concatenated from multiple input series.

Static count

count<IndexT>(series: ISeries<IndexT, number>): number

Type parameters
- IndexT
Parameters
- series: ISeries<IndexT, number>
Returns number

Returns the count of values in the series.

Static max

max<IndexT>(series: ISeries<IndexT, number>): number

Type parameters
- IndexT
Parameters
- series: ISeries<IndexT, number>
Returns number

Returns the maximum of number values in the series.

Static mean

mean<IndexT>(series: ISeries<IndexT, number>): number

Type parameters
- IndexT
Parameters
- series: ISeries<IndexT, number>
Returns number

Returns the mean of the number values in the series.

Static median

median<IndexT>(series: ISeries<IndexT, number>): number

Type parameters
- IndexT
Parameters
- series: ISeries<IndexT, number>
Returns number

Returns the median of the number values in the series.

Static merge

merge<MergedValueT, IndexT>(series: Iterable<ISeries<IndexT, any>>): ISeries<IndexT, MergedValueT[]>

Type parameters
- MergedValueT
- IndexT
Parameters
- series: Iterable<ISeries<IndexT, any>>
Returns ISeries<IndexT, MergedValueT[]>

The merged series.

Static min

min<IndexT>(series: ISeries<IndexT, number>): number

Type parameters
- IndexT
Parameters
- series: ISeries<IndexT, number>
Returns number

Returns the minimum of number values in the series.

Static mode

mode<IndexT>(series: ISeries<IndexT, any>): any

Type parameters
- IndexT
Parameters
- series: ISeries<IndexT, any>
Returns any

Returns the mode of the number values in the series.

Static parseDate

parseDate(value: any | undefined | null, valueIndex: number, formatString?: undefined | string): Date | undefined

Parameters
- value: any | undefined | null
- valueIndex: number
- Optional formatString: undefined | string
Returns Date | undefined

Static parseFloat

parseFloat(value: any | undefined | null, valueIndex: number): number | undefined

Parameters
- value: any | undefined | null
- valueIndex: number
Returns number | undefined

Static parseInt

parseInt(value: any | undefined | null, valueIndex: number): number | undefined

Parameters
- value: any | undefined | null
- valueIndex: number
Returns number | undefined

Static range

range<IndexT>(series: ISeries<IndexT, number>): number

Type parameters
- IndexT
Parameters
- series: ISeries<IndexT, number>
Returns number

Returns the range of number values in the series.

Static sampleStd

sampleStd<IndexT>(series: ISeries<IndexT, number>): number

Type parameters
- IndexT
Parameters
- series: ISeries<IndexT, number>
Returns number

Returns the (sample) standard deviation of the values in the series.

Static sampleVariance

sampleVariance<IndexT>(series: ISeries<IndexT, number>): number

Type parameters
- IndexT
Parameters
- series: ISeries<IndexT, number>
Returns number

Returns the (sample) variance of the values in the series.

Static std

std<IndexT>(series: ISeries<IndexT, number>): number

Type parameters
- IndexT
Parameters
- series: ISeries<IndexT, number>
Returns number

Returns the (population) standard deviation of the values in the series.

Static sum

sum<IndexT>(series: ISeries<IndexT, number>): number

Type parameters
- IndexT
Parameters
- series: ISeries<IndexT, number>
Returns number

Returns the sum of the number values in the series.

Static toString

toString(value: any | undefined | null, formatString?: undefined | string): string | undefined | null

Parameters
- value: any | undefined | null
- Optional formatString: undefined | string
Returns string | undefined | null

Static variance

variance<IndexT>(series: ISeries<IndexT, number>): number

Type parameters
- IndexT
Parameters
- series: ISeries<IndexT, number>
Returns number

Returns the (population) variance of the values in the series.

Static zip

zip<IndexT, ValueT, ResultT>(series: Iterable<ISeries<IndexT, ValueT>>, zipper: ZipNFn<ValueT, ResultT>): ISeries<IndexT, ResultT>

Type parameters
- IndexT
- ValueT
- ResultT
Parameters
- series: Iterable<ISeries<IndexT, ValueT>>
- zipper: ZipNFn<ValueT, ResultT>
Returns ISeries<IndexT, ResultT>

Returns a single series zipped from multiple input series.

Constructors

constructor

Parameters

Optional config: Iterator<ValueT> | Iterable<ValueT> | ISeriesConfig<IndexT, ValueT> | SeriesConfigFn<IndexT, ValueT>

Returns Series

Methods

__@iterator

Returns Iterator<ValueT>

after

Parameters

indexValue: IndexT

Returns ISeries<IndexT, ValueT>

aggregate

Type parameters

ToT

Parameters

seedOrSelector: AggregateFn<ValueT, ToT> | ToT

Optional selector: AggregateFn<ValueT, ToT>

Returns ToT

all

Parameters

predicate: PredicateFn<ValueT>

Returns boolean

amountChange

Parameters

Optional period: undefined | number

Optional whichIndex: WhichIndex

Returns ISeries<IndexT, number>

amountRange

Parameters

period: number

Optional whichIndex: WhichIndex

Returns ISeries<IndexT, number>

any

Parameters

Optional predicate: PredicateFn<ValueT>

Returns boolean

appendPair

Parameters

pair: [IndexT, ValueT]

Returns ISeries<IndexT, ValueT>

at

Parameters

index: IndexT

Returns ValueT | undefined

average

Returns number

bake

Returns ISeries<IndexT, ValueT>

before

Parameters

indexValue: IndexT

Returns ISeries<IndexT, ValueT>

between

Parameters

startIndexValue: IndexT

endIndexValue: IndexT

Returns ISeries<IndexT, ValueT>

bucket

Parameters

numBuckets: number

Returns IDataFrame<IndexT, IBucket>

cast

Type parameters

NewValueT

Returns ISeries<IndexT, NewValueT>

concat

Parameters

Rest ...series: (ISeries<IndexT, ValueT> | ISeries<IndexT, ValueT>[])[]

Returns ISeries<IndexT, ValueT>

count

Returns number

counter

Parameters

predicate: PredicateFn<ValueT>

Returns ISeries<IndexT, number>

cumsum

Returns ISeries<IndexT, number>

defaultIfEmpty

Parameters