Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KmlLayer

KmlLayer class is an implementation of Layer used for map placement of KML data.

Hierarchy

  • KmlLayer

Implements

  • Layer
  • Layer
  • Layer
  • Layer

Index

Constructors

Properties

Methods

Constructors

constructor

  • new KmlLayer(rawId: number, id: string, name: string, active: boolean, minScale: number, maxScale: number, legendData?: LayerLegendImageInfo): KmlLayer
  • new KmlLayer(rawId: number, id: string, name: string, active: boolean, minScale: number, maxScale: number, legendData?: LayerLegendImageInfo): KmlLayer
  • new KmlLayer(rawId: number, id: string, name: string, active: boolean, minScale: number, maxScale: number, legendData?: LayerLegendImageInfo): KmlLayer

  • Parameters

    • rawId: number
    • id: string
    • name: string
    • active: boolean
    • minScale: number
    • maxScale: number
    • Optional legendData: LayerLegendImageInfo

    Returns KmlLayer

  • Parameters

    • rawId: number
    • id: string
    • name: string
    • active: boolean
    • minScale: number
    • maxScale: number
    • Optional legendData: LayerLegendImageInfo

    Returns KmlLayer

  • Parameters

    • rawId: number
    • id: string
    • name: string
    • active: boolean
    • minScale: number
    • maxScale: number
    • Optional legendData: LayerLegendImageInfo

    Returns KmlLayer

Properties

Private _active

_active: any

Private _activeChanged

_activeChanged: any = new EventSource<ActiveLayerChangeArgs>("kmlLayer:activeChanged")

Private _children

_children: any = []

Private _id

_id: any

Private _legendInfo

_legendInfo: any

Private _maxScale

_maxScale: any

Private _minScale

_minScale: any

Private _name

_name: any

Private _parent

_parent: any

Private _rawId

_rawId: any

active

  • get active(): boolean
  • set active(active: boolean): void

  • The active property is a boolean active/inactive switch for the KmlLayer.

    Returns boolean

  • The active property is a boolean active/inactive switch for the KmlLayer.

    Parameters

    • active: boolean

    Returns void

activeChanged

  • get activeChanged(): Event<ActiveLayerChangeArgs>

  • The activeChanged event property indicates the boolean active/inactive switch for the KmlLayer changed.

    Returns Event<ActiveLayerChangeArgs>

children

  • get children(): Array<KmlLayer>

  • Child layer(s) of this KmlLayer.

    Returns Array<KmlLayer>

hasChildren

  • get hasChildren(): boolean

  • Boolean indicating whether this is layer has child layer(s).

    Returns boolean

hasParent

  • get hasParent(): boolean

  • Boolean indicating whether this is the top level layer (or simply an orphan).

    Returns boolean

id

  • get id(): string

  • The id property is a string identifier for the KmlLayer. Readonly set in constructor.

    Returns string

legendInfo

  • get legendInfo(): Array<LayerLegendImageInfo>

  • The name property is an array of LayerLegendImageInfo for the KmlLayer. Readonly set in constructor.

    Returns Array<LayerLegendImageInfo>

maxScale

  • get maxScale(): number

  • Gets the maximum scale numeric for the layer. Readonly set in constructor.

    Returns number

minScale

  • get minScale(): number

  • Gets the minimum scale numeric for the layer. Readonly set in constructor.

    Returns number

name

  • get name(): string

  • The name property is a string Name for the KmlLayer. Readonly set in constructor.

    Returns string

parent

  • get parent(): KmlLayer
  • set parent(parent: KmlLayer): void

  • The parent layer or null if none.

    Returns KmlLayer

  • The parent layer or null if none. When setting, an activation event is subscribed to for the parent

    Parameters

    • parent: KmlLayer

    Returns void

rawId

  • get rawId(): number

  • The rawID property is a numeric identifier for the KmlLayer. Readonly set in constructor.

    Returns number

Methods

activate

  • activate(): void
  • activate(): void
  • activate(): void

  • The activate method switches the boolean active/inactive to active and raises the activeChanged event.

    Returns void

  • The activate method switches the boolean active/inactive to active and raises the activeChanged event.

    Returns void

  • The activate method switches the boolean active/inactive to active and raises the activeChanged event.

    Returns void

deactivate

  • deactivate(): void
  • deactivate(): void
  • deactivate(): void

  • The deactivate method switches the boolean active/inactive to non-active and raises the activeChanged event.

    Returns void

  • The deactivate method switches the boolean active/inactive to non-active and raises the activeChanged event.

    Returns void

  • The deactivate method switches the boolean active/inactive to non-active and raises the activeChanged event.

    Returns void