terriajs-plugin-sample - npm Package Compare versions

Comparing version 0.0.1-alpha.1 to 0.0.1-alpha.3

dist/BoxDrawingCatalogItem.d.ts

@@ -1,596 +0,9 @@
-/// <reference types="react" />
-import { Matrix4, Rectangle } from "terriajs-cesium";
-import { BoxDrawing, MapItem } from "terriajs-plugin-api";
-import BoxDrawingCatalogItemTraits from "./Traits/BoxDrawingCatalogItemTraits";
-declare const BoxDrawingCatalogItem_base: {
-    new (...args: any[]): {
-        readonly type: string;
-        _sourceInfoItemNames: string[] | undefined;
-        readonly typeName: string | undefined;
-        _metadataLoader: import("terriajs/lib/Core/AsyncLoader").default;
-        readonly loadMetadataResult: import("terriajs/lib/Core/Result").default<void> | undefined;
-        readonly isLoadingMetadata: boolean;
-        readonly isLoading: boolean;
-        loadMetadata(): Promise<import("terriajs/lib/Core/Result").default<void>>;
-        forceLoadMetadata(): Promise<void>;
-        readonly hasCatalogMemberMixin: boolean;
-        readonly inWorkbench: boolean;
-        readonly name: string | undefined;
-        readonly nameInCatalog: string | undefined;
-        readonly nameSortKey: import("react").ReactText[];
-        readonly hasDescription: boolean;
-        readonly infoAsObject: any;
-        readonly infoWithoutSources: readonly import("terriajs/lib/Models/Definition/Model").default<import("terriajs/lib/Traits/TraitsClasses/CatalogMemberTraits").InfoSectionTraits>[];
-        readonly selectableDimensions: import("terriajs/lib/Models/SelectableDimensions").SelectableDimension[];
-        dispose(): void;
-        _accessType: string | undefined;
-        readonly hasAccessControlMixin: boolean;
-        readonly accessType: string;
-        setAccessType(accessType: string): void;
-        readonly isPublic: boolean;
-        readonly isPrivate: boolean;
-        readonly traits: {
-            [id: string]: import("terriajs/lib/Traits/Trait").default;
-        };
-        readonly TraitsClass: import("terriajs/lib/Traits/TraitsConstructor").default<import("terriajs/lib/Traits/ModelTraits").default> & import("terriajs/lib/Traits/TraitsConstructor").default<import("terriajs-plugin-api").CatalogMemberTraits>;
-        readonly strata: Map<string, import("terriajs/lib/Core/TypeModifiers").Complete<{}>> & Map<string, import("terriajs/lib/Core/TypeModifiers").Complete<{
-            name?: string | undefined;
-            description?: string | undefined;
-            nameInCatalog?: string | undefined;
-            info: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                name?: string | undefined;
-                content?: string | null | undefined;
-                contentAsObject?: import("terriajs/lib/Core/Json").JsonObject | undefined;
-                show?: boolean | undefined;
-            }>[] | undefined;
-            infoSectionOrder?: string[] | undefined;
-            isOpenInWorkbench: boolean | undefined;
-            shortReport?: string | undefined;
-            shortReportSections?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                name?: string | undefined;
-                content?: string | undefined;
-                show: boolean | undefined;
-            }>[] | undefined;
-            isExperiencingIssues: boolean | undefined;
-            hideSource: boolean | undefined;
-            metadataUrls?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                url?: string | undefined;
-                title?: string | undefined;
-            }>[] | undefined;
-            dataUrls?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                type?: "none" | "wfs" | "wcs" | "wfs-complete" | "wcs-complete" | "direct" | undefined;
-                url?: string | undefined;
-                title?: string | undefined;
-            }>[] | undefined;
-            dataCustodian?: string | undefined;
-            modelDimensions?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                id?: string | undefined;
-                name?: string | undefined;
-                options?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                    id?: string | undefined;
-                    name?: string | undefined;
-                    value?: import("terriajs/lib/Core/Json").JsonObject | undefined;
-                }>[] | undefined;
-                selectedId?: string | undefined;
-                allowUndefined?: boolean | undefined;
-                disable?: boolean | undefined;
-            }>[] | undefined;
-            disableAboutData: boolean | undefined;
-        }>>;
-        readonly terria: import("terriajs-plugin-api").Terria;
-        readonly uniqueId: string | undefined;
-        readonly knownContainerUniqueIds: string[];
-        readonly sourceReference: import("terriajs/lib/Models/Definition/Model").BaseModel | undefined;
-        readonly strataTopToBottom: ReadonlyMap<string, import("terriajs/lib/Core/TypeModifiers").Complete<{}>> & ReadonlyMap<string, import("terriajs/lib/Core/TypeModifiers").Complete<{
-            name?: string | undefined;
-            description?: string | undefined;
-            nameInCatalog?: string | undefined;
-            info: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                name?: string | undefined;
-                content?: string | null | undefined;
-                contentAsObject?: import("terriajs/lib/Core/Json").JsonObject | undefined;
-                show?: boolean | undefined;
-            }>[] | undefined;
-            infoSectionOrder?: string[] | undefined;
-            isOpenInWorkbench: boolean | undefined;
-            shortReport?: string | undefined;
-            shortReportSections?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                name?: string | undefined;
-                content?: string | undefined;
-                show: boolean | undefined;
-            }>[] | undefined;
-            isExperiencingIssues: boolean | undefined;
-            hideSource: boolean | undefined;
-            metadataUrls?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                url?: string | undefined;
-                title?: string | undefined;
-            }>[] | undefined;
-            dataUrls?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                type?: "none" | "wfs" | "wcs" | "wfs-complete" | "wcs-complete" | "direct" | undefined;
-                url?: string | undefined;
-                title?: string | undefined;
-            }>[] | undefined;
-            dataCustodian?: string | undefined;
-            modelDimensions?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                id?: string | undefined;
-                name?: string | undefined;
-                options?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                    id?: string | undefined;
-                    name?: string | undefined;
-                    value?: import("terriajs/lib/Core/Json").JsonObject | undefined;
-                }>[] | undefined;
-                selectedId?: string | undefined;
-                allowUndefined?: boolean | undefined;
-                disable?: boolean | undefined;
-            }>[] | undefined;
-            disableAboutData: boolean | undefined;
-        }>>;
-        readonly strataBottomToTop: ReadonlyMap<string, import("terriajs/lib/Core/TypeModifiers").Complete<{}>> & ReadonlyMap<string, import("terriajs/lib/Core/TypeModifiers").Complete<{
-            name?: string | undefined;
-            description?: string | undefined;
-            nameInCatalog?: string | undefined;
-            info: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                name?: string | undefined;
-                content?: string | null | undefined;
-                contentAsObject?: import("terriajs/lib/Core/Json").JsonObject | undefined;
-                show?: boolean | undefined;
-            }>[] | undefined;
-            infoSectionOrder?: string[] | undefined;
-            isOpenInWorkbench: boolean | undefined;
-            shortReport?: string | undefined;
-            shortReportSections?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                name?: string | undefined;
-                content?: string | undefined;
-                show: boolean | undefined;
-            }>[] | undefined;
-            isExperiencingIssues: boolean | undefined;
-            hideSource: boolean | undefined;
-            metadataUrls?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                url?: string | undefined;
-                title?: string | undefined;
-            }>[] | undefined;
-            dataUrls?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                type?: "none" | "wfs" | "wcs" | "wfs-complete" | "wcs-complete" | "direct" | undefined;
-                url?: string | undefined;
-                title?: string | undefined;
-            }>[] | undefined;
-            dataCustodian?: string | undefined;
-            modelDimensions?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                id?: string | undefined;
-                name?: string | undefined;
-                options?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                    id?: string | undefined;
-                    name?: string | undefined;
-                    value?: import("terriajs/lib/Core/Json").JsonObject | undefined;
-                }>[] | undefined;
-                selectedId?: string | undefined;
-                allowUndefined?: boolean | undefined;
-                disable?: boolean | undefined;
-            }>[] | undefined;
-            disableAboutData: boolean | undefined;
-        }>>;
-        duplicateModel: ((newId: string, sourceReference?: import("terriajs/lib/Models/Definition/Model").BaseModel | undefined) => any) & ((newId: string, sourceReference?: import("terriajs/lib/Models/Definition/Model").BaseModel | undefined) => any);
-        setTrait: (<Key extends never>(stratumId: string, trait: Key, value: import("terriajs/lib/Core/TypeModifiers").Complete<{}>[Key]) => void) & (<Key_1 extends "description" | "name" | "isOpenInWorkbench" | "dataCustodian" | "nameInCatalog" | "info" | "infoSectionOrder" | "shortReport" | "shortReportSections" | "isExperiencingIssues" | "hideSource" | "metadataUrls" | "dataUrls" | "modelDimensions" | "disableAboutData">(stratumId: string, trait: Key_1, value: import("terriajs/lib/Core/TypeModifiers").Complete<{
-            name?: string | undefined;
-            description?: string | undefined;
-            nameInCatalog?: string | undefined;
-            info: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                name?: string | undefined;
-                content?: string | null | undefined;
-                contentAsObject?: import("terriajs/lib/Core/Json").JsonObject | undefined;
-                show?: boolean | undefined;
-            }>[] | undefined;
-            infoSectionOrder?: string[] | undefined;
-            isOpenInWorkbench: boolean | undefined;
-            shortReport?: string | undefined;
-            shortReportSections?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                name?: string | undefined;
-                content?: string | undefined;
-                show: boolean | undefined;
-            }>[] | undefined;
-            isExperiencingIssues: boolean | undefined;
-            hideSource: boolean | undefined;
-            metadataUrls?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                url?: string | undefined;
-                title?: string | undefined;
-            }>[] | undefined;
-            dataUrls?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                type?: "none" | "wfs" | "wcs" | "wfs-complete" | "wcs-complete" | "direct" | undefined;
-                url?: string | undefined;
-                title?: string | undefined;
-            }>[] | undefined;
-            dataCustodian?: string | undefined;
-            modelDimensions?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                id?: string | undefined;
-                name?: string | undefined;
-                options?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                    id?: string | undefined;
-                    name?: string | undefined;
-                    value?: import("terriajs/lib/Core/Json").JsonObject | undefined;
-                }>[] | undefined;
-                selectedId?: string | undefined;
-                allowUndefined?: boolean | undefined;
-                disable?: boolean | undefined;
-            }>[] | undefined;
-            disableAboutData: boolean | undefined;
-        }>[Key_1]) => void);
-        getTrait: (<Key_2 extends never>(stratumId: string, trait: Key_2) => import("terriajs/lib/Core/TypeModifiers").Complete<{}>[Key_2]) & (<Key_3 extends "description" | "name" | "isOpenInWorkbench" | "dataCustodian" | "nameInCatalog" | "info" | "infoSectionOrder" | "shortReport" | "shortReportSections" | "isExperiencingIssues" | "hideSource" | "metadataUrls" | "dataUrls" | "modelDimensions" | "disableAboutData">(stratumId: string, trait: Key_3) => import("terriajs/lib/Core/TypeModifiers").Complete<{
-            name?: string | undefined;
-            description?: string | undefined;
-            nameInCatalog?: string | undefined;
-            info: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                name?: string | undefined;
-                content?: string | null | undefined;
-                contentAsObject?: import("terriajs/lib/Core/Json").JsonObject | undefined;
-                show?: boolean | undefined;
-            }>[] | undefined;
-            infoSectionOrder?: string[] | undefined;
-            isOpenInWorkbench: boolean | undefined;
-            shortReport?: string | undefined;
-            shortReportSections?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                name?: string | undefined;
-                content?: string | undefined;
-                show: boolean | undefined;
-            }>[] | undefined;
-            isExperiencingIssues: boolean | undefined;
-            hideSource: boolean | undefined;
-            metadataUrls?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                url?: string | undefined;
-                title?: string | undefined;
-            }>[] | undefined;
-            dataUrls?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                type?: "none" | "wfs" | "wcs" | "wfs-complete" | "wcs-complete" | "direct" | undefined;
-                url?: string | undefined;
-                title?: string | undefined;
-            }>[] | undefined;
-            dataCustodian?: string | undefined;
-            modelDimensions?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                id?: string | undefined;
-                name?: string | undefined;
-                options?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                    id?: string | undefined;
-                    name?: string | undefined;
-                    value?: import("terriajs/lib/Core/Json").JsonObject | undefined;
-                }>[] | undefined;
-                selectedId?: string | undefined;
-                allowUndefined?: boolean | undefined;
-                disable?: boolean | undefined;
-            }>[] | undefined;
-            disableAboutData: boolean | undefined;
-        }>[Key_3]);
-        addObject: (<Key_4 extends never>(stratumId: string, trait: Key_4, objectId: string) => import("terriajs/lib/Models/Definition/Model").default<import("terriajs/lib/Models/Definition/Model").ArrayElementTypes<import("terriajs/lib/Traits/ModelTraits").default>[Key_4]> | undefined) & (<Key_5 extends "description" | "name" | "isOpenInWorkbench" | "dataCustodian" | "nameInCatalog" | "info" | "infoSectionOrder" | "shortReport" | "shortReportSections" | "isExperiencingIssues" | "hideSource" | "metadataUrls" | "dataUrls" | "modelDimensions" | "disableAboutData">(stratumId: string, trait: Key_5, objectId: string) => import("terriajs/lib/Models/Definition/Model").default<import("terriajs/lib/Models/Definition/Model").ArrayElementTypes<import("terriajs-plugin-api").CatalogMemberTraits>[Key_5]> | undefined);
-        readonly description: string | undefined;
-        readonly info: readonly import("terriajs/lib/Models/Definition/Model").default<import("terriajs/lib/Traits/TraitsClasses/CatalogMemberTraits").InfoSectionTraits>[];
-        readonly infoSectionOrder: readonly string[];
-        readonly isOpenInWorkbench: boolean;
-        readonly shortReport: string | undefined;
-        readonly shortReportSections: readonly import("terriajs/lib/Models/Definition/Model").default<import("terriajs/lib/Traits/TraitsClasses/CatalogMemberTraits").ShortReportTraits>[];
-        readonly isExperiencingIssues: boolean;
-        readonly hideSource: boolean;
-        readonly metadataUrls: readonly import("terriajs/lib/Models/Definition/Model").default<import("terriajs/lib/Traits/TraitsClasses/CatalogMemberTraits").MetadataUrlTraits>[];
-        readonly dataUrls: readonly import("terriajs/lib/Models/Definition/Model").default<import("terriajs/lib/Traits/TraitsClasses/CatalogMemberTraits").DataUrlTraits>[];
-        readonly dataCustodian: string | undefined;
-        readonly modelDimensions: readonly import("terriajs/lib/Models/Definition/Model").default<import("terriajs/lib/Traits/TraitsClasses/DimensionTraits").default>[];
-        readonly disableAboutData: boolean;
-    };
-} & {
-    new (...args: any[]): {
-        initialMessageShown: boolean;
-        readonly isMappable: boolean;
-        readonly cesiumRectangle: Rectangle | undefined;
-        readonly shouldShowInitialMessage: boolean;
-        _mapItemsLoader: import("terriajs/lib/Core/AsyncLoader").default;
-        readonly loadMapItemsResult: import("terriajs/lib/Core/Result").default<void> | undefined;
-        readonly isLoadingMapItems: boolean;
-        loadMapItems(force?: boolean | undefined): Promise<import("terriajs/lib/Core/Result").default<void>>;
-        forceLoadMapItems(): Promise<void>;
-        readonly mapItems: MapItem[];
-        showInitialMessage(): Promise<void>;
-        dispose(): void;
-        readonly type: string;
-        readonly traits: {
-            [id: string]: import("terriajs/lib/Traits/Trait").default;
-        };
-        readonly TraitsClass: import("terriajs/lib/Traits/TraitsConstructor").default<import("terriajs-plugin-api").MappableTraits>;
-        readonly strata: Map<string, import("terriajs/lib/Core/TypeModifiers").Complete<{
-            rectangle?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                west?: number | undefined;
-                south?: number | undefined;
-                east?: number | undefined;
-                north?: number | undefined;
-            }> | undefined;
-            idealZoom?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                lookAt?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                    targetLongitude?: number | undefined;
-                    targetLatitude?: number | undefined;
-                    targetHeight?: number | undefined;
-                    heading?: number | undefined;
-                    pitch?: number | undefined;
-                    range?: number | undefined;
-                }> | undefined;
-                camera?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                    position?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                        x?: number | undefined;
-                        y?: number | undefined;
-                        z?: number | undefined;
-                    }> | undefined;
-                    direction?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                        x?: number | undefined;
-                        y?: number | undefined;
-                        z?: number | undefined;
-                    }> | undefined;
-                    up?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                        x?: number | undefined;
-                        y?: number | undefined;
-                        z?: number | undefined;
-                    }> | undefined;
-                    west?: number | undefined;
-                    south?: number | undefined;
-                    east?: number | undefined;
-                    north?: number | undefined;
-                }> | undefined;
-            }> | undefined;
-            disablePreview: boolean | undefined;
-            disableZoomTo: boolean | undefined;
-            zoomOnAddToWorkbench: boolean | undefined;
-            show: boolean | undefined;
-            initialMessage?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                title?: string | undefined;
-                content?: string | undefined;
-                key?: string | undefined;
-                confirmation?: boolean | undefined;
-                confirmText?: string | undefined;
-                width?: number | undefined;
-                height?: number | undefined;
-            }> | undefined;
-            attribution?: string | undefined;
-        }>>;
-        readonly terria: import("terriajs-plugin-api").Terria;
-        readonly uniqueId: string | undefined;
-        readonly knownContainerUniqueIds: string[];
-        readonly sourceReference: import("terriajs/lib/Models/Definition/Model").BaseModel | undefined;
-        readonly strataTopToBottom: ReadonlyMap<string, import("terriajs/lib/Core/TypeModifiers").Complete<{
-            rectangle?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                west?: number | undefined;
-                south?: number | undefined;
-                east?: number | undefined;
-                north?: number | undefined;
-            }> | undefined;
-            idealZoom?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                lookAt?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                    targetLongitude?: number | undefined;
-                    targetLatitude?: number | undefined;
-                    targetHeight?: number | undefined;
-                    heading?: number | undefined;
-                    pitch?: number | undefined;
-                    range?: number | undefined;
-                }> | undefined;
-                camera?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                    position?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                        x?: number | undefined;
-                        y?: number | undefined;
-                        z?: number | undefined;
-                    }> | undefined;
-                    direction?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                        x?: number | undefined;
-                        y?: number | undefined;
-                        z?: number | undefined;
-                    }> | undefined;
-                    up?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                        x?: number | undefined;
-                        y?: number | undefined;
-                        z?: number | undefined;
-                    }> | undefined;
-                    west?: number | undefined;
-                    south?: number | undefined;
-                    east?: number | undefined;
-                    north?: number | undefined;
-                }> | undefined;
-            }> | undefined;
-            disablePreview: boolean | undefined;
-            disableZoomTo: boolean | undefined;
-            zoomOnAddToWorkbench: boolean | undefined;
-            show: boolean | undefined;
-            initialMessage?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                title?: string | undefined;
-                content?: string | undefined;
-                key?: string | undefined;
-                confirmation?: boolean | undefined;
-                confirmText?: string | undefined;
-                width?: number | undefined;
-                height?: number | undefined;
-            }> | undefined;
-            attribution?: string | undefined;
-        }>>;
-        readonly strataBottomToTop: ReadonlyMap<string, import("terriajs/lib/Core/TypeModifiers").Complete<{
-            rectangle?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                west?: number | undefined;
-                south?: number | undefined;
-                east?: number | undefined;
-                north?: number | undefined;
-            }> | undefined;
-            idealZoom?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                lookAt?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                    targetLongitude?: number | undefined;
-                    targetLatitude?: number | undefined;
-                    targetHeight?: number | undefined;
-                    heading?: number | undefined;
-                    pitch?: number | undefined;
-                    range?: number | undefined;
-                }> | undefined;
-                camera?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                    position?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                        x?: number | undefined;
-                        y?: number | undefined;
-                        z?: number | undefined;
-                    }> | undefined;
-                    direction?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                        x?: number | undefined;
-                        y?: number | undefined;
-                        z?: number | undefined;
-                    }> | undefined;
-                    up?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                        x?: number | undefined;
-                        y?: number | undefined;
-                        z?: number | undefined;
-                    }> | undefined;
-                    west?: number | undefined;
-                    south?: number | undefined;
-                    east?: number | undefined;
-                    north?: number | undefined;
-                }> | undefined;
-            }> | undefined;
-            disablePreview: boolean | undefined;
-            disableZoomTo: boolean | undefined;
-            zoomOnAddToWorkbench: boolean | undefined;
-            show: boolean | undefined;
-            initialMessage?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                title?: string | undefined;
-                content?: string | undefined;
-                key?: string | undefined;
-                confirmation?: boolean | undefined;
-                confirmText?: string | undefined;
-                width?: number | undefined;
-                height?: number | undefined;
-            }> | undefined;
-            attribution?: string | undefined;
-        }>>;
-        duplicateModel(newId: string, sourceReference?: import("terriajs/lib/Models/Definition/Model").BaseModel | undefined): any;
-        setTrait<Key_6 extends "show" | "rectangle" | "attribution" | "idealZoom" | "disablePreview" | "disableZoomTo" | "zoomOnAddToWorkbench" | "initialMessage">(stratumId: string, trait: Key_6, value: import("terriajs/lib/Core/TypeModifiers").Complete<{
-            rectangle?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                west?: number | undefined;
-                south?: number | undefined;
-                east?: number | undefined;
-                north?: number | undefined;
-            }> | undefined;
-            idealZoom?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                lookAt?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                    targetLongitude?: number | undefined;
-                    targetLatitude?: number | undefined;
-                    targetHeight?: number | undefined;
-                    heading?: number | undefined;
-                    pitch?: number | undefined;
-                    range?: number | undefined;
-                }> | undefined;
-                camera?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                    position?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                        x?: number | undefined;
-                        y?: number | undefined;
-                        z?: number | undefined;
-                    }> | undefined;
-                    direction?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                        x?: number | undefined;
-                        y?: number | undefined;
-                        z?: number | undefined;
-                    }> | undefined;
-                    up?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                        x?: number | undefined;
-                        y?: number | undefined;
-                        z?: number | undefined;
-                    }> | undefined;
-                    west?: number | undefined;
-                    south?: number | undefined;
-                    east?: number | undefined;
-                    north?: number | undefined;
-                }> | undefined;
-            }> | undefined;
-            disablePreview: boolean | undefined;
-            disableZoomTo: boolean | undefined;
-            zoomOnAddToWorkbench: boolean | undefined;
-            show: boolean | undefined;
-            initialMessage?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                title?: string | undefined;
-                content?: string | undefined;
-                key?: string | undefined;
-                confirmation?: boolean | undefined;
-                confirmText?: string | undefined;
-                width?: number | undefined;
-                height?: number | undefined;
-            }> | undefined;
-            attribution?: string | undefined;
-        }>[Key_6]): void;
-        getTrait<Key_7 extends "show" | "rectangle" | "attribution" | "idealZoom" | "disablePreview" | "disableZoomTo" | "zoomOnAddToWorkbench" | "initialMessage">(stratumId: string, trait: Key_7): import("terriajs/lib/Core/TypeModifiers").Complete<{
-            rectangle?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                west?: number | undefined;
-                south?: number | undefined;
-                east?: number | undefined;
-                north?: number | undefined;
-            }> | undefined;
-            idealZoom?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                lookAt?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                    targetLongitude?: number | undefined;
-                    targetLatitude?: number | undefined;
-                    targetHeight?: number | undefined;
-                    heading?: number | undefined;
-                    pitch?: number | undefined;
-                    range?: number | undefined;
-                }> | undefined;
-                camera?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                    position?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                        x?: number | undefined;
-                        y?: number | undefined;
-                        z?: number | undefined;
-                    }> | undefined;
-                    direction?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                        x?: number | undefined;
-                        y?: number | undefined;
-                        z?: number | undefined;
-                    }> | undefined;
-                    up?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                        x?: number | undefined;
-                        y?: number | undefined;
-                        z?: number | undefined;
-                    }> | undefined;
-                    west?: number | undefined;
-                    south?: number | undefined;
-                    east?: number | undefined;
-                    north?: number | undefined;
-                }> | undefined;
-            }> | undefined;
-            disablePreview: boolean | undefined;
-            disableZoomTo: boolean | undefined;
-            zoomOnAddToWorkbench: boolean | undefined;
-            show: boolean | undefined;
-            initialMessage?: import("terriajs/lib/Core/TypeModifiers").Complete<{
-                title?: string | undefined;
-                content?: string | undefined;
-                key?: string | undefined;
-                confirmation?: boolean | undefined;
-                confirmText?: string | undefined;
-                width?: number | undefined;
-                height?: number | undefined;
-            }> | undefined;
-            attribution?: string | undefined;
-        }>[Key_7];
-        addObject<Key_8 extends "show" | "rectangle" | "attribution" | "idealZoom" | "disablePreview" | "disableZoomTo" | "zoomOnAddToWorkbench" | "initialMessage">(stratumId: string, trait: Key_8, objectId: string): import("terriajs/lib/Models/Definition/Model").default<import("terriajs/lib/Models/Definition/Model").ArrayElementTypes<import("terriajs-plugin-api").MappableTraits>[Key_8]> | undefined;
-        readonly rectangle: import("terriajs/lib/Models/Definition/Model").default<import("terriajs/lib/Traits/TraitsClasses/MappableTraits").RectangleTraits>;
-        readonly idealZoom: import("terriajs/lib/Models/Definition/Model").default<import("terriajs/lib/Traits/TraitsClasses/MappableTraits").IdealZoomTraits>;
-        readonly disablePreview: boolean;
-        readonly disableZoomTo: boolean;
-        readonly zoomOnAddToWorkbench: boolean;
-        readonly show: boolean;
-        readonly initialMessage: import("terriajs/lib/Models/Definition/Model").default<import("terriajs/lib/Traits/TraitsClasses/MappableTraits").InitialMessageTraits>;
-        readonly attribution: string | undefined;
-    };
-} & import("terriajs/lib/Models/Definition/Model").ModelConstructor<import("terriajs/lib/Models/Definition/Model").default<BoxDrawingCatalogItemTraits>>;
-/**
- * A simple catalog item that shows a transformable 3D box on the map.
- *
- * The box is configured by setting its transformatioMatrix trait value.
- * When adding this catlog item to the workbench, terria will
- * first call `forceLoadMapItems` which is a noop in this case.
- * Then terria queries `mapItems` to get an array of all items to show on the map.
- *
- * Notice how we use the mobx reactive pattern by "computing" values for `mapItems`
- * and other bits of data. This ensures that if any trait value or other observable
- * objects the catalog item depends on change (eg terria.cesium), then the change is propogated
- * throughout the system which re-computes the value of `mapItem`.
- */
+import Rectangle from "terriajs-cesium/Source/Core/Rectangle";
+import TranslationRotationScale from "terriajs-cesium/Source/Core/TranslationRotationScale";
+import { MapItem, Terria, ViewingControl } from "terriajs-plugin-api";
+declare const BoxDrawingCatalogItem_base: any;
 export default class BoxDrawingCatalogItem extends BoxDrawingCatalogItem_base {
-    /**
-     * Type must be a unique identifier. It is used when loading catalog json to map the
-     * configuration for an item to its class.
-     */
     static readonly type = "box-drawing";
-    readonly type = "box-drawing";
+    private boxDrawing;
+    constructor(id: string | undefined, terria: Terria);
     /**
@@ -609,14 +22,17 @@ * A catalog item lifecycle method which will be called
     /**
-     * Returns a BoxDrawing object or undefined if the trait value for transformMatrix is not set.
+     * By definiing `viewingControls` a catalog item can extend its viewing control menu.
+     * This is 3-dot menu of a catalog item in the workbench.
+     *
+     * Another way to extend the viewing controls menu is using
+     * the `{@link ViewingControlsMenu.addMenuOption} function.
      */
-    get boxDrawing(): BoxDrawing | undefined;
+    get viewingControls(): ViewingControl[];
     /**
-     * Returns a Matrix4 object for the transformationMatrix trait value.
+     * Positions the box from a rectangle on the globe surface. The position,
+     * scale and rotation of the box will match the rectangle.
      */
-    get cesiumTransformationMatrix(): Matrix4 | undefined;
-    /**
-     * Sets the transformationMatrix from a rectangle on the globe surface.
-     */
-    setBoxTransformationFromRectangle(rectangle: Rectangle): void;
+    positionBoxFromRectangle(rectangle: Rectangle): void;
+    private setTraitsFromTranslationRotationScale;
+    get translationRotationScale(): TranslationRotationScale;
 }
 export {};

