@rekurt/openkline - v0.2.0
    Preparing search index...

    Interface VolumeProfileOptions

    Construction / styling options for VolumeProfilePrimitive.

    interface VolumeProfileOptions {
        bins?: number;
        colors?: VolumeProfileColors;
        side?: VolumeProfileSide;
        valueAreaPct?: number;
        widthRatio?: number;
    }
    Index

    Properties

    bins? colors? side? valueAreaPct? widthRatio?

    Properties

    bins?: number

    Number of equal price bins across the visible price range. Default 24.

    colors?: VolumeProfileColors

    Tier colors. Unset tiers fall back to theme-derived defaults.

    side?: VolumeProfileSide

    Edge the bars anchor to and grow from. Default 'right'.

    valueAreaPct?: number

    Fraction of totalVolume the value area must cover, in (0, 1]. Default 0.70.

    widthRatio?: number

    Fraction of the chart width the longest (POC) bar may occupy, in (0, 1]. Default 0.30, so the profile is a readable sidebar rather than covering the price action.

    Settings

    Member Visibility

    On This Page

    Properties