Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LayerInfo

Hierarchy

  • LayerInfo

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns LayerInfo

Properties

dataProvider

dataProvider: string

displayName

displayName: string

esriLayerInfo

esriLayerInfo: LayerInfo

fields

fields: FieldInfo[]

gcxLayer

gcxLayer: Layer

id

id: string

includeInLayerList

includeInLayerList: boolean

isExpanded

isExpanded: boolean

isUserCreated

isUserCreated: boolean

name

name: string

parentLayerId

parentLayerId: string

queryable

queryable: boolean

relationships

relationships: Relationship[]

serviceLayerInfo

serviceLayerInfo: ServiceLayerInfo

subLayerIds

subLayerIds: string[]

uniqueId

uniqueId: string

url

url: string

Methods

areAllAncestorsVisible

  • areAllAncestorsVisible(): boolean

  • Gets a value representing whether or not all of this layer's ancestors are currently visible in the map.

    Returns boolean

getDefinitionExpression

  • getDefinitionExpression(): string

  • Returns string

getFields

  • getFields(): Deferred

  • Returns Deferred

getInitializedFeatureLayer

  • getInitializedFeatureLayer(): Promise<FeatureLayer>

  • Returns Promise<FeatureLayer>

getMaxScale

  • getMaxScale(): number

  • Returns number

getMinScale

  • getMinScale(): number

  • Returns number

getUrlWithoutParameters

  • getUrlWithoutParameters(): string

  • Returns string

isVisible

  • isVisible(): boolean

  • Returns whether or not the layer represented by this layerInfo object is currently visible on the map.

    Returns boolean

setDefinitionExpression

  • setDefinitionExpression(definition: string): void

  • Parameters

    • definition: string

    Returns void

setEsriLayerVisibility

  • setEsriLayerVisibility(visible: boolean, doNotRefresh?: boolean): void

  • Parameters

    • visible: boolean
    • Optional doNotRefresh: boolean

    Returns void

setVisibility

  • setVisibility(visible: boolean, doNotRefresh?: boolean, applyDeferredRefresh?: boolean, refreshTimeoutMs?: number): void

  • Sets the visibility for this layer.

    Parameters

    • visible: boolean

      Specifies if the layer is visible or not

    • Optional doNotRefresh: boolean

      An optional parameter which if true, will set the visible layers internally but will not refresh the map automatically. Only applicable for mapServices that support layer visibility. Defaults to false.

    • Optional applyDeferredRefresh: boolean

      An optional parameter which if true, will refresh the map after a specified timeout in ms. Only applicable for mapServices that support layer visibility. 'applyDeferredRefresh' will ensure that only once refresh request is sent for all setVisibility requests within the given threshold. Defaults to false.

    • Optional refreshTimeoutMs: number

      The timeout in ms after which to refresh the map if applyDeferredRefresh is true. Defaults to 150ms.

    Returns void

Static fromEsriFeatureLayer

  • fromEsriFeatureLayer(featureLayer: FeatureLayer): LayerInfo

  • Parameters

    • featureLayer: FeatureLayer

    Returns LayerInfo

Static fromEsriLayerInfo

  • fromEsriLayerInfo(esriLayerInfo: LayerInfo, esriLayer: Layer): LayerInfo

  • Parameters

    • esriLayerInfo: LayerInfo
    • esriLayer: Layer

    Returns LayerInfo

Static fromGcxLayer

  • Parameters

    Returns LayerInfo