Logo Plotly.NET

EncodedTypedArray Type

Base64-encoded typed array representation accepted by plotly.js (>= 2.28.0) for trace data_array fields. Carries a base64-encoded byte payload (bdata), the underlying value data type (dtype), and an optional shape for multi-dimensional arrays. See the plotly.js v2.28.0 release notes.

Constructors

Constructor Description

EncodedTypedArray()

Full Usage: EncodedTypedArray()

Returns: EncodedTypedArray

Static members

Static member Description

EncodedTypedArray.init (bdata, dtype, ?shape)

Full Usage: EncodedTypedArray.init (bdata, dtype, ?shape)

Parameters:
    bdata : string - The base64-encoded contents of the typed array.
    dtype : TypedArrayDType - The data type of individual values in the payload.
    ?shape : int seq - Optional array shape. Required for multi-dimensional arrays, omittable for 1-D. Serialized as a comma-separated string.

Returns: EncodedTypedArray

Returns a new EncodedTypedArray with the given base64 payload, dtype tag, and optional shape. Use this overload when you already own the base64 encoding (e.g. from numpy-style pipelines).

bdata : string

The base64-encoded contents of the typed array.

dtype : TypedArrayDType

The data type of individual values in the payload.

?shape : int seq

Optional array shape. Required for multi-dimensional arrays, omittable for 1-D. Serialized as a comma-separated string.

Returns: EncodedTypedArray

EncodedTypedArray.ofFloat32Array (data, ?shape)

Full Usage: EncodedTypedArray.ofFloat32Array (data, ?shape)

Parameters:
    data : single[]
    ?shape : int seq

Returns: EncodedTypedArray

Creates an EncodedTypedArray from a 1-D Float32 array.

data : single[]
?shape : int seq
Returns: EncodedTypedArray

EncodedTypedArray.ofFloat64Array (data, ?shape)

Full Usage: EncodedTypedArray.ofFloat64Array (data, ?shape)

Parameters:
    data : float[]
    ?shape : int seq

Returns: EncodedTypedArray

Creates an EncodedTypedArray from a 1-D Float64 array, base64-encoding the underlying bytes. Pass shape to declare a multi-dimensional layout over the flat data.

data : float[]
?shape : int seq
Returns: EncodedTypedArray

EncodedTypedArray.ofInt16Array (data, ?shape)

Full Usage: EncodedTypedArray.ofInt16Array (data, ?shape)

Parameters:
    data : int16[]
    ?shape : int seq

Returns: EncodedTypedArray

Creates an EncodedTypedArray from a 1-D Int16 array.

data : int16[]
?shape : int seq
Returns: EncodedTypedArray

EncodedTypedArray.ofInt32Array (data, ?shape)

Full Usage: EncodedTypedArray.ofInt32Array (data, ?shape)

Parameters:
    data : int32[]
    ?shape : int seq

Returns: EncodedTypedArray

Creates an EncodedTypedArray from a 1-D Int32 array.

data : int32[]
?shape : int seq
Returns: EncodedTypedArray

EncodedTypedArray.ofInt8Array (data, ?shape)

Full Usage: EncodedTypedArray.ofInt8Array (data, ?shape)

Parameters:
    data : sbyte[]
    ?shape : int seq

Returns: EncodedTypedArray

Creates an EncodedTypedArray from a 1-D Int8 (signed byte) array.

data : sbyte[]
?shape : int seq
Returns: EncodedTypedArray

EncodedTypedArray.ofUInt16Array (data, ?shape)

Full Usage: EncodedTypedArray.ofUInt16Array (data, ?shape)

Parameters:
    data : uint16[]
    ?shape : int seq

Returns: EncodedTypedArray

Creates an EncodedTypedArray from a 1-D UInt16 array.

data : uint16[]
?shape : int seq
Returns: EncodedTypedArray

EncodedTypedArray.ofUInt32Array (data, ?shape)

Full Usage: EncodedTypedArray.ofUInt32Array (data, ?shape)

Parameters:
    data : uint32[]
    ?shape : int seq

Returns: EncodedTypedArray

Creates an EncodedTypedArray from a 1-D UInt32 array.

data : uint32[]
?shape : int seq
Returns: EncodedTypedArray

EncodedTypedArray.ofUInt8Array (data, ?shape)

Full Usage: EncodedTypedArray.ofUInt8Array (data, ?shape)

Parameters:
    data : byte[]
    ?shape : int seq

Returns: EncodedTypedArray

Creates an EncodedTypedArray from a 1-D UInt8 (byte) array.

data : byte[]
?shape : int seq
Returns: EncodedTypedArray

EncodedTypedArray.ofUInt8ClampedArray (data, ?shape)

Full Usage: EncodedTypedArray.ofUInt8ClampedArray (data, ?shape)

Parameters:
    data : byte[]
    ?shape : int seq

Returns: EncodedTypedArray

Creates an EncodedTypedArray from a byte array, tagged as UInt8Clamped (maps to JS Uint8ClampedArray).

data : byte[]
?shape : int seq
Returns: EncodedTypedArray

EncodedTypedArray.style (bdata, dtype, ?shape)

Full Usage: EncodedTypedArray.style (bdata, dtype, ?shape)

Parameters:
Returns: EncodedTypedArray -> EncodedTypedArray

Returns a function that applies the given bdata/dtype/shape to an existing EncodedTypedArray.

bdata : string
dtype : TypedArrayDType
?shape : int seq
Returns: EncodedTypedArray -> EncodedTypedArray

Type something to start searching.