vue-cesium
Version:
Vue 3.x components for CesiumJS.
187 lines (186 loc) • 6.81 kB
TypeScript
import { PropType, VNode } from 'vue';
import type { VcColor, VcComponentInternalInstance, VcComponentPublicInstance, VcPickEvent, VcReadyObject } from 'vue-cesium/es/utils/types';
export declare const osmBuildingsProps: {
enableMouseEvent: {
type: BooleanConstructor;
default: boolean;
};
enableShowOutline: {
type: BooleanConstructor;
default: boolean;
};
showOutline: {
type: BooleanConstructor;
default: boolean;
};
tileStyle: {
type: PropType<Cesium.Cesium3DTileStyle>;
};
defaultColor: {
type: PropType<VcColor>;
watcherOptions: {
cesiumObjectBuilder: typeof import("vue-cesium/es/utils/cesium-helpers").makeColor;
};
};
};
declare const _default: import("vue").DefineComponent<{
enableMouseEvent: {
type: BooleanConstructor;
default: boolean;
};
enableShowOutline: {
type: BooleanConstructor;
default: boolean;
};
showOutline: {
type: BooleanConstructor;
default: boolean;
};
tileStyle: {
type: PropType<Cesium.Cesium3DTileStyle>;
};
defaultColor: {
type: PropType<VcColor>;
watcherOptions: {
cesiumObjectBuilder: typeof import("vue-cesium/es/utils/cesium-helpers").makeColor;
};
};
}, () => VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
readyPromise: (primitive: import("vue-cesium/es/utils/types").VcPrimitive, viewer: Cesium.Viewer, instance: VcComponentPublicInstance) => boolean;
'update:geometryInstances': (instances: Cesium.GeometryInstance[]) => boolean;
mousedown: (evt: VcPickEvent) => boolean;
mouseup: (evt: VcPickEvent) => boolean;
click: (evt: VcPickEvent) => boolean;
clickout: (evt: VcPickEvent) => boolean;
dblclick: (evt: VcPickEvent) => boolean;
mousemove: (evt: VcPickEvent) => boolean;
mouseover: (evt: VcPickEvent) => boolean;
mouseout: (evt: VcPickEvent) => 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<{
enableMouseEvent: {
type: BooleanConstructor;
default: boolean;
};
enableShowOutline: {
type: BooleanConstructor;
default: boolean;
};
showOutline: {
type: BooleanConstructor;
default: boolean;
};
tileStyle: {
type: PropType<Cesium.Cesium3DTileStyle>;
};
defaultColor: {
type: PropType<VcColor>;
watcherOptions: {
cesiumObjectBuilder: typeof import("vue-cesium/es/utils/cesium-helpers").makeColor;
};
};
}>> & {
onBeforeLoad?: (instance: VcComponentInternalInstance) => any;
onReady?: (readyObj: VcReadyObject) => any;
onUnready?: (e: any) => any;
onDestroyed?: (instance: VcComponentInternalInstance) => any;
onMousedown?: (evt: VcPickEvent) => any;
onMouseup?: (evt: VcPickEvent) => any;
onClick?: (evt: VcPickEvent) => any;
onClickout?: (evt: VcPickEvent) => any;
onDblclick?: (evt: VcPickEvent) => any;
onMousemove?: (evt: VcPickEvent) => any;
onMouseover?: (evt: VcPickEvent) => any;
onMouseout?: (evt: VcPickEvent) => any;
onReadyPromise?: (primitive: import("vue-cesium/es/utils/types").VcPrimitive, viewer: Cesium.Viewer, instance: VcComponentPublicInstance) => any;
"onUpdate:geometryInstances"?: (instances: Cesium.GeometryInstance[]) => any;
}, {
enableMouseEvent: boolean;
showOutline: boolean;
enableShowOutline: boolean;
}>;
export default _default;
export type VcPrimitiveOsmBuildingsProps = {
/**
* The default color to use for buildings that do not have a color. This parameter is ignored if options.style is specified.
* Default value: white
*/
defaultColor?: VcColor;
/**
* The style to use with the tileset. If not specified, a default style is used which gives each building or building part a color inferred from its OpenStreetMap tags. If no color can be inferred, options.defaultColor is used.
*/
tileStyle?: Cesium.Cesium3DTileStyle;
/**
* If true, enable rendering outlines. This can be set to false to avoid the additional processing of geometry at load time.
* Default value: true
*/
enableShowOutline?: boolean;
/**
* Whether to show outlines around buildings. When true, outlines are displayed. When false, outlines are not displayed.
* Default value: true
*/
showOutline?: boolean;
/**
* Specifies whether to respond to mouse pick events.
* Default Value: true
*/
enableMouseEvent?: boolean;
/**
* Triggers before the component is loaded.
*/
onBeforeLoad?: (instance: VcComponentInternalInstance) => void;
/**
* Triggers when the component is successfully loaded.
*/
onReady?: (readyObject: VcReadyObject) => void;
/**
* Triggers when the component load failed.
*/
onUnready?: (e: any) => void;
/**
* Triggers when the component is destroyed.
*/
onDestroyed?: (instance: VcComponentInternalInstance) => void;
/**
* Triggers when the mouse is pressed on this primitive.
*/
onMousedown?: (evt: VcPickEvent) => void;
/**
* Triggers when the mouse bounces up on this primitive.
*/
onMouseup?: (evt: VcPickEvent) => void;
/**
* Triggers when the mouse clicks on this primitive.
*/
onClick?: (evt: VcPickEvent) => void;
/**
* Triggers when the mouse clicks outside this primitive.
*/
onClickout?: (evt: VcPickEvent) => void;
/**
* Triggers when the left mouse button double-clicks this primitive.
*/
onDblclick?: (evt: VcPickEvent) => void;
/**
* Triggers when the mouse moves on this primitive.
*/
onMousemove?: (evt: VcPickEvent) => void;
/**
* Triggers when the mouse moves over to this primitive.
*/
onMouseover?: (evt: VcPickEvent) => void;
/**
* Triggers when the mouse moves out of this primitive.
*/
onMouseout?: (evt: VcPickEvent) => void;
/**
* Triggers when the primitive is ready to render.
*/
onReadyPromise?: (primitive: Cesium.Primitive, viewer: Cesium.Viewer, instance: VcComponentPublicInstance) => void;
};
export type VcPrimitiveOsmBuildingsRef = VcComponentPublicInstance<VcPrimitiveOsmBuildingsProps>;