Class LayerItem

A class that represents a generic item in the legend.

Hierarchy (view full)

LegendItem
- LayerItem

Index

Constructors

constructor

Constructors

constructor

new LayerItem(iApi, config, parent?): LayerItem
Creates a new single layer item.
Parameters
- iApi: InstanceAPI
- config: any
- Optionalparent: LegendItem
  Returns item's parent - not yet initialized
Returns LayerItem
Overrides LegendItem.constructor
- Defined in src/fixtures/legend/store/layer-item.ts:36

Properties

`Readonly`$iApi

$iApi: InstanceAPI

The instance of RampMap API scoped to a single Vue R4MP application.

Memberof

APIScope

_children

_children: LegendItem[] = []

_controls

_controls: undefined | LegendControl[]

`Optional`_coverIcon

_coverIcon?: string

_customSymbology

_customSymbology: boolean = false

`Optional`_description

_description?: string

_disabledControls

_disabledControls: undefined | LegendControl[]

_exclusive

_exclusive: boolean

_expanded

_expanded: boolean

_hidden

_hidden: boolean

_isSublayer

_isSublayer: boolean = false

`Optional`_lastVisible

_lastVisible?: LegendItem

_layer

_layer: undefined | LayerInstance

_layerControls

_layerControls: LayerControl[]

_layerDisabledControls

_layerDisabledControls: LayerControl[]

_layerId

_layerId: string

`Optional`_layerIdx

_layerIdx?: number

_layerInitVis

_layerInitVis: undefined | boolean

_layerOffscale

_layerOffscale: boolean = false

_layerRedrawing

_layerRedrawing: boolean = false

_layerUid

_layerUid: string = ''

_loadPromise

_loadPromise: DefPromise<void>

_maxLines

_maxLines: undefined | number

_name

_name: string

_origLayerControls

_origLayerControls: undefined | LayerControl[]

_origLayerDisabledControls

_origLayerDisabledControls: undefined | LayerControl[]

`Optional`_parent

_parent?: LegendItem = undefined

_symbologyExpanded

_symbologyExpanded: boolean

_symbologyRenderStyle

_symbologyRenderStyle: string

_symbologyStack

_symbologyStack: LegendSymbology[]

_treeGrown

_treeGrown: boolean = false

_type

_type: LegendType

_uid

_uid: string

_visibility

_visibility: boolean

_visibleChildren

_visibleChildren: LegendItem[]

handlers

handlers: string[] = []

Accessors

$element

get $element(): App<Element>
Returns App<Element>
Inherited from LegendItem.$element
- Defined in src/api/common.ts:32

$vApp

get $vApp(): ComponentPublicInstance
The instance of Vue R4MP application controlled by this InstanceAPI. This is just a shorthand for this.$iApi.$vApp.

Returns ComponentPublicInstance
Memberof
APIScope
Inherited from LegendItem.$vApp
- Defined in src/api/common.ts:28

children

get children(): LegendItem[]
Returns children of the legend item

Returns LegendItem[]
Inherited from LegendItem.children
- Defined in src/fixtures/legend/store/legend-item.ts:90
set children(children): void
Sets new children for the legend item
Parameters
- children: LegendItem[]
  new child legend items
Returns void
Inherited from LegendItem.children
- Defined in src/fixtures/legend/store/legend-item.ts:97

coverIcon

get coverIcon(): undefined | string
Returns undefined | string
- Defined in src/fixtures/legend/store/layer-item.ts:160
set coverIcon(icon): void
Parameters
- icon: undefined | string
Returns void
- Defined in src/fixtures/legend/store/layer-item.ts:164

description

get description(): undefined | string
Returns undefined | string
- Defined in src/fixtures/legend/store/layer-item.ts:168
set description(description): void
Parameters
- description: undefined | string
Returns void
- Defined in src/fixtures/legend/store/layer-item.ts:172

exclusive

get exclusive(): boolean
Returns if item follows "exclusive set" behaviour

Returns boolean
Inherited from LegendItem.exclusive
- Defined in src/fixtures/legend/store/legend-item.ts:132

expanded

get expanded(): boolean
Returns if item is expanded

