@cn-map/gaode-react 0.0.0-stage → 0.0.1

package/dist/loca.d.ts

@@ -0,0 +1,254 @@
+import { FC, PropsWithChildren, Ref } from "react";
+import { MapEventProps, Nullable } from "@cn-map/gaode-shared/types";
+interface LayerExtraInitOptions<Properties = any> {
+  /**
+   * 数据源
+   */
+  source?: Nullable<Loca.GeoJSONSource<Properties> | Loca.GeoBufferSource<Properties>>;
+  /**
+   * 淡入淡出效果
+   */
+  duration?: {
+    /**
+     * 淡入效果，单位毫秒
+     * - 图层将会按照设置的时间将透明度从 0 过渡到 `opacity` 设置的值
+     */
+    show?: number;
+    /**
+     * 淡出效果，单位毫秒
+     * - 图层将会按照设置的时间将透明度从 `opacity` 的值过渡到 0
+     */
+    hide?: number;
+  };
+  /**
+   * 完全显示之后执行的回调函数
+   */
+  onShow?: () => void;
+  /**
+   * 完全隐藏之后执行的回调函数
+   */
+  onHide?: () => void;
+}
+type GridLayerEvents<Properties = any> = MapEventProps<Loca.GridLayerEventType, Loca.GridLayer<Properties>>;
+interface GridLayerExtraInitProps<Properties = any> extends LayerExtraInitOptions<Properties> {
+  /**
+   * 图层的样式
+   */
+  style?: Loca.GridLayerStyle<Properties>;
+}
+type GridLayerInitOptions<Properties = any> = Loca.GridLayerOptions & GridLayerExtraInitProps<Properties>;
+type GridLayerProps<Properties = any> = GridLayerInitOptions<Properties> & GridLayerEvents & {
+  ref?: Ref<Nullable<Loca.GridLayer<Properties>>>;
+};
+declare const GridLayer: <Properties = any>({ ref, map, loca: _loca, source: _source, ...props }: GridLayerProps<Properties>) => null;
+type HeatMapLayerEvents<Properties = any> = MapEventProps<Loca.HeatMapLayerEventType, Loca.HeatMapLayer<Properties>>;
+interface HeatMapLayerExtraInitProps<Properties = any> extends LayerExtraInitOptions<Properties> {
+  /**
+   * 图层的样式
+   */
+  style?: Loca.HeatMapLayerStyle<Properties>;
+}
+type HeatMapLayerInitOptions<Properties = any> = Loca.HeatMapLayerOptions & HeatMapLayerExtraInitProps<Properties>;
+type HeatMapLayerProps<Properties = any> = HeatMapLayerInitOptions<Properties> & HeatMapLayerEvents & {
+  ref?: Ref<Nullable<Loca.HeatMapLayer<Properties>>>;
+};
+declare const HeatMapLayer: <Properties = any>({ ref, map, loca: _loca, source: _source, ...props }: HeatMapLayerProps<Properties>) => null;
+type HexagonLayerEvents<Properties = any> = MapEventProps<Loca.HexagonLayerEventType, Loca.HexagonLayer<Properties>>;
+interface HexagonLayerExtraInitProps<Properties = any> extends LayerExtraInitOptions<Properties> {
+  /**
+   * 图层的样式
+   */
+  style?: Loca.HexagonLayerStyle<Properties>;
+}
+type HexagonLayerInitOptions<Properties = any> = Loca.HexagonLayerOptions & HexagonLayerExtraInitProps<Properties>;
+type HexagonLayerProps<Properties = any> = HexagonLayerInitOptions<Properties> & HexagonLayerEvents & {
+  ref?: Ref<Nullable<Loca.HexagonLayer<Properties>>>;
+};
+declare const HexagonLayer: <Properties = any>({ ref, map, loca: _loca, source: _source, ...props }: HexagonLayerProps<Properties>) => null;
+type IconLayerEvents = MapEventProps<Loca.IconLayerEventType, Loca.IconLayer>;
+interface IconLayerExtraInitProps<Properties = any> extends LayerExtraInitOptions<Properties> {
+  /**
+   * 图层的样式
+   */
+  style?: Loca.IconLayerStyle<Properties>;
+}
+type IconLayerInitOptions<Properties = any> = Loca.IconLayerOptions & IconLayerExtraInitProps<Properties>;
+type IconLayerProps<Properties = any> = IconLayerInitOptions<Properties> & IconLayerEvents & {
+  ref?: Ref<Nullable<Loca.IconLayer<Properties>>>;
+};
+declare const IconLayer: <Properties = any>({ ref, map, loca: _loca, source: _source, ...props }: IconLayerProps<Properties>) => null;
+type LabelsLayerEvents = MapEventProps<Loca.LabelsLayerEventType, Loca.LabelsLayer>;
+interface LabelsLayerExtraInitProps<Properties = any> extends LayerExtraInitOptions<Properties> {
+  /**
+   * 图层的样式
+   */
+  style?: Loca.LabelsLayerStyle<Properties>;
+}
+type LabelsLayerInitOptions<Properties = any> = Loca.LabelsLayerOptions & LabelsLayerExtraInitProps<Properties>;
+type LabelsLayerProps<Properties = any> = LabelsLayerInitOptions<Properties> & LabelsLayerEvents & {
+  ref?: Ref<Nullable<Loca.LabelsLayer<Properties>>>;
+};
+declare const LabelsLayer: <Properties = any>({ ref, map, loca: _loca, source: _source, ...props }: LabelsLayerProps<Properties>) => null;
+type LaserLayerEvents = MapEventProps<Loca.LaserLayerEventType, Loca.LaserLayer>;
+interface LaserLayerExtraInitProps<Properties = any> extends LayerExtraInitOptions<Properties> {
+  /**
+   * 图层的样式
+   */
+  style?: Loca.LaserLayerStyle<Properties>;
+}
+type LaserLayerInitOptions<Properties = any> = Loca.LaserLayerOptions & LaserLayerExtraInitProps<Properties>;
+type LaserLayerProps<Properties = any> = LaserLayerInitOptions<Properties> & LaserLayerEvents & {
+  ref?: Ref<Nullable<Loca.LaserLayer<Properties>>>;
+};
+declare const LaserLayer: <Properties = any>({ ref, map, loca: _loca, source: _source, ...props }: LaserLayerProps<Properties>) => null;
+type LineLayerEvents<Properties = any> = MapEventProps<Loca.LineLayerEventType, Loca.LineLayer<Properties>>;
+interface LineLayerExtraInitProps<Properties = any> extends LayerExtraInitOptions<Properties> {
+  /**
+   * 图层的样式
+   */
+  style?: Loca.LineLayerStyle<Properties>;
+}
+type LineLayerInitOptions<Properties = any> = Loca.LineLayerOptions & LineLayerExtraInitProps<Properties>;
+type LineLayerProps<Properties = any> = LineLayerInitOptions<Properties> & LineLayerEvents & {
+  ref?: Ref<Nullable<Loca.LineLayer<Properties>>>;
+};
+declare const LineLayer: <Properties = any>({ ref, map, loca: _loca, source: _source, ...props }: LineLayerProps<Properties>) => null;
+type LinkLayerEvents<Properties = any> = MapEventProps<Loca.LinkLayerEventType, Loca.LinkLayer<Properties>>;
+interface LinkLayerExtraInitProps<Properties = any> extends LayerExtraInitOptions<Properties> {
+  /**
+   * 图层的样式
+   */
+  style?: Loca.LinkLayerStyle<Properties>;
+}
+type LinkLayerInitOptions<Properties = any> = Loca.LinkLayerOptions & LinkLayerExtraInitProps<Properties>;
+type LinkLayerProps<Properties = any> = LinkLayerInitOptions<Properties> & LinkLayerEvents & {
+  ref?: Ref<Nullable<Loca.LinkLayer<Properties>>>;
+};
+declare const LinkLayer: <Properties = any>({ ref, map, loca: _loca, source: _source, ...props }: LinkLayerProps<Properties>) => null;
+type PointLayerEvents = MapEventProps<Loca.PointLayerEventType, Loca.PointLayer>;
+interface PointLayerExtraInitProps<Properties = any> extends LayerExtraInitOptions<Properties> {
+  /**
+   * 图层的样式
+   */
+  style?: Loca.PointLayerStyle<Properties>;
+}
+type PointLayerInitOptions<Properties = any> = Loca.PointLayerOptions & PointLayerExtraInitProps<Properties>;
+type PointLayerProps<Properties = any> = PointLayerInitOptions<Properties> & PointLayerEvents & {
+  ref?: Ref<Nullable<Loca.PointLayer<Properties>>>;
+};
+declare const PointLayer: <Properties = any>({ ref, map, loca: _loca, source: _source, ...props }: PointLayerProps<Properties>) => null;
+type PolygonLayerEvents<Properties = any> = MapEventProps<Loca.PolygonLayerEventType, Loca.PolygonLayer<Properties>>;
+interface PolygonLayerExtraInitProps<Properties = any> extends LayerExtraInitOptions<Properties> {
+  /**
+   * 图层的样式
+   */
+  style?: Loca.PolygonLayerStyle<Properties>;
+}
+type PolygonLayerInitOptions<Properties = any> = Loca.PolygonLayerOptions & PolygonLayerExtraInitProps<Properties>;
+type PolygonLayerProps<Properties = any> = PolygonLayerInitOptions<Properties> & PolygonLayerEvents & {
+  ref?: Ref<Nullable<Loca.PolygonLayer<Properties>>>;
+};
+declare const PolygonLayer: <Properties = any>({ ref, map, loca: _loca, source: _source, ...props }: PolygonLayerProps<Properties>) => null;
+type PrismLayerEvents = MapEventProps<Loca.PrismLayerEventType, Loca.PrismLayer>;
+interface PrismLayerExtraInitProps<Properties = any> extends LayerExtraInitOptions<Properties> {
+  /**
+   * 图层的样式
+   */
+  style?: Loca.PrismLayerStyle<Properties>;
+}
+type PrismLayerInitOptions<Properties = any> = Loca.PrismLayerOptions & PrismLayerExtraInitProps<Properties>;
+type PrismLayerProps<Properties = any> = PrismLayerInitOptions<Properties> & PrismLayerEvents & {
+  ref?: Ref<Nullable<Loca.PrismLayer<Properties>>>;
+};
+declare const PrismLayer: <Properties = any>({ ref, map, loca: _loca, source: _source, ...props }: PrismLayerProps<Properties>) => null;
+type PulseLineLayerEvents<Properties = any> = MapEventProps<Loca.PulseLineLayerEventType, Loca.PulseLineLayer<Properties>>;
+interface PulseLineLayerExtraInitProps<Properties = any> extends LayerExtraInitOptions<Properties> {
+  /**
+   * 图层的样式
+   */
+  style?: Loca.PulseLineLayerStyle<Properties>;
+}
+type PulseLineLayerInitOptions<Properties = any> = Loca.PulseLineLayerOptions & PulseLineLayerExtraInitProps<Properties>;
+type PulseLineLayerProps<Properties = any> = PulseLineLayerInitOptions<Properties> & PulseLineLayerEvents & {
+  ref?: Ref<Nullable<Loca.PulseLineLayer<Properties>>>;
+};
+declare const PulseLineLayer: <Properties = any>({ ref, map, loca: _loca, source: _source, ...props }: PulseLineLayerProps<Properties>) => null;
+type PulseLinkLayerEvents<Properties = any> = MapEventProps<Loca.PulseLinkLayerEventType, Loca.PulseLinkLayer<Properties>>;
+interface PulseLinkLayerExtraInitProps<Properties = any> extends LayerExtraInitOptions<Properties> {
+  /**
+   * 图层的样式
+   */
+  style?: Loca.PulseLinkLayerStyle<Properties>;
+}
+type PulseLinkLayerInitOptions<Properties = any> = Loca.PulseLinkLayerOptions & PulseLinkLayerExtraInitProps<Properties>;
+type PulseLinkLayerProps<Properties = any> = PulseLinkLayerInitOptions<Properties> & PulseLinkLayerEvents & {
+  ref?: Ref<Nullable<Loca.PulseLinkLayer<Properties>>>;
+};
+declare const PulseLinkLayer: <Properties = any>({ ref, map, loca: _loca, source: _source, ...props }: PulseLinkLayerProps<Properties>) => null;
+type ScatterLayerEvents<Properties = any> = MapEventProps<Loca.ScatterLayerEventType, Loca.ScatterLayer<Properties>>;
+interface ScatterLayerExtraInitProps<Properties = any> extends LayerExtraInitOptions<Properties> {
+  /**
+   * 图层的样式
+   */
+  style?: Loca.ScatterLayerStyle<Properties>;
+}
+type ScatterLayerInitOptions<Properties = any> = Loca.ScatterLayerOptions & ScatterLayerExtraInitProps<Properties>;
+type ScatterLayerProps<Properties = any> = ScatterLayerInitOptions<Properties> & ScatterLayerEvents & {
+  ref?: Ref<Nullable<Loca.ScatterLayer<Properties>>>;
+};
+declare const ScatterLayer: <Properties = any>({ ref, map, loca: _loca, source: _source, ...props }: ScatterLayerProps<Properties>) => null;
+type ZMarkerLayerEvents<Properties = any> = MapEventProps<Loca.ZMarkerLayerEventType, Loca.ZMarkerLayer<Properties>>;
+interface ZMarkerLayerExtraInitProps<Properties = any> extends LayerExtraInitOptions<Properties> {
+  /**
+   * 图层的样式
+   */
+  style?: Loca.ZMarkerLayerStyle<Properties>;
+}
+type ZMarkerLayerInitOptions<Properties = any> = Loca.ZMarkerLayerOptions & ZMarkerLayerExtraInitProps<Properties>;
+type ZMarkerLayerProps<Properties = any> = ZMarkerLayerInitOptions<Properties> & ZMarkerLayerEvents & {
+  ref?: Ref<Nullable<Loca.ZMarkerLayer<Properties>>>;
+};
+declare const ZMarkerLayer: <Properties = any>({ ref, map, loca: _loca, source: _source, ...props }: ZMarkerLayerProps<Properties>) => null;
+type LegendProps = Loca.LegendOptions & {
+  ref?: Ref<Loca.Legend>;
+};
+declare const Legend: FC<LegendProps>;
+interface LightProps {
+  loca?: Loca.Container;
+}
+type AmbientLightProps = Loca.AmbientLightProperty & LightProps & {
+  ref?: Ref<Loca.AmbientLight>;
+};
+declare const AmbientLight: FC<AmbientLightProps>;
+type DirectionalLightProps = Loca.DirectionalLightProperty & LightProps & {
+  ref?: Ref<Loca.DirectionalLight>;
+};
+declare const DirectionalLight: FC<DirectionalLightProps>;
+type PointLightProps = Loca.PointLightProperty & LightProps & {
+  ref?: Ref<Loca.PointLight>;
+};
+declare const PointLight: FC<PointLightProps>;
+/**
+ * 获取 Loca 容器实例 hook
+ */
+export declare function useLoca(): Nullable<Loca.Container>;
+type LocaProps = PropsWithChildren<Omit<Loca.LocaOptions, "map"> & Partial<Pick<Loca.LocaOptions, "map">> & {
+  ref?: Ref<Nullable<Loca.Container>>;
+}>;
+declare const Container: FC<LocaProps>;
+/**
+ * 获取 Loca 数据源实例 hook
+ */
+export declare function useDataSource(): Loca.GeoBufferSource | Loca.GeoJSONSource;
+type DataSourceProps = PropsWithChildren<{
+  layer?: Loca.Layer;
+}>;
+type GeoBufferSourceProps = Loca.GeoBufferSourceOptions & DataSourceProps & {
+  ref?: Ref<Loca.GeoBufferSource>;
+};
+declare const GeoBufferSource: FC<GeoBufferSourceProps>;
+type GeoJSONSourceProps = Loca.GeoJSONSourceOptions & DataSourceProps & {
+  ref?: Ref<Loca.GeoJSONSource>;
+};
+declare const GeoJSONSource: FC<GeoJSONSourceProps>;
+export { AmbientLight, type AmbientLightProps, DirectionalLight, type DirectionalLightProps, GeoBufferSource, type GeoBufferSourceProps, GeoJSONSource, type GeoJSONSourceProps, GridLayer, type GridLayerProps, HeatMapLayer, type HeatMapLayerProps, HexagonLayer, type HexagonLayerProps, IconLayer, type IconLayerProps, LabelsLayer, type LabelsLayerProps, LaserLayer, type LaserLayerProps, Legend, type LegendProps, LineLayer, type LineLayerProps, LinkLayer, type LinkLayerProps, Container as Loca, type LocaProps, PointLayer, type PointLayerProps, PointLight, type PointLightProps, PolygonLayer, type PolygonLayerProps, PrismLayer, type PrismLayerProps, PulseLineLayer, type PulseLineLayerProps, PulseLinkLayer, type PulseLinkLayerProps, ScatterLayer, type ScatterLayerProps, ZMarkerLayer, type ZMarkerLayerProps };