photo-sphere-viewer
Version:
A JavaScript library to display Photo Sphere panoramas
48 lines (37 loc) • 887 B
TypeScript
import { ExtendedPosition, AbstractPlugin, Viewer } from 'photo-sphere-viewer';
type CompassPluginOptions = {
size?: string;
position?: string;
backgroundSvg?: string;
coneColor?: string;
navigation?: boolean;
navigationColor?: string;
hotspots?: CompassPluginHotspot[];
hotspotColor?: string;
};
type CompassPluginHotspot = ExtendedPosition & {
color?: string;
};
/**
* @summary Adds a compass on the viewer
*/
declare class CompassPlugin extends AbstractPlugin {
constructor(psv: Viewer, options: CompassPluginOptions);
/**
* @summary Hides the compass
*/
hide();
/**
* @summary Shows the compass
*/
show();
/**
* @summary Changes the hotspots on the compass
*/
setHotspots(hotspots);
/**
* @summary Removes all hotspots
*/
clearHotspots();
}
export { CompassPlugin, CompassPluginHotspot, CompassPluginOptions };