Returns boolean
Inherited from LegendItem.expanded
- Defined in src/fixtures/legend/store/legend-item.ts:122

hidden

get hidden(): boolean
Returns if item is hidden

Returns boolean
Inherited from LegendItem.hidden
- Defined in src/fixtures/legend/store/legend-item.ts:117

isSublayer

get isSublayer(): boolean
Returns if the layer is a sublayer

Returns boolean
- Defined in src/fixtures/legend/store/layer-item.ts:118

layer

get layer(): LayerInstance
Returns Ramp Layer associated with legend item.

Returns LayerInstance
- Defined in src/fixtures/legend/store/layer-item.ts:130
set layer(layer): void
Parameters
- layer: LayerInstance
Returns void
- Defined in src/fixtures/legend/store/layer-item.ts:134

layerId

get layerId(): string
Returns the id of the layer

Returns string
- Defined in src/fixtures/legend/store/layer-item.ts:108

layerIdx

get layerIdx(): undefined | number
Returns layer index only if the layer item is a sublayer. Otherwise returns undefined

Returns undefined | number
- Defined in src/fixtures/legend/store/layer-item.ts:113

layerOffscale

get layerOffscale(): boolean
Returns boolean
- Defined in src/fixtures/legend/store/layer-item.ts:144
set layerOffscale(offscale): void
Parameters
- offscale: boolean
Returns void
- Defined in src/fixtures/legend/store/layer-item.ts:148

layerRedrawing

get layerRedrawing(): boolean
Returns boolean
- Defined in src/fixtures/legend/store/layer-item.ts:152
set layerRedrawing(redrawing): void
Parameters
- redrawing: boolean
Returns void
- Defined in src/fixtures/legend/store/layer-item.ts:156

layerUid

get layerUid(): string
Returns UID of the layer

Returns string
- Defined in src/fixtures/legend/store/layer-item.ts:125

loadPromise

get loadPromise(): Promise<void>
Returns the load promise for this legend item

Returns Promise<void>
Inherited from LegendItem.loadPromise
- Defined in src/fixtures/legend/store/legend-item.ts:112

maxLines

get maxLines(): undefined | number
Returns undefined | number
- Defined in src/fixtures/legend/store/layer-item.ts:213

name

get name(): string
Returns the item's name

Returns string
Inherited from LegendItem.name
- Defined in src/fixtures/legend/store/legend-item.ts:73
set name(name): void
Sets the item's name
Parameters
- name: string
  new item name
Returns void
Inherited from LegendItem.name
- Defined in src/fixtures/legend/store/legend-item.ts:80

origDisabledLayerControls

get origDisabledLayerControls(): undefined | LayerControl[]
Returns undefined | LayerControl[]
- Defined in src/fixtures/legend/store/layer-item.ts:193

origLayerControls

get origLayerControls(): undefined | LayerControl[]
Returns undefined | LayerControl[]
- Defined in src/fixtures/legend/store/layer-item.ts:189

parent

get parent(): undefined | LegendItem
Returns item's parent - not yet initialized

Returns undefined | LegendItem
Inherited from LegendItem.parent
- Defined in src/fixtures/legend/store/legend-item.ts:102
set parent(parent): void
Sets new parent for the legend item
Parameters
- parent: undefined | LegendItem
Returns void
Inherited from LegendItem.parent
- Defined in src/fixtures/legend/store/legend-item.ts:107

parentLayerId

get parentLayerId(): undefined | string
Returns the id of the parent layer if this item is a sublayer. Otherwise undefined

Returns undefined | string
- Defined in src/fixtures/legend/store/layer-item.ts:100

symbologyExpanded

get symbologyExpanded(): boolean
Returns true if symbology stack is expanded.

Returns boolean
- Defined in src/fixtures/legend/store/layer-item.ts:177

symbologyRenderStyle

get symbologyRenderStyle(): string
Returns string
- Defined in src/fixtures/legend/store/layer-item.ts:201
set symbologyRenderStyle(symbologyRenderStyle): void
Parameters
- symbologyRenderStyle: string
Returns void
- Defined in src/fixtures/legend/store/layer-item.ts:197

