Show:

ia.FeatureServiceLayer Class

Extends ia.FeatureLayer
Defined in: ia\maps\layers\FeatureServiceLayer.js:1
Module: ia

The base class for AGS Feature layers.

Constructor

ia.FeatureServiceLayer

(
  • inSource
)

Defined in ia\maps\layers\FeatureServiceLayer.js:1

Parameters:

  • inSource String

    The spatial source.

Methods

_addToSelection

(
  • id
)
private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:785

Adds an id to the selection.

Parameters:

  • id String

    The id of the item.

_clearCanvas

(
  • c
  • ctx
)
private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:973

Clears a canvas.

Parameters:

  • c HTML Canvas

    The canvas to clear.

  • ctx HTML Canvas Context

    Its context.

_clearHighlightGraphics

() private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:986

Clears the highlight canvas.

_clearLabelGraphics

() private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:1008

Clears the label canvas.

_clearLayerGraphics

() private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:1023

Clears the layer canvases.

_clearSelectionGraphics

() private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:997

Clears the selection canvas.

_dispatchItemEvent

(
  • event
  • isHit
  • item
)
private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:590

The hit logic for items in the layer.

Parameters:

  • event ia.MapMouseEvent

    A ia.MapMouseEvent.

  • isHit Boolean

    Indicates if the item was hit.

  • item Object

    The item that was hit.

_drawItem

(
  • item
  • ctx
)
private

Inherited from ia.FeatureLayer: ia\maps\layers\FeatureLayer.js:460

Does the actual drawing.

Parameters:

  • item Object

    The item.

  • ctx HTML Canvas Context

    The context to render to.

_hitTest

(
  • event
)
private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:500

Runs a hit test on the layer.

Parameters:

_itemEventHandler

(
  • event
)
private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:656

Handles default selection / highlight functionality.

Parameters:

  • event ia.ItemEvent

    An ia.ItemEvent dispatched by this layer.

_mapEventHandler

(
  • event
)
private

Inherited from ia.LayerBase but overwritten in ia\charts\layers\ItemLayer.js:475

Handles when to carry out hit tests.

Parameters:

_pointInLine

(
  • coords
  • pointX
  • pointY
)
private

Inherited from ia.FeatureLayer: ia\maps\layers\FeatureLayer.js:643

Query if a point lies completely within a polygon.

Parameters:

  • coords Number

    The coords to hit test.

  • pointX Number

    The pixel x coordinate of the test point.

  • pointY Number

    The pixel y coordinate of the test point.

_pointInPoly

(
  • coords
  • pointX
  • pointY
)
private

Inherited from ia.FeatureLayer: ia\maps\layers\FeatureLayer.js:669

Query if a point lies completely within a polygon.

Parameters:

  • coords Number

    The coords to hit test.

  • pointX Number

    The x coordinate of the test point.

  • pointY Number

    The y coordinate of the test point.

_pointInRect

(
  • symbolWidth
  • symbolHeight
  • coords
  • pointX
  • pointY
)
private

Inherited from ia.FeatureLayer: ia\maps\layers\FeatureLayer.js:691

Query if a point lies completely within a shape.

Parameters:

  • symbolWidth Number

    The symbol width.

  • symbolHeight Number

    The symbol height.

  • coords Number

    The coords to hit test.

  • pointX Number

    The x coordinate of the test point.

  • pointY Number

    The y coordinate of the test point.

_removeFromSelection

(
  • id
)
private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:772

Removes an id from the selection.

Parameters:

  • id String

    The id of the item.

_renderItems

(
  • items
)
private

Defined in ia\maps\layers\FeatureServiceLayer.js:578

Renders the passed items.

Parameters:

  • items Object

    An array of layer items to render.

_setLabelStyle

() private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:419

Sets the label style.

_triggerRenderSelection

() private

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:875

Triggers a selection render. Prevents over rendering which results in a frozen browser.

_updateItems

() private

Defined in ia\maps\layers\FeatureServiceLayer.js:294

Updates the layer items.

addCanvases

()

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:233

Adds drawing canvases for the layer when the layer is shown. This method was introduced to fix a bug a chrome when multiple canvases were affecting rendering. It basically reduces the number of unused canvases which are taking up memory.

addEventListener

(
  • eventType
  • fnc
  • obj
)

Inherited from ia.EventDispatcher: ia\events\EventDispatcher.js:15

Add an event listener.

Parameters:

  • eventType String

    The type of event to listen for.

  • fnc Function

    The function to call when the event occurs.

  • obj Object

    An optional parent object.

clear

()

Inherited from ia.LayerBase but overwritten in ia\charts\layers\ItemLayer.js:950

Clears all canvases in the layer.

clearHighlight

()

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:932

Clears all highlights.

clearItems

()

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:465

Clears the item list.

clearSelection

()

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:859

Clears all selections.

createCanvas

() HTML Canvas

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:336

Creates a new canvas.

Returns:

HTML Canvas: The canvas.

dispatchEvent

(
  • event
)

Inherited from ia.EventDispatcher: ia\events\EventDispatcher.js:50

Dispatch an event to the listeners.

