kepler.gl/src/components/dist/hooks/use-legend-position.d.ts

kepler.gl is a webgl based application to visualize large scale location data in the browser

import { MapLegendControlSettings } from '@kepler.gl/types';
type Params = {
    legendContentRef: React.MutableRefObject<HTMLElement | null>;
    isSidePanelShown: boolean;
    settings?: MapLegendControlSettings;
    onChangeSettings: (settings: Partial<MapLegendControlSettings>) => void;
    theme: Record<string, any>;
    mapHeight?: number;
    mapWidth?: number;
};
type ReturnType = {
    positionStyles: Record<string, unknown>;
    updatePosition: () => void;
    contentHeight: number;
    maxContentHeight?: number;
    startResize: () => void;
    resize: (deltaY: number) => void;
};
export type UseCalcLegendPositionProps = {
    legendContentRef: React.MutableRefObject<HTMLElement | null>;
    isSidePanelShown: boolean;
    sidePanelWidth: number;
};
export declare function useCalcLegendPosition({ legendContentRef, isSidePanelShown, sidePanelWidth }: UseCalcLegendPositionProps): () => MapLegendControlSettings["position"];
/**
 * Returns a function that calculates the anchored position of the map legend
 * that is being dragged.
 */
export default function useLegendPosition({ legendContentRef, isSidePanelShown, settings, onChangeSettings, theme, mapHeight, mapWidth }: Params): ReturnType;
export {};