Class HonuaWms

constructor

• new HonuaWms(options): HonuaWms

• Parameters

  • options: HonuaWmsOptions

  Returns HonuaWms

Readonlyclient

ReadonlyserviceId

capabilities

• capabilities(options?): Promise<WmsCapabilities>

• Fetch and parse the service GetCapabilities document.

  Parameters

  • Optionaloptions: {
        signal?: AbortSignal;
    }

    • Optionalsignal?: AbortSignal

  Returns Promise<WmsCapabilities>

featureInfo

• featureInfo<T>(request): Promise<HonuaWmsFeatureInfoResponse<T>>

• Issue a GetFeatureInfo against one or more advertised layers.

  Type Parameters

  • T = Record<string, unknown>

  Parameters

  • request: WmsFeatureInfoRequest

  Returns Promise<HonuaWmsFeatureInfoResponse<T>>

layer

• layer(name, defaultStyleId?): HonuaWmsLayer

• Bind a single named layer for layer-scoped requests.

  Parameters

  • name: string
  • OptionaldefaultStyleId: string

  Returns HonuaWmsLayer

legend

• legend(request, options?): Promise<HonuaWmsImageResponse>

• Fetch a GetLegendGraphic image. Always gates on parsed Capabilities: when the caller does not pre-supply options.capabilities, the handle lazily loads them once via getWmsCapabilities and caches the promise on the instance so repeat calls reuse the same fetch. Throws HonuaCapabilityNotSupportedError("legend", "wms", serviceId) when the service does not advertise <GetLegendGraphic>.

  Parameters

  • request: WmsLegendRequest
  • Optionaloptions: {
        capabilities?: WmsCapabilities;
    }

    • Optionalcapabilities?: WmsCapabilities

  Returns Promise<HonuaWmsImageResponse>

map

• map(request): Promise<HonuaWmsImageResponse>

• Render a GetMap request across one or more advertised layers.

  Parameters

  • request: WmsMapRequest

  Returns Promise<HonuaWmsImageResponse>