Class SectionItem

A class that represents legend items used to group a collection of child items.

Hierarchy (view full)

LegendItem
- SectionItem

Constructors

constructor

new SectionItem(iApi, config, parent?): SectionItem
Create a new SectionItem.
Parameters
- iApi: InstanceAPI
  instance API for the RAMP that this is associated with
- config: any
  the config for the given SectionItem
- Optionalparent: LegendItem
  a legend item that this item is a child of
Returns SectionItem
Overrides LegendItem.constructor
- Defined in src/fixtures/legend/store/section-item.ts:25

Properties

`Readonly`$iApi

$iApi: InstanceAPI

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

Memberof

APIScope

_children

_children: LegendItem[] = []

_content

_content: string

_controls

_controls: undefined | LegendControl[]

_disabledControls

_disabledControls: undefined | LegendControl[]

_exclusive

_exclusive: boolean

_expanded

_expanded: boolean

_hidden

_hidden: boolean

_infoType

_infoType: InfoType

`Optional`_lastVisible

_lastVisible?: LegendItem

_loadPromise

_loadPromise: DefPromise<void>

_name

_name: string

`Optional`_parent

_parent?: LegendItem = undefined

_type

_type: LegendType

_uid

_uid: string

_visibility

_visibility: boolean

_visibleChildren

_visibleChildren: LegendItem[]

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:91
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:98

content

get content(): string
Returns the content of this SectionItem

Returns string
- Defined in src/fixtures/legend/store/section-item.ts:47
set content(content): void
Sets new content for this SectionItem
Parameters
- content: string
  new content
Returns void
- Defined in src/fixtures/legend/store/section-item.ts:54

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:133

expanded

get expanded(): boolean
Returns if item is expanded

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

hidden

get hidden(): boolean
Returns if item is hidden

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

infoType

get infoType(): InfoType
Returns the info type of this SectionItem

Returns InfoType
- Defined in src/fixtures/legend/store/section-item.ts:42

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:113

name

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

Returns string
Inherited from LegendItem.name
- Defined in src/fixtures/legend/store/legend-item.ts:74
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:81

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:103
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:108

type

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

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

uid

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

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

visibility

get visibility(): boolean
Returns if item has visibility

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

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:259

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:240

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:146

error

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

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

getConfig

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

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

load

load(): void
Sets legend item to a loaded state.

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

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:338

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:343

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:360

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:155

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:177

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:169

toggleVisibility

toggleVisibility(visible?, updateParent?): void
Toggle visibility state of a legend item. Needs to verify parent visibility is updated.
Parameters
- Optionalvisible: boolean
- updateParent: boolean = true
  whether or not toggleVisibiliity should 'bubble-up' the legend tree
Returns void
Inherited from LegendItem.toggleVisibility
- Defined in src/fixtures/legend/store/legend-item.ts:186