Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OmvRestClient

REST client supporting getting protobuf OMV Tile from REST-based servers.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly params

params: OmvRestClientParameters

Methods

addEventListener

  • addEventListener(type: string, listener: (event: Event) => void): void

  • Adds a listener to an event type.

    Parameters

    • type: string

      The type of event to listen to.

    • listener: (event: Event) => void

      The function that gets called when the event is fired.

        • (event: Event): void

        • Parameters

          • event: Event

          Returns void

    Returns void

connect

  • connect(): Promise<void>

dispatchEvent

  • dispatchEvent(event: { type: string }): void

  • Fire an event type.

    Parameters

    • event: { type: string }
      • [attachment: string]: any
      • type: string

    Returns void

dispose

  • dispose(): void

getTile

  • getTile(tileKey: TileKey, abortSignal?: AbortSignal | undefined): Promise<ArrayBufferLike | {}>

  • Asynchronously fetches a tile from this restful server.

    remarks

    Note: In case of an HTTP Error, rejected promise is returned with an error.

    example
    const response = layer.getTile(tileKey);
if (!response.ok) {
    // a network error happened
    console.error("Unable to download tile", response.statusText);
    return;
}

// the response is ok and contains data, access it e.g. as arrayBuffer:
const payload = await response.arrayBuffer();

    Parameters

    • tileKey: TileKey

      The tile key of the tile.

    • Optional abortSignal: AbortSignal | undefined

    Returns Promise<ArrayBufferLike | {}>

    A Promise of the HTTP response that contains the payload of the requested tile.

hasEventListener

  • hasEventListener(type: string, listener: (event: Event) => void): boolean

  • Checks if listener is added to an event type.

    Parameters

    • type: string

      The type of event to listen to.

    • listener: (event: Event) => void

      The function that gets called when the event is fired.

        • (event: Event): void

        • Parameters

          • event: Event

          Returns void

    Returns boolean

Optional onDidInvalidate

  • onDidInvalidate(listener: () => void): () => void

  • An event which fires when this DataProvider is invalidated.

    example
    const dispose = dataProvider.onDidInvalidate?.(() => {
    console.log("invalidated");
});

    Parameters

    • listener: () => void

      A function to call when this DataProvider is invalidated.

        • (): void

        • Returns void

    Returns () => void

    The function to call to unregister the listener from this event.

      • (): void

      • Returns void

ready

  • ready(): boolean

register

  • register(client: Object): Promise<void>

removeEventListener

  • removeEventListener(type: string, listener: (event: Event) => void): void

  • Removes a listener from an event type.

    Parameters

    • type: string

      The type of the listener that gets removed.

    • listener: (event: Event) => void

      The listener function that gets removed.

        • (event: Event): void

        • Parameters

          • event: Event

          Returns void

    Returns void

unregister

  • unregister(client: Object): void

Generated using TypeDoc