Class MapImageLayerCompat

constructor

• new MapImageLayerCompat(options): MapImageLayerCompat

• Parameters

  • options: MapImageLayerCompatOptions

  Returns MapImageLayerCompat

ReadonlyeventBus

id

legendEnabled

listMode

loaded

loadStatus

maxScale

metadata

minScale

opacity

ReadonlyserviceId

title

Readonlyurl

visible

allSublayers

• get allSublayers(): readonly MapImageSublayerCompat[]

• Returns readonly MapImageSublayerCompat[]

sublayers

• get sublayers(): readonly MapImageSublayerCompat[]

• Returns readonly MapImageSublayerCompat[]

• set sublayers(sublayers): void

• Parameters

  • sublayers: readonly (Record<string, unknown> | MapImageSublayerCompat)[]

  Returns void

applyEdits

• applyEdits(options): Promise<HonuaApplyEditsResponse>

• Parameters

  • options: MapImageLayerApplyEditsOptions

  Returns Promise<HonuaApplyEditsResponse>

createQuery

• createQuery(layerId): MapImageLayerQueryOptions

• Parameters

  • layerId: number

  Returns MapImageLayerQueryOptions

destroy

• destroy(): void

• Returns void

exportImage

• exportImage(options): Promise<HonuaExportMapResponse>

• Parameters

  • options: MapImageLayerExportOptions

  Returns Promise<HonuaExportMapResponse>

find

• find(options): Promise<HonuaFindResponse>

• Parameters

  • options: MapImageLayerFindOptions

  Returns Promise<HonuaFindResponse>

findSublayerById

• findSublayerById(id): undefined | MapImageSublayerCompat

• Parameters

  • id: MapImageLayerSublayerLookupId

  Returns undefined | MapImageSublayerCompat

getField

• getField(fieldName): undefined | HonuaFieldInfo

• Parameters

  • fieldName: string

  Returns undefined | HonuaFieldInfo

getLegend

• getLegend(options?): Promise<HonuaLegendResponse>

• Parameters

  • options: MapImageLayerLegendOptions = {}

  Returns Promise<HonuaLegendResponse>

getOrCreateSublayerWrapper

• getOrCreateSublayerWrapper(layerId, source): MapImageSublayerCompat

• Parameters

  • layerId: number
  • source: Record<string, unknown>

  Returns MapImageSublayerCompat

identify

• identify(options): Promise<HonuaIdentifyResponse>

• Parameters

  • options: MapImageLayerIdentifyOptions

  Returns Promise<HonuaIdentifyResponse>

legend

• legend(options?): Promise<HonuaLegendResponse>

• Parameters

  • options: MapImageLayerLegendOptions = {}

  Returns Promise<HonuaLegendResponse>

listFields

• listFields(): readonly HonuaFieldInfo[]

• Returns readonly HonuaFieldInfo[]

load

• load(): Promise<MapImageLayerCompat>

• Returns Promise<MapImageLayerCompat>

on

• on(eventName, listener): MapImageLayerHandleCompat

• Parameters

  • eventName: string
  • listener: ((event: unknown) => void)
    • • (event): void

      • Parameters

        • event: unknown

        Returns void

  Returns MapImageLayerHandleCompat

queryExtent

• queryExtent(options): Promise<MapImageLayerQueryExtentResponse>

• Parameters

  • options: MapImageLayerQueryExtentOptions

  Returns Promise<MapImageLayerQueryExtentResponse>

queryFeatureCount

• queryFeatureCount(options): Promise<number>

• Parameters

  • options: MapImageLayerQueryCountOptions

  Returns Promise<number>

queryFeatures

• queryFeatures(options): Promise<HonuaQueryResponse>

• Parameters

  • options: MapImageLayerQueryOptions

  Returns Promise<HonuaQueryResponse>

queryFeaturesAll

• queryFeaturesAll(options): Promise<unknown[]>

• Parameters

  • options: MapImageLayerQueryAllOptions

  Returns Promise<unknown[]>

queryFeaturesStream

• queryFeaturesStream(options): AsyncGenerator<unknown[], void, undefined>

• Parameters

  • options: MapImageLayerQueryAllOptions

  Returns AsyncGenerator<unknown[], void, undefined>

queryObjectIds

• queryObjectIds(options): Promise<number[]>

• Parameters

  • options: MapImageLayerQueryObjectIdsOptions

  Returns Promise<number[]>

queryRelatedFeatures

• queryRelatedFeatures(options): Promise<HonuaRelatedRecordsResponse>

• Parameters

  • options: MapImageLayerQueryRelatedFeaturesOptions

  Returns Promise<HonuaRelatedRecordsResponse>

queryRelatedRecords

• queryRelatedRecords(options): Promise<HonuaRelatedRecordsResponse>

• Parameters

  • options: MapImageLayerQueryRelatedFeaturesOptions

  Returns Promise<HonuaRelatedRecordsResponse>

refresh

• refresh(): void

• Returns void

setLegendEnabled

• setLegendEnabled(legendEnabled): void

• Parameters

  • legendEnabled: boolean

  Returns void

setListMode

• setListMode(listMode): void

• Parameters

  • listMode: string

  Returns void

setOpacity

• setOpacity(opacity): void

• Parameters

  • opacity: number

  Returns void

setScaleRange

• setScaleRange(minScale, maxScale): void

• Parameters

  • minScale: undefined | number
  • maxScale: undefined | number

  Returns void

setSublayers

• setSublayers(sublayers): void

• Parameters

  • sublayers: readonly (Record<string, unknown> | MapImageSublayerCompat)[]

  Returns void

setVisibility

• setVisibility(visible): void

• Parameters

  • visible: boolean

  Returns void

sublayer

• sublayer(id): undefined | MapImageSublayerCompat

• Parameters

  • id: MapImageLayerSublayerLookupId

  Returns undefined | MapImageSublayerCompat

watch

• watch(propertyName, listener): MapImageLayerHandleCompat

• Parameters

  • propertyName: "loaded" | "visible" | "legendEnabled"
  • listener: ((value: boolean) => void)
    • • (value): void

      • Parameters

        • value: boolean

        Returns void

  Returns MapImageLayerHandleCompat

• watch(propertyName, listener): MapImageLayerHandleCompat

• Parameters

  • propertyName: "opacity" | "minScale" | "maxScale"
  • listener: ((value: number) => void)
    • • (value): void

      • Parameters

        • value: number

        Returns void

  Returns MapImageLayerHandleCompat

• watch(propertyName, listener): MapImageLayerHandleCompat

• Parameters

  • propertyName: "loadStatus"
  • listener: ((value: MapImageLayerLoadStatusCompat) => void)
    • • (value): void

      • Parameters

        • value: MapImageLayerLoadStatusCompat

        Returns void

  Returns MapImageLayerHandleCompat

• watch(propertyName, listener): MapImageLayerHandleCompat

• Parameters

  • propertyName: string
  • listener: ((value: unknown) => void)
    • • (value): void

      • Parameters

        • value: unknown

        Returns void

  Returns MapImageLayerHandleCompat

when

• when(callback?): Promise<MapImageLayerCompat>

• Parameters

  • Optionalcallback: ((layer: MapImageLayerCompat) => void)
    • • (layer): void

      • Parameters

        • layer: MapImageLayerCompat

        Returns void

  Returns Promise<MapImageLayerCompat>