Interface DataFrameConstructor

DataFrame constructor

interface DataFrameConstructor {
    deserialize(buf: Buffer, format: "json" | "bincode"): pl.DataFrame<any>;
    isDataFrame(arg: any): arg is pl.DataFrame<any>;
    (): pl.DataFrame<any>;
    <T1>(data: T1, options?: DataFrameOptions): pl.DataFrame<{
        [K in pl.Series<any, string> as K["name"]]: K
    }>;
    <T2>(data: T2, options?: DataFrameOptions): pl.DataFrame<{
        [K in string | number | symbol]: K extends string
            ? pl.Series<JsToDtype<T2[K<K>][number]>, K<K>>
            : never
    }>;
    (data: any, options?: DataFrameOptions): pl.DataFrame<any>;
}

Hierarchy

  • DataFrameConstructor(): pl.DataFrame<any>

  • Create an empty DataFrame

    Returns pl.DataFrame<any>

  • DataFrameConstructor<T1>(data, options?): pl.DataFrame<{
        [K in pl.Series<any, string> as K["name"]]: K
    }>

  • Create a DataFrame from a JavaScript object

    Type Parameters

    • T1 extends ArrayLike<pl.Series<any, string>>

    Parameters

    • data: T1

      object or array of data

    • Optionaloptions: DataFrameOptions

      options

    Returns pl.DataFrame<{
        [K in pl.Series<any, string> as K["name"]]: K
    }>

    Example

    data = {'a': [1n, 2n], 'b': [3, 4]}
    df = pl.DataFrame(data)
    df
    shape: (2, 2)
    ╭─────┬─────╮
    │ a   ┆ b   │
    │ --- ┆ --- │
    │ u64 ┆ i64 │
    ╞═════╪═════╡
    │ 1   ┆ 3   │
    ├╌╌╌╌╌┼╌╌╌╌╌┤
    │ 2   ┆ 4   │
    ╰─────┴─────╯
  • DataFrameConstructor<T2>(data, options?): pl.DataFrame<{
        [K in string | number | symbol]: K extends string
            ? pl.Series<JsToDtype<T2[K<K>][number]>, K<K>>
            : never
    }>

  • Type Parameters

    • T2 extends Record<string, ArrayLike<any>>

    Parameters

    • data: T2
    • Optionaloptions: DataFrameOptions

    Returns pl.DataFrame<{
        [K in string | number | symbol]: K extends string
            ? pl.Series<JsToDtype<T2[K<K>][number]>, K<K>>
            : never
    }>

  • DataFrameConstructor(data, options?): pl.DataFrame<any>

  • Parameters

    • data: any
    • Optionaloptions: DataFrameOptions

    Returns pl.DataFrame<any>

Methods

deserialize isDataFrame

Methods

deserialize

isDataFrame

Settings

Member Visibility

On This Page

Methods