Home Reference Source Repository
import LayerBaseXyzTile from 'webmapsjs/src/layers/LayerBaseXyzTile.js'
public class | source

LayerBaseXyzTile

Extends:

LayerBase → LayerBaseXyzTile

XYZ tile

Constructor Summary

Public Constructor
public

constructor(url: string, options: object)

The XYZ tile layer

Member Summary

Public Members
public get

olLayer: ol.layer.Tile | ol.layer.Base | undefined: *

public get

source: ol.source.XYZ: *

Method Summary

Public Methods
public

addLegendContent(additionalContent: string)

add additional content to the legend

Inherited Summary

From class LayerBase
public get

get the legend content

public get

Check if the layer is loaded

public get

get the maximum resolution

public get

get max zoom

public get

get the minimum resolution

public get

get min zoom

public get

Get the layer name

public set

name(newName: string): *

set the layer name

public get

olLayer: ol.layer.Base | undefined: *

public get

Get the layer opacity

public set

opacity(opacity: number): *

Set the layer opacity

public get

get the map get params

public get

source: *

get the layer source

public get

get the url

public get

Get the layer visibility

public set

visible(visibility: boolean): *

Set the layer visibility

public get

get the z index

public set

zIndex(newZ: number): *

set the z index

protected set

legendContent(newVal: string): *

set the legend content directly

protected set

params(newParams: object): *

set the map get params

public
public

id: *

public
protected
public

addLegendContent(additionalContent: string)

add additional content to the legend

public
public

Get the legend html, be sure to only add to the DOM once

public

trick to refresh the layer

protected

base load function, sets _loaded = true if it is not already

Public Constructors

public constructor(url: string, options: object) source

The XYZ tile layer

Override:

LayerBase#constructor

Params:

NameTypeAttributeDescription
url string

url for source

options object

config

options.id string
  • optional

layer id

options.name string
  • optional
  • default: Unnamed

Layer] - layer name

options.opacity number
  • optional
  • default: 1

opacity

options.visible boolean
  • optional
  • default: true

default visible

options.minZoom number
  • optional
  • default: undefined

min zoom level, 0 - 28

options.maxZoom number
  • optional
  • default: undefined

max zoom level, 0 - 28

options.params object
  • optional
  • default: {}

the get parameters to include to retrieve the layer

options.zIndex number
  • optional
  • default: 0

the z index for the layer

options.loadCallback function
  • optional

function to call on load, context this is the layer object

options.legendCollapse boolean
  • optional
  • default: false

if the legend item should be initially collapsed

options.legendCheckbox boolean
  • optional
  • default: true

if the legend item should have a checkbox for visibility

options.legendContent boolean
  • optional

additional content to add to the legend

options.useEsriStyle boolean
  • optional
  • default: false

if the map service style should be used

Public Members

public get olLayer: ol.layer.Tile | ol.layer.Base | undefined: * source

Override:

LayerBase#olLayer

Return:

ol.layer.Tile | ol.layer.Base | undefined

the ol layer

public get source: ol.source.XYZ: * source

Override:

LayerBase#source

Return:

ol.source.XYZ

the vector source

Public Methods

public addLegendContent(additionalContent: string) source

add additional content to the legend

Override:

LayerBase#addLegendContent

Params:

NameTypeAttributeDescription
additionalContent string
  • optional
  • default: ''

additional content for legend