vue-cesium
Version:
Vue 3.x components for CesiumJS.
259 lines (258 loc) • 7.26 kB
TypeScript
import type { VNode, PropType } from 'vue';
import type { VcBtnTooltipProps, VcColor, VcComponentInternalInstance, VcComponentPublicInstance, VcReadyObject } from 'vue-cesium/es/utils/types';
import { VcViewerProps } from 'vue-cesium/es/components/viewer';
export declare const overviewProps: {
position: {
type: PropType<"top-right" | "top-left" | "bottom-right" | "bottom-left">;
default: string;
validator: (v: string) => boolean;
};
offset: {
type: ArrayConstructor;
validator: (v: Array<string>) => boolean;
};
width: {
type: StringConstructor;
default: string;
};
height: {
type: StringConstructor;
default: string;
};
border: {
type: StringConstructor;
default: string;
};
borderRadius: {
type: StringConstructor;
};
toggleOpts: {
type: PropType<VcBtnTooltipProps>;
};
viewerOpts: {
type: PropType<VcViewerProps>;
};
centerRectColor: {
type: PropType<VcColor>;
default: string;
};
widthFactor: {
type: NumberConstructor;
default: number;
};
heightFactor: {
type: NumberConstructor;
default: number;
};
modelValue: {
type: BooleanConstructor;
default: boolean;
};
};
declare const _default: import("vue").DefineComponent<{
position: {
type: PropType<"top-right" | "top-left" | "bottom-right" | "bottom-left">;
default: string;
validator: (v: string) => boolean;
};
offset: {
type: ArrayConstructor;
validator: (v: string[]) => boolean;
};
width: {
type: StringConstructor;
default: string;
};
height: {
type: StringConstructor;
default: string;
};
border: {
type: StringConstructor;
default: string;
};
borderRadius: {
type: StringConstructor;
};
toggleOpts: {
type: PropType<VcBtnTooltipProps>;
};
viewerOpts: {
type: PropType<VcViewerProps>;
};
centerRectColor: {
type: PropType<VcColor>;
default: string;
};
widthFactor: {
type: NumberConstructor;
default: number;
};
heightFactor: {
type: NumberConstructor;
default: number;
};
modelValue: {
type: BooleanConstructor;
default: boolean;
};
}, () => VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
'update:modelValue': (value: boolean) => boolean;
beforeLoad: (instance: VcComponentInternalInstance) => boolean;
ready: (readyObj: VcReadyObject) => boolean;
unready: (e: any) => boolean;
destroyed: (instance: VcComponentInternalInstance) => boolean;
}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
position: {
type: PropType<"top-right" | "top-left" | "bottom-right" | "bottom-left">;
default: string;
validator: (v: string) => boolean;
};
offset: {
type: ArrayConstructor;
validator: (v: string[]) => boolean;
};
width: {
type: StringConstructor;
default: string;
};
height: {
type: StringConstructor;
default: string;
};
border: {
type: StringConstructor;
default: string;
};
borderRadius: {
type: StringConstructor;
};
toggleOpts: {
type: PropType<VcBtnTooltipProps>;
};
viewerOpts: {
type: PropType<VcViewerProps>;
};
centerRectColor: {
type: PropType<VcColor>;
default: string;
};
widthFactor: {
type: NumberConstructor;
default: number;
};
heightFactor: {
type: NumberConstructor;
default: number;
};
modelValue: {
type: BooleanConstructor;
default: boolean;
};
}>> & {
onBeforeLoad?: (instance: VcComponentInternalInstance) => any;
onReady?: (readyObj: VcReadyObject) => any;
onUnready?: (e: any) => any;
onDestroyed?: (instance: VcComponentInternalInstance) => any;
"onUpdate:modelValue"?: (value: boolean) => any;
}, {
height: string;
position: "top-right" | "top-left" | "bottom-right" | "bottom-left";
modelValue: boolean;
border: string;
width: string;
centerRectColor: VcColor;
widthFactor: number;
heightFactor: number;
}>;
export default _default;
export type VcOverviewMapProps = {
/**
* Specify the position of the VcOverviewMap.
* Default value: bottom-right
*/
position?: 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left' | 'top' | 'right' | 'bottom' | 'left';
/**
* An array of two numbers to offset the VcOverviewMap horizontally and vertically in pixels.
* Default value: [0, 0]
*/
offset?: [number, number];
/**
* Specify the width of the overviewmap component.
* Default value: 150px
*/
width?: string;
/**
* Specify the height of the overviewmap component.
* Default value: 150px
*/
height?: string;
/**
* Specify the border of the overviewmap component.
* Default value: solid 4px rgb(255, 255, 255)
*/
border?: string;
/**
* Specify the border radius of the overviewmap component.
*/
borderRadius?: string;
/**
* Specify the toggle button options of the overviewmap component.
*/
toggleOpts?: VcBtnTooltipProps;
/**
* Specify the vc-viewer component options in the overviewmap component.
*/
viewerOpts?: VcViewerProps;
/**
* Specify the center rectangle color.
* Default value: #ff000080
*/
centerRectColor?: VcColor;
/**
* Specify the width factor of center rectangle.
* Default value: 2
*/
widthFactor?: number;
/**
* Specify the height factor of center rectangle.
* Default value: 2
*/
heightFactor?: number;
/**
* Model of the component determining if VcOverviewMap should be expanded or not.
* Default value: true
*/
modelValue?: boolean;
/**
* Triggers before the VcOverviewMap is loaded.
* @param instance
*/
onBeforeLoad?: (instance: VcComponentInternalInstance) => void;
/**
* Triggers when the VcOverviewMap is successfully loaded.
*/
onReady?: (readyObject: VcReadyObject) => void;
/**
* Triggers when the component load failed.
*/
onUnready?: (e: any) => void;
/**
* Triggers when the VcOverviewMap is destroyed.
*/
onDestroyed?: (instance: VcComponentInternalInstance) => void;
/**
* Emitted when showing/hidden state changes; Is also used by v-model.
* @param value New state (showing/hidden)
*/
'onUpdate:modelValue'?: (value: boolean) => void;
};
export interface VcOverviewMapSlots {
/**
* Default slot content of the component
*/
default: () => VNode[];
}
export type VcOverviewMapRef = VcComponentPublicInstance<VcOverviewMapProps>;