dist/index.js

@@ -1,1 +0,1 @@
-import{Matrix4 as r,Cartographic as t,Rectangle as i,Cartesian3 as e,Transforms as a,createGuid as o}from"terriajs-cesium";import s from"terriajs/lib/Models/BoxDrawing";import n from"terriajs/lib/Models/Catalog/CatalogMemberFactory";import m from"terriajs/lib/Models/Definition/CommonStrata";import l from"terriajs/lib/Models/Definition/CreateModel";import"terriajs/lib/Models/Terria";import p from"terriajs/lib/Models/UserDrawing";import d from"terriajs/lib/Models/ViewerMode";import"terriajs/lib/ReactViewModels/ViewState";import c from"terriajs/lib/ViewModels/MapNavigation/MapNavigationItemController";import"terriajs/lib/Traits/Decorators/anyTrait";import"terriajs/lib/Traits/Decorators/modelReferenceArrayTrait";import"terriajs/lib/Traits/Decorators/modelReferenceTrait";import"terriajs/lib/Traits/Decorators/objectArrayTrait";import"terriajs/lib/Traits/Decorators/objectTrait";import b from"terriajs/lib/Traits/Decorators/primitiveArrayTrait";import"terriajs/lib/Traits/Decorators/primitiveTrait";import T from"terriajs/lib/Traits/mixTraits";import"terriajs/lib/Traits/ModelTraits";import f from"terriajs/lib/Traits/TraitsClasses/CatalogMemberTraits";import"terriajs/lib/Traits/TraitsClasses/HeadingPitchRollTraits";import"terriajs/lib/Traits/TraitsClasses/LatLonHeightTraits";import M from"terriajs/lib/Traits/TraitsClasses/MappableTraits";import"terriajs/lib/Traits/TraitsClasses/TransformationTraits";import x from"terriajs/lib/ModelMixins/CatalogMemberMixin";import u from"terriajs/lib/ModelMixins/MappableMixin";import"terriajs/lib/ModelMixins/TableMixin";import"terriajs/lib/Styled/Box";import g from"terriajs/lib/Styled/Icon";import{__decorate as w}from"tslib";import{computed as h}from"mobx";class j extends(T(M,f)){}w([b({name:"Transformation matrix",description:"Transformation matrix that positions the box on the globe.",type:"number"})],j.prototype,"transformationMatrix",void 0);class v extends(x(u(l(j)))){constructor(){super(...arguments),this.type=v.type}forceLoadMapItems(){return Promise.resolve()}get mapItems(){var r;const t=null===(r=this.boxDrawing)||void 0===r?void 0:r.dataSource;return t?(t.show=this.show,[t]):[]}get boxDrawing(){const r=this.terria.cesium,t=this.cesiumTransformationMatrix;if(void 0!==r&&void 0!==t){return new s(r,t,{keepBoxAboveGround:!0})}}get cesiumTransformationMatrix(){const t=this.transformationMatrix;if(void 0!==t)return r.fromArray([...t])}setBoxTransformationFromRectangle(o){const s=t.toCartesian(i.center(o)),n=e.fromRadians(o.west,o.north),l=e.fromRadians(o.west,o.south),p=e.fromRadians(o.east,o.north),d=e.distance(n,l),c=e.distance(n,p),b=new e(c,d,Math.min(c,d)),T=r.fromScale(b),f=a.eastNorthUpToFixedFrame(s);r.multiply(f,T,f),this.setTrait(m.user,"transformationMatrix",r.toArray(f))}}v.type="box-drawing",w([h],v.prototype,"mapItems",null),w([h],v.prototype,"boxDrawing",null),w([h],v.prototype,"cesiumTransformationMatrix",null),n.register(v.type,v);class D extends c{constructor(r){super(),this.terria=r,this.glyph=g.GLYPHS.cube,this.viewerMode=d.Cesium,this.userDrawing=new p({terria:r,messageHeader:"Click two points to draw a 3D box",drawRectangle:!0,onDrawingComplete:({rectangle:r})=>{if(r){const t=this.create3dBox(r);this.terria.addModel(t),this.terria.workbench.add(t)}this.deactivate()}})}activate(){this.userDrawing.enterDrawMode(),super.activate()}deactivate(){this.userDrawing.endDrawing(),super.deactivate()}create3dBox(r){const t=new v(o(),this.terria);return t.setBoxTransformationFromRectangle(r),t.setTrait(m.user,"name","Box"),t}}const y={name:"Sample plugin",description:"A sample terria plugin that adds a tool for drawing a 3d box.",version:"0.0.1",register({viewState:r}){var t;(t=r.terria).mapNavigationModel.addItem({id:"draw-box-button",name:"Draw a 3D box",location:"TOP",screenSize:void 0,order:10,controller:new D(t)})}};export{y as default};
+import t from"terriajs-cesium/Source/Core/createGuid";import{Icon as e,primitiveTrait as i,mixTraits as o,MappableTraits as n,CatalogMemberTraits as r,objectTrait as s,LatLonHeightTraits as a,HeadingPitchRollTraits as m,ModelTraits as l,updateModelFromJson as d,CatalogMemberMixin as h,MappableMixin as u,CreateModel as p,BoxDrawing as c,runWorkflow as g,CommonStrata as w,CatalogMemberFactory as x,MapToolbar as v,UserDrawing as f}from"terriajs-plugin-api";import{__decorate as b}from"tslib";import{computed as y,action as S}from"mobx";import C from"terriajs-cesium/Source/Core/Cartesian3";import D from"terriajs-cesium/Source/Core/Cartographic";import R from"terriajs-cesium/Source/Core/HeadingPitchRoll";import T from"terriajs-cesium/Source/Core/Matrix3";import F from"terriajs-cesium/Source/Core/Matrix4";import M from"terriajs-cesium/Source/Core/Quaternion";import j from"terriajs-cesium/Source/Core/Rectangle";import H from"terriajs-cesium/Source/Core/Transforms";import L from"terriajs-cesium/Source/Core/TranslationRotationScale";class P{constructor(t){this.item=t,this.name="Edit box transform",this.icon=e.GLYPHS.cube}get selectableDimensions(){return[this.positionControls,this.dimensionsControls]}get positionControls(){const t=this.item.position;return{type:"group",id:"position",name:"Position",selectableDimensions:[{type:"numeric",id:"latitude",name:"Latitude",value:t.latitude,min:-90,max:90,setDimensionValue:(t,e)=>{void 0!==e&&this.item.position.setTrait(t,"latitude",e)}},{type:"numeric",id:"longitude",name:"Longitude",value:t.longitude,min:-180,max:180,setDimensionValue:(t,e)=>{void 0!==e&&this.item.position.setTrait(t,"longitude",e)}},{type:"numeric",id:"height",name:"Height",value:t.height,setDimensionValue:(t,e)=>{void 0!==e&&this.item.position.setTrait(t,"height",e)}}]}}get dimensionsControls(){const t=this.item.dimensions;return{type:"group",id:"dimensions",name:"Dimensions (in meters)",selectableDimensions:[{type:"numeric",id:"width",name:"Width",min:1,value:t.width,setDimensionValue:(t,e)=>{void 0!==e&&this.item.dimensions.setTrait(t,"width",e)}},{type:"numeric",id:"length",name:"Length",min:1,value:t.length,setDimensionValue:(t,e)=>{void 0!==e&&this.item.dimensions.setTrait(t,"length",e)}},{type:"numeric",id:"height",name:"Height",min:1,value:t.height,setDimensionValue:(t,e)=>{void 0!==e&&this.item.dimensions.setTrait(t,"height",e)}}]}}}b([y],P.prototype,"selectableDimensions",null),b([y],P.prototype,"positionControls",null),b([y],P.prototype,"dimensionsControls",null);class V extends l{static setFromCartesianScale(t,e,i){d(t,e,{width:i.x,length:i.y,height:i.z})}}b([i({type:"number",name:"Length",description:"Length in meters"})],V.prototype,"length",void 0),b([i({type:"number",name:"Width",description:"Width in meters"})],V.prototype,"width",void 0),b([i({type:"number",name:"Height",description:"Height in metres"})],V.prototype,"height",void 0);class B extends(o(n,r)){}b([s({type:a,name:"Origin",description:"The position of the box expressed as a longitude and latitude in degrees and a height above terrain in meters."})],B.prototype,"position",void 0),b([s({type:m,name:"Rotation",description:"The rotation of the model expressed as heading, pitch and roll in the local frame of reference."})],B.prototype,"rotation",void 0),b([s({type:V,name:"Dimensions",description:"The dimensions of the box expressed as lengt, width and height in meters."})],B.prototype,"dimensions",void 0);class G extends(h(u(p(B)))){constructor(t,e){super(t,e)}forceLoadMapItems(){return Promise.resolve()}get mapItems(){const t=this.terria.cesium;return t?this.boxDrawing||(this.boxDrawing=c.fromTranslationRotationScale(t,this.translationRotationScale,{keepBoxAboveGround:!0,onChange:({translationRotationScale:t})=>{this.setTraitsFromTranslationRotationScale(t)}})):this.boxDrawing=void 0,this.boxDrawing?(this.boxDrawing.setTranslationRotationScale(this.translationRotationScale),this.boxDrawing.dataSource.show=this.show,[this.boxDrawing.dataSource]):[]}get viewingControls(){return[{id:"edit-box-transform",name:"Edit box",icon:{glyph:e.GLYPHS.cube},onClick:t=>{g(t,new P(this))}}]}positionBoxFromRectangle(t){const e=D.toCartesian(j.center(t)),i=C.fromRadians(t.west,t.north),o=C.fromRadians(t.west,t.south),n=C.fromRadians(t.east,t.north),r=C.distance(i,o),s=C.distance(i,n),a=Math.min(r,s),m=M.fromRotationMatrix(F.getMatrix3(H.eastNorthUpToFixedFrame(e),new T)),l=new C(s,r,a),d=new L(e,m,l);this.setTraitsFromTranslationRotationScale(d)}setTraitsFromTranslationRotationScale(t){a.setFromCartesian(this.position,w.user,t.translation),m.setFromQuaternion(this.rotation,w.user,t.rotation),V.setFromCartesianScale(this.dimensions,w.user,t.scale)}get translationRotationScale(){var t,e,i,o,n,r,s,a,m;const l=D.toCartesian(D.fromDegrees(null!==(t=this.position.longitude)&&void 0!==t?t:0,null!==(e=this.position.latitude)&&void 0!==e?e:0,null!==(i=this.position.height)&&void 0!==i?i:0)),d=M.fromHeadingPitchRoll(R.fromDegrees(null!==(o=this.rotation.heading)&&void 0!==o?o:0,null!==(n=this.rotation.pitch)&&void 0!==n?n:0,null!==(r=this.rotation.roll)&&void 0!==r?r:0)),h=new C(null!==(s=this.dimensions.width)&&void 0!==s?s:1,null!==(a=this.dimensions.length)&&void 0!==a?a:1,null!==(m=this.dimensions.height)&&void 0!==m?m:1);return new L(l,d,h)}}G.type="box-drawing",b([y],G.prototype,"mapItems",null),b([y],G.prototype,"viewingControls",null),b([S],G.prototype,"positionBoxFromRectangle",null),b([S],G.prototype,"setTraitsFromTranslationRotationScale",null),b([y],G.prototype,"translationRotationScale",null),x.register(G.type,G);const k={name:"Sample plugin",description:"A sample terria plugin that adds a tool for drawing a 3d box.",version:"0.0.1",register({viewState:i,terria:o,workbench:n}){let r;const s=v.addModeButton(i,{icon:e.GLYPHS.cube,text:"Draw a 3D box",onUserEnterMode:()=>{r=function(t,e){return new f({terria:t,messageHeader:"Click two points to draw a 3D box",drawRectangle:!0,onDrawingComplete:({rectangle:t})=>{t&&e(t)}})}(o,(e=>{!function(e,i,o){const n=new G(t(),e);n.setTrait(w.user,"name","3D box"),n.positionBoxFromRectangle(o),e.addModel(n),i.add(n)}(o,n,e),s.closeMode()})),r.enterDrawMode()},onUserCloseMode:()=>{null==r||r.endDrawing()}})}};export{k as default};