symbologyStack

get symbologyStack(): LegendSymbology[]
Returns LegendSymbology[]
- Defined in src/fixtures/legend/store/layer-item.ts:209
set symbologyStack(symbologyStack): void
Parameters
- symbologyStack: LegendSymbology[]
Returns void
- Defined in src/fixtures/legend/store/layer-item.ts:205

treeGrown

get treeGrown(): boolean
Returns boolean
- Defined in src/fixtures/legend/store/layer-item.ts:181
set treeGrown(value): void
Parameters
- value: boolean
Returns void
- Defined in src/fixtures/legend/store/layer-item.ts:185

type

get type(): LegendType
Returns the item's type

Returns LegendType
Inherited from LegendItem.type
- Defined in src/fixtures/legend/store/legend-item.ts:85

uid

get uid(): string
Returns the item's uid

Returns string
Inherited from LegendItem.uid
- Defined in src/fixtures/legend/store/legend-item.ts:68

visibility

get visibility(): boolean
Returns if item has visibility

Returns boolean
Inherited from LegendItem.visibility
- Defined in src/fixtures/legend/store/legend-item.ts:127

Methods

checkVisibility

checkVisibility(toggledChild): void
Updates parent visibility after a child item's visibility toggles.
Parameters
- toggledChild: LegendItem
  given child legend item
Returns void
Inherited from LegendItem.checkVisibility
- Defined in src/fixtures/legend/store/legend-item.ts:262

checkVisibilityRules

checkVisibilityRules(): void
Ensures visibility rules are followed if legend item is nested in another item on initialization.

Returns void
Inherited from LegendItem.checkVisibilityRules
- Defined in src/fixtures/legend/store/legend-item.ts:243

clickSymbology

clickSymbology(uid, visible): void
Executes the "click" logic on a symbology item. Sets the checkbox visibility, propagates any edge-cases to this layer item, and applies any filters to the layer
Parameters
- uid: string
  the uid of the legend symbology
- visible: boolean
  if we are clicking it on or off
Returns void
- Defined in src/fixtures/legend/store/layer-item.ts:300

clickSymbologyByIndex

clickSymbologyByIndex(index, visible): void
Simulates a "click" interaction on a symbology item at a specific index in the symbol stack
Parameters
- index: number
  the index of the legend symbology
- visible: boolean
  if we are clicking it on or off
Returns void
- Defined in src/fixtures/legend/store/layer-item.ts:280

controlAvailable

controlAvailable(control): undefined | boolean
Check if a control is available for the legend item. Returns:
- true if the control is included in legend item's available controls
- false if control is not included, or if control is disabled
- undefined if controls are not defined
Parameters
- control: LegendControl
  name of the control
Returns undefined | boolean
Inherited from LegendItem.controlAvailable
- Defined in src/fixtures/legend/store/legend-item.ts:145

error

error(): void
Sets legend item to an error state

Returns void
Overrides LegendItem.error
- Defined in src/fixtures/legend/store/layer-item.ts:444

getConfig

getConfig(): any
Returns a legend config representation of this item.

Returns any
Overrides LegendItem.getConfig
- Defined in src/fixtures/legend/store/layer-item.ts:220

layerControlAvailable

layerControlAvailable(control): boolean
Check if a control is available for the layer item.
Parameters
- control: LayerControl
  name of the control
Returns boolean
Indicates if control is enabled on this legend item or layer
- Defined in src/fixtures/legend/store/layer-item.ts:460

load

load(layer): void
Have the item adapt and update to the given layer as it loads. Is either called in the constructor, or through the legend api
Parameters
- layer: undefined | LayerInstance
  the layer to load. If undefined, layer will be fetched via instance API using id/uid.
Returns void
Overrides LegendItem.load
- Defined in src/fixtures/legend/store/layer-item.ts:366

onAdded

onAdded(): void
Runs right after legend item is added

Returns void
Inherited from LegendItem.onAdded
- Defined in src/fixtures/legend/store/legend-item.ts:341

onRemoved

onRemoved(): void
Runs right before legend item is removed