Parameters:

  • event Object

    The event object.

draw

()

Inherited from ia.FeatureLayer: ia\maps\layers\FeatureLayer.js:312

Draws the layer.

getData

() Id:"eh11", name:"polwarth", value:2345, associate1:25

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:392

Gets a data object for the layer.

Returns:

Id:"eh11", name:"polwarth", value:2345, associate1:25: ["eh11"] ["eh12"]{id:"eh12", name:"morningside", value:4347, associate1:45} ["eh13"]{id:"eh13", name:"merchiston", value:2496, associate1:25}

getFeatureDetails

(
  • callbackFunction
)
String

Defined in ia\maps\layers\FeatureServiceLayer.js:215

Gets the feature details for initialising layer items.

Parameters:

  • callbackFunction Function

    The call back function.

Returns:

String: objectIds An array of ids.

getFeatures

(
  • maxAllowableOffset
  • callbackFunction
)
String

Defined in ia\maps\layers\FeatureServiceLayer.js:411

Gets the attribute data for the given objectIds from a FeatureServer.

Parameters:

  • maxAllowableOffset Number

    How detailed the returned geometry should be.

  • callbackFunction Function

    The call back function.

Returns:

String: objectIds An array of ids.

getItem

(
  • id
)

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:454

Gets an item with the given id.

Parameters:

  • id String

    The id of the item to get.

getVisible

() Boolean

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:132

Gets the visibility of the layer.

Returns:

Boolean: true/false.

hideTip

()

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:765

Hides the tip.

highlight

(
  • id
)

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:920

Hightlights an item.

Parameters:

  • id String

    The id of the item to highlight.

highlightItem

(
  • item
)

Inherited from ia.ItemLayer but overwritten in ia\maps\layers\FeatureLayer.js:433

Highlights the item.

Parameters:

  • item Object

    The item.

hitItem

(
  • item
  • event
)

Inherited from ia.ItemLayer but overwritten in ia\maps\layers\FeatureLayer.js:574

Runs a hit test on shapes.

Parameters:

isSelected

(
  • id
)

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:798

Checks if an id is selected

Parameters:

  • id String

    The id of the item.

loadSource

()

Inherited from ia.LayerBase but overwritten in ia\maps\layers\FeatureServiceLayer.js:77

Overrides loadSource in FeatureLayer because we dont actually load anything. The layer data is loaded and rendered every time the map is redrawn.

parseData

(
  • features
  • maxAllowableOffset
)

Inherited from ia.FeatureLayer but overwritten in ia\maps\layers\FeatureServiceLayer.js:446

Parses the layerData every time the map is redrawn.

Parameters:

  • features JSON

    The FeatureServer features.

  • maxAllowableOffset Number

    How detailed the returned geometry should be.

removeCanvases

()

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:292

Removes drawing canvases for the layer when the layer is hidden. This method was introduced to fix a bug a chrome when multiple canvases were affecting rendering. It basically reduces the number of unused canvases which are taking up memory.

removeListener

(
  • obj
)

Inherited from ia.EventDispatcher: ia\events\EventDispatcher.js:30

Removes all event listeners for the given object.

Parameters:

  • obj Object

    The object.

render

()

Inherited from ia.LayerBase but overwritten in ia\maps\layers\FeatureServiceLayer.js:246

Renders the layer.

renderItem

(
  • item
)

Inherited from ia.FeatureLayer: ia\maps\layers\FeatureLayer.js:444

Renders the item to the given context.

Parameters:

  • item Object

    The item.

renderItemLabel

(
  • item
)

Inherited from ia.FeatureLayer: ia\maps\layers\FeatureLayer.js:531

Renders the item label.

Parameters:

  • item Object

    The item.

renderSelection

()

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:893

Renders the selection canvas.

select

(
  • id
)

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:825

Selects an item.

Parameters:

  • id String

    The id of the item.

selectAll

()

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:811

Selects all the items in the layer.

selectItem

(
  • item
)

Inherited from ia.ItemLayer but overwritten in ia\maps\layers\FeatureLayer.js:422

Selects the item.

Parameters:

  • item Object

    The item.

setData

(
  • value
)

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:405

Sets a data object for the layer.

Parameters:

  • value Id:"eh11", name:"polwarth", value:2345, associate1:25

    ["eh11"]
    ["eh12"]{id:"eh12", name:"morningside", value:4347, associate1:45}
    ["eh13"]{id:"eh13", name:"merchiston", value:2496, associate1:25}

setMap

(
  • map
  • map
)

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:175

Sets the map and canvas for the layer.

Parameters:

  • map ia.Map

    The map.

  • map HTML Element

    The container.

setVisible

(
  • value
)

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:143

Sets the visibility of the layer.

Parameters:

  • value Boolean

    true/false.

showTip

(
  • item
  • event
)

Inherited from ia.ItemLayer but overwritten in ia\maps\layers\FeatureLayer.js:721

Displays the tip for the passed item

Parameters:

  • item Object

    The map item.

  • event ia.ItemEvent

    An ia.ItemEvent.

tipFunction

(
  • item
)

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:744

