Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServiceLayerInfo

Hierarchy

  • ServiceLayerInfo

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

_esriLayerStateBackup

_esriLayerStateBackup: any[]

capabilities

capabilities: string[]

displayName

displayName: string

gcxMapService

gcxMapService: MapService

id

id: string

includeInLayerList

includeInLayerList: boolean

isExpanded

isExpanded: boolean

isUserCreated

isUserCreated: boolean

layers

layers: LayerInfo[]

serviceLayer

serviceLayer: Layer

serviceLayerFunction

serviceLayerFunction: string

serviceType

serviceType: string

tables

tables: LayerInfo[]

Methods

findLayerById

  • Parameters

    • id: string

    Returns LayerInfo

isVisible

  • isVisible(): boolean

  • Gets whether the serviceLayer represented by this ServiceLayerInfo object is currently visible.

    Returns boolean

loaded

  • loaded(): Deferred

  • Returns Deferred

opacity

  • opacity(): number

  • Gets the opacity of the service.

    Returns number

refresh

  • refresh(refreshTimeoutMs?: number, disableClientCaching?: boolean): void

  • Refreshes the map service by making a new request to the server.

    Parameters

    • Optional refreshTimeoutMs: number

      An optional parameter which if specified, will cause the map refresh to occur after the specified timeout. Any previous refresh timeouts will be cancelled when a new refresh timeout is set - ensuring that only one request goes out within the speicfied threshold. If undefined, the map refreshes immediately.

    • Optional disableClientCaching: boolean

      An optional parameter which, if set will disable client caching on the service layer (if supported) prior to refreshing it. Defaults to false.

    Returns void

setOpacity

  • setOpacity(opacity: number): void

  • Sets the opacity of this service.

    Parameters

    • opacity: number

    Returns void

setVisibility

  • setVisibility(visible: boolean): void

  • Parameters

    • visible: boolean

    Returns void

supportsLayerVisibility

  • supportsLayerVisibility(): boolean

  • Returns whether or not this service supports layer visibility.

    Returns boolean

Static fromEsriLayer

  • Parameters

    • layer: Layer

    Returns ServiceLayerInfo

Static fromGcxMapService