vue-cesium
Version:
Vue 3.x components for CesiumJS.
69 lines (68 loc) • 3.12 kB
TypeScript
import type { PropType } from 'vue';
import { VcComponentInternalInstance, VcComponentPublicInstance, VcReadyObject } from 'vue-cesium/es/utils/types';
export declare const ionImageryProviderProps: {};
declare const _default: import("vue").DefineComponent<{
server: PropType<string | Cesium.Resource>;
accessToken: StringConstructor;
assetId: NumberConstructor;
}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
errorEvent: (evt: Cesium.TileProviderError) => boolean;
readyPromise: (evt: boolean | import("vue-cesium/es/utils/types").VcImageryProvider | import("vue-cesium/es/utils/types").VcTerrainProvider, viewer: Cesium.Viewer, instance: VcComponentPublicInstance) => 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<{
server: PropType<string | Cesium.Resource>;
accessToken: StringConstructor;
assetId: NumberConstructor;
}>> & {
onBeforeLoad?: (instance: VcComponentInternalInstance) => any;
onReady?: (readyObj: VcReadyObject) => any;
onUnready?: (e: any) => any;
onDestroyed?: (instance: VcComponentInternalInstance) => any;
onReadyPromise?: (evt: boolean | import("vue-cesium/es/utils/types").VcImageryProvider | import("vue-cesium/es/utils/types").VcTerrainProvider, viewer: Cesium.Viewer, instance: VcComponentPublicInstance) => any;
onErrorEvent?: (evt: Cesium.TileProviderError) => any;
}, {}>;
export default _default;
export type VcImageryProviderIonProps = {
/**
* An ion imagery asset ID.
*/
assetId: number;
/**
* The access token to use.
*/
accessToken?: string;
/**
* The resource to the Cesium ion API server.
*/
server?: string | Cesium.Resource;
/**
* Triggers before the VcImageryProviderArcgis is loaded.
*/
onBeforeLoad?: (instance: VcComponentInternalInstance) => void;
/**
* Triggers when the VcImageryProviderArcgis is successfully loaded.
*/
onReady?: (readyObject: VcReadyObject) => void;
/**
* Triggers when the component load failed.
*/
onUnready?: (e: any) => void;
/**
* Triggers when the VcImageryProviderArcgis is destroyed.
*/
onDestroyed?: (instance: VcComponentInternalInstance) => void;
/**
* Triggers when the imagery provider encounters an asynchronous error.
*/
onErrorEvent?: (evt: Cesium.TileProviderError) => void;
/**
* Triggers when the provider is ready for use.
*/
onReadyPromise?: (evt: boolean, viewer: Cesium.Viewer, instance: VcComponentPublicInstance) => void;
};
export type VcImageryProviderIonRef = VcComponentPublicInstance<VcImageryProviderIonProps>;