Supplies the default text for the layer. This can be replaced with a custom function

Parameters:

  • item Object

    The map item.

unselect

(
  • id
)

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:842

Unselects an item.

Parameters:

  • id String

    The id of the item.

Properties

animationMode

Boolean

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:247

Animation mode.

Default: false

bBox

ia.BoundingBox

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:66

The bounding box for the layer.

canvas

HTML Canvas

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:50

The canvas associated with this layer.

context

HTML Canvas Context

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:58

The canvas context associated with this layer.

dataChanged

Boolean

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:374

Indicates the data has changed.

Default: false

dataField

String

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:365

Specifies the field of the data provider that provides the values.

Default: "value"

dataLabel

String

Inherited from ia.FeatureLayer: ia\maps\layers\FeatureLayer.js:29

The layer data label.

Default: ""

doHitTest

Boolean

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:321

Indicates whether to carry out a hit test.

Default: true

esriGeometryType

String

Defined in ia\maps\layers\FeatureServiceLayer.js:53

The FeatureServer geometry type, used to differentiate between multi-point and single-point features.

eval

Boolean

Inherited from ia.FeatureLayer: ia\maps\layers\FeatureLayer.js:82

Check if its eval data.

Default: true

featureBBox

ia.BoundingBox

Defined in ia\maps\layers\FeatureServiceLayer.js:69

The extents of the layer usin.

geometry

String

Inherited from ia.FeatureLayer: ia\maps\layers\FeatureLayer.js:108

The geometry for the layer.

highlightCanvas

HTML Canvas

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:273

The highlight canvas associated with this layer.

highlightColor

String

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:348

The item highlight color.

Default: "#00ff00"

highlightContext

HTML Canvas Context

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:281

The highlight canvas context associated with this layer.

highlightOpacity

Number

Inherited from ia.FeatureLayer: ia\maps\layers\FeatureLayer.js:134

The highlight opacity.

Default: 0.3

icon

Image

Inherited from ia.FeatureLayer: ia\maps\layers\FeatureLayer.js:74

The loaded icon derived from iconPath.

id

String

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:24

The id of the layer.

Default: ""

idField

String

Defined in ia\maps\layers\FeatureServiceLayer.js:26

The id field.

Default: ""

interactive

Boolean

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:92

Is selection and highlighting switched on.

Default: false

isLoaded

Boolean

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:83

Indicates whether the layer is loaded.

Default: false

itemArray

Object

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:313

An array containing the layer items.

items

Associative Array

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:305

An associate array containing the layer items.

labelContext

HTML Canvas Context

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:265

The label canvas context associated with this layer.

map

ia.Map

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:42

The map associated with this layer.

maxLabelExtent

Number

Inherited from ia.FeatureLayer: ia\maps\layers\FeatureLayer.js:47

The maximum display extent for labels.

Default: Infinity

name

String

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:33

The name of the layer.

Default: ""

nameField

String

Defined in ia\maps\layers\FeatureServiceLayer.js:35

The name field.

Default: ""

objectIds

String

Defined in ia\maps\layers\FeatureServiceLayer.js:61

A list of objectids to use.

selectionCanvas

HTML Canvas

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:289

The selection canvas associated with this layer.

selectionColor

String

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:339

The item selection color.

Default: "#ff0000"E

selectionContext

HTML Canvas Context

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:297

The selection canvas context associated with this layer.

selectionIds

String

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:357

An array of selected ids.

selectionOpacity

Number

Inherited from ia.FeatureLayer: ia\maps\layers\FeatureLayer.js:125

The selection opacity.

Default: 0.3

showDataTips

Boolean

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:110

Are data tips displayed.

Default: trueE

showInLayerList

Boolean

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:74

Should the layer be displayed ina layer list.

Default: false

showLabels

Boolean

Inherited from ia.LayerBase: ia\charts\layers\LayerBase.js:101

Show labels.

Default: false

source

String

Inherited from ia.FeatureLayer: ia\maps\layers\FeatureLayer.js:100

The spatial data source for the layer.

srs

Number

Defined in ia\maps\layers\FeatureServiceLayer.js:44

The spatial reference system.

Default: 102100

style

Object

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:330

The layer style.

Default: {fillStyle:'#EFEFEF', strokeStyle:'#CCCCCC', lineWidth:'1', lineJoin:'round'}

symbol

String

Inherited from ia.ItemLayer but overwritten in ia\maps\layers\FeatureLayer.js:116

The symbol used for point data.

Default: ia.Shape.CIRCLE

symbolSize

Number

Inherited from ia.FeatureLayer: ia\maps\layers\FeatureLayer.js:56

The symbol size.

Default: 15

tip

String

Inherited from ia.ItemLayer: ia\charts\layers\ItemLayer.js:383

The data tip - used by charts that have fixed tip templates.

Default: ""

uid

String

Inherited from ia.FeatureLayer: ia\maps\layers\FeatureLayer.js:91

Unique id.

Default: ""

url

Number

Inherited from ia.FeatureLayer but overwritten in ia\maps\layers\FeatureLayer.js:38

The minimum display extent for labels.

Default: Infinity