dist/Traits/BoxDrawingCatalogItemTraits.d.ts

@@ -1,6 +0,15 @@
-import { CatalogMemberTraits, MappableTraits } from "terriajs-plugin-api";
-declare const BoxDrawingCatalogItemTraits_base: import("terriajs/lib/Traits/TraitsConstructor").default<MappableTraits & CatalogMemberTraits & import("terriajs/lib/Traits/ModelTraits").default>;
+import Cartesian3 from "terriajs-cesium/Source/Core/Cartesian3";
+import { HeadingPitchRollTraits, LatLonHeightTraits, Model, ModelTraits } from "terriajs-plugin-api";
+export declare class DimensionsTraits extends ModelTraits {
+    length?: number;
+    width?: number;
+    height?: number;
+    static setFromCartesianScale(model: Model<DimensionsTraits>, stratumId: string, scale: Cartesian3): void;
+}
+declare const BoxDrawingCatalogItemTraits_base: any;
 export default class BoxDrawingCatalogItemTraits extends BoxDrawingCatalogItemTraits_base {
-    transformationMatrix?: number[];
+    position?: LatLonHeightTraits;
+    rotation?: HeadingPitchRollTraits;
+    dimensions?: DimensionsTraits;
 }
 export {};

package.json

 {
   "name": "terriajs-plugin-sample",
-  "version": "0.0.1-alpha.1",
+  "version": "0.0.1-alpha.3",
   "description": "A sample terriajs plugin.",
@@ -9,5 +9,5 @@ "module": "dist/index.js",
   "license": "Apache-2.0",
-  "prepublish": "rollup -c rollup.config.ts",
+  "prepare": "rollup -c rollup.config.ts",
   "dependencies": {
-    "terriajs-plugin-api": "0.0.1-alpha.1"
+    "terriajs-plugin-api": "0.0.1-alpha.3"
   },
@@ -21,3 +21,3 @@ "devDependencies": {
     "rollup-plugin-terser": "^7.0.2",
-    "terriajs": "https://github.com/terriajs/terriajs#15751503bc6024b7e0cc0cab72f662fd9d32d3a7",
+    "terriajs": "8.1.26",
     "tslib": "^2.3.1",
@@ -24,0 +24,0 @@ "typescript": "^3.9.4"

README.md

@@ -31,3 +31,3 @@ <i>🚧 Warning: This project is work-in-progress and things can break or be entirely scrapped without notice.</i>
 ```bash
-yarn add -W https://github.com/terriajs/plugin-sample#0.0.1-alpha.1
+yarn add -W 'terriajs-plugin-sample@0.0.1-alpha.1'
 ```
@@ -89,4 +89,4 @@
     "pm2": "^3.2.2",
-    "terriajs-plugin-api": "https://github.com/terriajs/plugin-api#0.0.1-alpha.1",
-    "terriajs-plugin-sample": "0.0.1", // <-- plugin-sample version changed to match the version in packages/plugin-sample/package.json
+    "terriajs-plugin-api": "0.0.1-alpha.1",
+    "terriajs-plugin-sample": "0.0.1-alpha.1", // <-- plugin-sample version changed to match the version in packages/plugin-sample/package.json
 ```
@@ -93,0 +93,0 @@

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

16378

-65.95%

Number of package files

11

-8.33%

Lines of code

182

-76.24%

Number of medium supply chain risk alerts

1

Infinity%

Dependency changes

• + Added

  terriajs-plugin-api@0.0.1-alpha.3
  (transitive)

• - Removed

  terriajs-plugin-api@0.0.1-alpha.1
  (transitive)

• Updated

  terriajs-plugin-api@0.0.1-alpha.3