Class MapImageLayerCompat

constructor

• new MapImageLayerCompat(
      options: MapImageLayerCompatOptions,
  ): 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: readonly (Record<string, unknown> | MapImageSublayerCompat)[],
  ): void

  Parameters

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

  Returns void

applyEdits

• applyEdits(
      options: MapImageLayerApplyEditsOptions,
  ): Promise<HonuaApplyEditsResponse>

  Parameters

  • options: MapImageLayerApplyEditsOptions

  Returns Promise<HonuaApplyEditsResponse>

createQuery

• createQuery(layerId: number): MapImageLayerQueryOptions

  Parameters

  • layerId: number

  Returns MapImageLayerQueryOptions

destroy

• destroy(): void

  Returns void

exportImage

• exportImage(
      options: MapImageLayerExportOptions,
  ): Promise<HonuaExportMapResponse>

  Parameters

  • options: MapImageLayerExportOptions

  Returns Promise<HonuaExportMapResponse>

find

• find(options: MapImageLayerFindOptions): Promise<HonuaFindResponse>

  Parameters

  • options: MapImageLayerFindOptions

  Returns Promise<HonuaFindResponse>

findSublayerById

• findSublayerById(
      id: MapImageLayerSublayerLookupId,
  ): MapImageSublayerCompat | undefined

  Parameters

  • id: MapImageLayerSublayerLookupId

  Returns MapImageSublayerCompat | undefined

getField

• getField(fieldName: string): HonuaFieldInfo | undefined

  Parameters

  • fieldName: string

  Returns HonuaFieldInfo | undefined

getLegend

• getLegend(options?: MapImageLayerLegendOptions): Promise<HonuaLegendResponse>

  Parameters

  • options: MapImageLayerLegendOptions = {}

  Returns Promise<HonuaLegendResponse>

getOrCreateSublayerWrapper

• getOrCreateSublayerWrapper(
      layerId: number,
      source: Record<string, unknown>,
  ): MapImageSublayerCompat

  Parameters

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

  Returns MapImageSublayerCompat

identify

• identify(options: MapImageLayerIdentifyOptions): Promise<HonuaIdentifyResponse>

  Parameters

  • options: MapImageLayerIdentifyOptions

  Returns Promise<HonuaIdentifyResponse>

legend

• legend(options?: MapImageLayerLegendOptions): 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: string,
      listener: (event: unknown) => void,
  ): MapImageLayerHandleCompat

  Parameters

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

  Returns MapImageLayerHandleCompat

queryExtent

• queryExtent(
      options: MapImageLayerQueryExtentOptions,
  ): Promise<MapImageLayerQueryExtentResponse>

  Parameters

  • options: MapImageLayerQueryExtentOptions

  Returns Promise<MapImageLayerQueryExtentResponse>

queryFeatureCount

• queryFeatureCount(options: MapImageLayerQueryCountOptions): Promise<number>

  Parameters

  • options: MapImageLayerQueryCountOptions

  Returns Promise<number>

queryFeatures

• queryFeatures(options: MapImageLayerQueryOptions): Promise<HonuaQueryResponse>

  Parameters

  • options: MapImageLayerQueryOptions

  Returns Promise<HonuaQueryResponse>

queryFeaturesAll

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

  Parameters

  • options: MapImageLayerQueryAllOptions

  Returns Promise<unknown[]>

queryFeaturesStream

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

  Parameters

  • options: MapImageLayerQueryAllOptions

  Returns AsyncGenerator<unknown[], void, undefined>

queryObjectIds

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

  Parameters

  • options: MapImageLayerQueryObjectIdsOptions

  Returns Promise<number[]>

queryRelatedFeatures

• queryRelatedFeatures(
      options: MapImageLayerQueryRelatedFeaturesOptions,
  ): Promise<HonuaRelatedRecordsResponse>

  Parameters

  • options: MapImageLayerQueryRelatedFeaturesOptions

  Returns Promise<HonuaRelatedRecordsResponse>

queryRelatedRecords

• queryRelatedRecords(
      options: MapImageLayerQueryRelatedFeaturesOptions,
  ): Promise<HonuaRelatedRecordsResponse>

  Parameters

  • options: MapImageLayerQueryRelatedFeaturesOptions

  Returns Promise<HonuaRelatedRecordsResponse>

refresh

• refresh(): void

  Returns void

setLegendEnabled

• setLegendEnabled(legendEnabled: boolean): void

  Parameters

  • legendEnabled: boolean

  Returns void

setListMode

• setListMode(listMode: string): void

  Parameters

  • listMode: string

  Returns void

setOpacity

• setOpacity(opacity: number): void

  Parameters

  • opacity: number

  Returns void

setScaleRange

• setScaleRange(minScale: number | undefined, maxScale: number | undefined): void

  Parameters

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

  Returns void

setSublayers

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

  Parameters

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

  Returns void

setVisibility

• setVisibility(visible: boolean): void

  Parameters

  • visible: boolean

  Returns void

sublayer

• sublayer(id: MapImageLayerSublayerLookupId): MapImageSublayerCompat | undefined

  Parameters

  • id: MapImageLayerSublayerLookupId

  Returns MapImageSublayerCompat | undefined

watch

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

  Parameters

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

  Returns MapImageLayerHandleCompat

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

  Parameters

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

  Returns MapImageLayerHandleCompat

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

  Parameters

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

  Returns MapImageLayerHandleCompat

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

  Parameters

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

  Returns MapImageLayerHandleCompat

when

• when(
      callback?: (layer: MapImageLayerCompat) => void,
  ): Promise<MapImageLayerCompat>

  Parameters

  • Optionalcallback: (layer: MapImageLayerCompat) => void

  Returns Promise<MapImageLayerCompat>