API Docs for: TiledImage pre 1.0
Show:

TiledImage Class

TiledImage top level Object. Before calling the contsructor, create div element in HTML part. This constructor needs the id name of the div element.

Constructor

TiledImage

(
  • id
)

Parameters:

  • id String

    Id of the div for top level

Example:

<div id="id_name" style="height:123px;width:456px;"></div>
<script>
new TiledImage("id_name")
.addLayer(new TilesLayer("tile","test/z${z}/${x}_${y}.jpg",4000,3000))
.addControl(new ButtonControl());
</script>

Methods

addControl

() public chainable

add Control objects under this TiledImage object

Returns:

this

addLayer

() public chainable

Add Layers objects under this TiledImage object

Returns:

this

append

() private

append elements in each Layers within the view

getLayers

() ArrayObject public

Defined in src/main/resources/js/TiledImage.js:300

Available since 0.9.3

get layers added on this TiledImage object.

Returns:

ArrayObject: } object
name
name of the layer
show
visible flag of the layer

getMaxSize

() Array public

get Max Size

Returns:

Array: maxSize

getPosition

() Array public

get absolute position (jump)

Returns:

Array: [x,y] position of originl image in x,y

getWindowSize

() ArrayNumber,Number public

get current windows size

Returns:

ArrayNumber,Number: curent window size

getZoom

() Number public

get curent zoom level

Returns:

Number: current zoom level

getZooms

() ArrayNumber,Number,Number public

get min, curent, max zoom levels

Returns:

ArrayNumber,Number,Number: [min, curent, max] zoom levels

modLayer

(
  • name
  • v
)
public

modulate Layer attribute

Parameters:

  • name String

    nameof the layer

  • v Boolean

    visibility

move

(
  • x
  • y
)
public

move pixels in the zoom level

Parameters:

  • x Number

    pixels in the view in x

  • y Number

    pixels in the view in y

removeAll

() private

remove all the elements in each Layers

removeLayer

(
  • name
)
public

removeLayer attribute

Parameters:

  • name String

    of the layer

resize

(
  • w
  • h
)
public

resize windows

Parameters:

  • w Number

    width of the window

  • h Number

    height of the window

setPosition

(
  • x
  • y
)
public

set position (absolute jump)

Parameters:

  • x Number

    position of originl image in x

  • y Number

    position of originl image in y

setZoom

(
  • z
)
public

set zoom level

Parameters:

  • z Number

    zoom level

wrapPosition

() private

wrapPosition

Properties

aChgL

ArrayObject private

array of Layer Listener

Default: []

aChgM

ArrayObject private

array of move Listener

Default: []

aChgS

ArrayObject private

array of resize Listener

Default: []

aChgZ

ArrayObject private

array of zoom Listener

Default: []

aCont

ArrayObject private

array of Controls

Default: []

aLayers

ArrayObject private

array of Layer object

Default: []

map

DOMElement public

DOM Element of the moving layer

maxSize

ArrayNumber,Number private

maxSize

Default: [0,0]

maxZ

Number private

max Zoom level

Default: 0

minZ

Number private

min Zoom level

Default: 10

position

ArrayNumber,Number private

position of top-left

Default: [0,0]

self

Object private

self: private scope of this

Default: this

target

DOMElement public

The target DOM Element of TiledImage

windowSize

ArrayNumber,Number private

windowSize

Default: [0,0]

wrap

Arrayboolean,boolean private

wrap flag

Default: [false,false]

z_

Number private

property of current zoom

Default: 0

Events

changelayer

Fire if layers status changed.

Event Payload:

  • aLayers ArrayObject

    array of layers status object.

    • object{
      • l: layer object
      • show: boolean for the showing status

changezoom

Fire if zooms status changed.

Event Payload:

  • zooms ArrayObject

    array of [minZ, curZ, maxZ].

move

Fire if the view is moved.

Event Payload:

  • position ArrayNumber,Number

    array of absolute Position.

resize

Fire if the view window size changed.

Event Payload:

  • windowSize ArrayNumber,Number

    array of [width, height].