stream-charts
    Preparing search index...

    Interface Props

    interface Props {
        container?: RefObject<HTMLElement | null>;
        location?: LegendLocation;
        offset?: { x: number; y: number };
        style?: Partial<LegendStyle>;
        visible: boolean;
    }
    Index

    Properties

    container? location? offset? style? visible

    Properties

    container?: RefObject<HTMLElement | null>

    When provided, the legend renders as an HTML element portal into this external container instead of inside the chart SVG. Position the container however you like — the legend fills it.

    location?: LegendLocation

    Where to anchor the legend within the plot area. Ignored when container is provided.

    LegendLocation.TOP_RIGHT
    offset?: { x: number; y: number }

    Optional offset in pixels from the chosen corner, applied after the margin. Ignored when container is provided.

    { x: 10, y: 10 }
    style?: Partial<LegendStyle>

    Style overrides for the legend

    visible: boolean

    Whether the legend is visible

    Settings

    Member Visibility

    On This Page

    Properties