Class PluginAPI

constructor

• new PluginAPI(app: App, router: Router, pinia: Pinia): PluginAPI

  Parameters

  • app: App

    The Vue App instance

  • router: Router

    The Vue Router instance

  • pinia: Pinia

    The Pinia Store instance

  Returns PluginAPI

app

pinia

router

bottomBar

• get bottomBar(): {
      add: (item: BottomBarItemConfig) => void;
      remove: (key: string) => void;
  }

  Manage the Map Status Bar

  Returns { add: (item: BottomBarItemConfig) => void; remove: (key: string) => void }

  • add: (item: BottomBarItemConfig) => void

    Add a component to the centre of the bottom status bar

  • remove: (key: string) => void

    Remove a previously registered bottom bar component by key

breadcrumb

• get breadcrumb(): {
      live: {
          add: (uid: string) => Promise<void>;
          list: () => Promise<string[]>;
          remove: (uid: string) => Promise<void>;
      };
  }

  Manage Breadcrumb Trails

  Returns {
      live: {
          add: (uid: string) => Promise<void>;
          list: () => Promise<string[]>;
          remove: (uid: string) => Promise<void>;
      };
  }

  • live: {
        add: (uid: string) => Promise<void>;
        list: () => Promise<string[]>;
        remove: (uid: string) => Promise<void>;
    }

    Manage live breadcrumb trail recording

    • add: (uid: string) => Promise<void>

      Enable live breadcrumb trail recording for a given CoT UID

    • list: () => Promise<string[]>

      Returns all CoT UIDs that currently have live breadcrumb recording enabled

    • remove: (uid: string) => Promise<void>

      Disable live breadcrumb trail recording for a given CoT UID

feature

• get feature(): {
      list: (
          opts?: { filter?: (feature: DBFeature) => boolean },
      ) => Promise<DBFeature[]>;
      stream: (
          opts?: { filter?: (feature: DBFeature) => boolean },
      ) => Observable<DBFeature[]>;
  }

  Manage Features

  Returns {
      list: (
          opts?: { filter?: (feature: DBFeature) => boolean },
      ) => Promise<DBFeature[]>;
      stream: (
          opts?: { filter?: (feature: DBFeature) => boolean },
      ) => Observable<DBFeature[]>;
  }

  • list: (opts?: { filter?: (feature: DBFeature) => boolean }) => Promise<DBFeature[]>

    List features from the local database

  • stream: (opts?: { filter?: (feature: DBFeature) => boolean }) => Observable<DBFeature[]>

    Stream features from the local database

float

• get float(): {
      add: (
          opts: {
              actions?: Component;
              component: Component;
              height?: number;
              name?: string;
              props?: Record<string, unknown>;
              uid: string;
              width?: number;
              x?: number;
              y?: number;
          },
      ) => FloatingPane;
      has: (uid: string) => boolean;
      remove: (uid: string) => void;
  }

  Manage Floating Panes on top of the Map View

  Returns {
      add: (
          opts: {
              actions?: Component;
              component: Component;
              height?: number;
              name?: string;
              props?: Record<string, unknown>;
              uid: string;
              width?: number;
              x?: number;
              y?: number;
          },
      ) => FloatingPane;
      has: (uid: string) => boolean;
      remove: (uid: string) => void;
  }

  • add: (
        opts: {
            actions?: Component;
            component: Component;
            height?: number;
            name?: string;
            props?: Record<string, unknown>;
            uid: string;
            width?: number;
            x?: number;
            y?: number;
        },
    ) => FloatingPane

    Add a new floating pane

  • has: (uid: string) => boolean

    Check if a floating pane exists

  • remove: (uid: string) => void

    Remove a floating pane

map

• get map(): Map$1

  Map Accessors

  Returns Map$1

menu

• get menu(): {
      add: (item: MenuItemConfig) => void;
      remove: (key: string) => void;
  }

  Manage the Main Menu

  Returns { add: (item: MenuItemConfig) => void; remove: (key: string) => void }

  • add: (item: MenuItemConfig) => void

    Add a new item to the main menu

  • remove: (key: string) => void

    Remove an item from the main menu

routes

• get routes(): { add: (route: RouteRecordRaw, parentName?: string) => void }

  Manage Application Routes

  Returns { add: (route: RouteRecordRaw, parentName?: string) => void }

  • add: (route: RouteRecordRaw, parentName?: string) => void

    Add a new route to the application