Class HonuaWmsLayer

constructor

• new HonuaWmsLayer(options): HonuaWmsLayer

• Parameters

  • options: HonuaWmsLayerOptions

  Returns HonuaWmsLayer

Readonlyclient

ReadonlydefaultStyleId

ReadonlylayerName

ReadonlyserviceId

capabilities

• capabilities(options?): Promise<WmsCapabilities>

• Fetch the parent service's GetCapabilities.

  Parameters

  • Optionaloptions: {
        signal?: AbortSignal;
    }

    • Optionalsignal?: AbortSignal

  Returns Promise<WmsCapabilities>

describe

• describe(capabilities): undefined | WmsCapabilityLayer

• Find this layer in a parsed Capabilities document.

  Parameters

  • capabilities: WmsCapabilities

  Returns undefined | WmsCapabilityLayer

featureInfo

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

• Type Parameters

  • T = Record<string, unknown>

  Parameters

  • request: Omit<WmsFeatureInfoRequest, "layers" | "styles" | "queryLayers"> & {
        style?: string;
    }

  Returns Promise<HonuaWmsFeatureInfoResponse<T>>

legend

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

• Fetch a GetLegendGraphic image scoped to the bound layer + style. Mirrors HonuaWms.legend's gating: when options.capabilities is not supplied, the handle lazily loads them once via getWmsCapabilities and caches the promise. Throws HonuaCapabilityNotSupportedError("legend", "wms", serviceId) when the service does not advertise <GetLegendGraphic>.

  Parameters

  • request: Omit<WmsLegendRequest, "style" | "layer"> & {
        style?: string;
    } = {}
  • Optionaloptions: {
        capabilities?: WmsCapabilities;
    }

    • Optionalcapabilities?: WmsCapabilities

  Returns Promise<HonuaWmsImageResponse>

map

• map(request): Promise<HonuaWmsImageResponse>

• Parameters

  • request: Omit<WmsMapRequest, "layers" | "styles"> & {
        style?: string;
    }

  Returns Promise<HonuaWmsImageResponse>

stylesIn

• stylesIn(capabilities): readonly WmsCapabilityStyle[]

• Enumerate the styles advertised on this layer.

  Parameters

  • capabilities: WmsCapabilities

  Returns readonly WmsCapabilityStyle[]