Returns void
Inherited from LegendItem.onRemoved
- Defined in src/fixtures/legend/store/legend-item.ts:346

reload

reload(): void
Sets legend item back to a loading/placeholder state

Returns void
Inherited from LegendItem.reload
- Defined in src/fixtures/legend/store/legend-item.ts:363

setControl

setControl(control, enable): void
Enable a disabled control, or disable an enabled control.
Parameters
- control: LegendControl
  name of the control
- enable: boolean
  true for enabling, false for disabling
Returns void
Inherited from LegendItem.setControl
- Defined in src/fixtures/legend/store/legend-item.ts:154

setSymbologyVisibility

setSymbologyVisibility(uid, visible): void
Sets the visibility of the symbology with the given uid If the provided UID is undefined, set the visibility of all symbols Only changes the visible state of the checkbox. Does not apply symbol filters.
Parameters
- uid: undefined | string
  the uid of the legend symbology
- visible: boolean
  The new visibility value
Returns void
- Defined in src/fixtures/legend/store/layer-item.ts:348

symbolsVisible

symbolsVisible(): boolean
Indicates if any symbology stack items are visible

Returns boolean
- Defined in src/fixtures/legend/store/layer-item.ts:288

toggleExpanded

toggleExpanded(expanded?): void
Toggle expand state of a legend item.
Parameters
- Optionalexpanded: boolean
  set legend item to expanded/not expanded if given, otherwise toggle
Returns void
Inherited from LegendItem.toggleExpanded
- Defined in src/fixtures/legend/store/legend-item.ts:176

toggleHidden

toggleHidden(hidden?): void
Toggle hidden state of a legend item.
Parameters
- Optionalhidden: boolean
  set legend item to hidden/not hidden if given, otherwise toggle
Returns void
Inherited from LegendItem.toggleHidden
- Defined in src/fixtures/legend/store/legend-item.ts:168

toggleSymbology

toggleSymbology(expanded?): boolean
Toggles the symbology expand and returns the new value
Parameters
- Optionalexpanded: boolean
  optional parameter to toggle expanded to a certain value
Returns boolean
- Defined in src/fixtures/legend/store/layer-item.ts:269

toggleVisibility

toggleVisibility(visible?, updateParent?, forceUpdate?): void
Toggle visibility state of a layer item. Needs to verify parent visibility is updated.
Parameters
- Optionalvisible: boolean
- updateParent: boolean = true
  whether or not toggleVisibility should 'bubble-up' the legend tree
- forceUpdate: boolean = false
  ignore control check, used when visibility is changed outside of legend fixture
Returns void
Overrides LegendItem.toggleVisibility
- Defined in src/fixtures/legend/store/layer-item.ts:240

updateLayerControls

updateLayerControls(): void
Returns void
- Defined in src/fixtures/legend/store/layer-item.ts:465

Class LayerItem

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LayerItem

Properties

Readonly$iApi

Memberof

_children

_controls

Optional_coverIcon

_customSymbology

Optional_description

_disabledControls

_exclusive

_expanded

_hidden

_isSublayer

Optional_lastVisible

_layer

_layerControls

_layerDisabledControls

_layerId

Optional_layerIdx

_layerInitVis

_layerOffscale

_layerRedrawing

_layerUid

_loadPromise

_maxLines

_name

_origLayerControls

_origLayerDisabledControls

Optional_parent

_symbologyExpanded

_symbologyRenderStyle

_symbologyStack

_treeGrown

_type

_uid

_visibility

_visibleChildren

handlers

Accessors

$element

Returns App<Element>

$vApp

Returns ComponentPublicInstance

Memberof

children

Returns LegendItem[]

Parameters

Returns void

coverIcon

Returns undefined | string

Parameters

Returns void

description

Returns undefined | string

Parameters

Returns void

exclusive

Returns boolean

expanded

Returns boolean

hidden

Returns boolean

isSublayer

Returns boolean

layer

Returns LayerInstance

Parameters

Returns void

layerId

`Readonly`$iApi

`Optional`_coverIcon

`Optional`_description

`Optional`_lastVisible

`Optional`_layerIdx

`Optional`_parent