Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • LegendItemProviderFactory

Index

Methods

Static getLegendItemByIdWhenAvailable

  • getLegendItemByIdWhenAvailable(uniqueId: string, callback: function): void
  • This function will invoke the provided callback only when (and if) the legend Item in question is retrieved. If it's not retrieved because of the legend module not being loaded or in case of some unforeseen error, it will simply do nothing. Programmers should be aware of this while calling this function.

    Parameters

    • uniqueId: string

      A uniqueId parameter which is of the form <mapServiceId.layerId> for layers or simply the mapService id in case of map services

    • callback: function

      A callback function which will be invoked if, and when, the requested legend item becomes available.

    Returns void

Static getLegendItemWhenAvailable

  • getLegendItemWhenAvailable(layer: LayerInfo, callback: function): void
  • Convenience method to get legend item using a layerInfo object instance

    Parameters

    Returns void

Static getProviders

Static registerLegendItemProvider

  • Parameters

    Returns void