Class LegendItem

constructor

• new LegendItem(iApi: InstanceAPI, config: any, parent?: LegendItem): LegendItem

  Create a new legend item with defaulting for all properties given config snippet, id is required.

  Parameters

  • iApi: InstanceAPI

    instance API for the RAMP that this is associated with

  • config: any

    the config for the given legend item

  • Optionalparent: LegendItem

    a legend item that this item is a child of

  Returns LegendItem

_children

_controls

_disabledControls

_exclusive

_expanded

_hidden

Optional_lastVisible

_loadPromise

_name

Optional_parent

_type

_uid

_visibility

_visibleChildren

children

• get children(): LegendItem[]

  Returns children of the legend item

  Returns LegendItem[]

• set children(children: LegendItem[]): void

  Sets new children for the legend item

  Parameters

  • children: LegendItem[]

    new child legend items

  Returns void

exclusive

• get exclusive(): boolean

  Returns if item follows "exclusive set" behaviour

  Returns boolean

expanded

• get expanded(): boolean

  Returns if item is expanded

  Returns boolean

hidden

• get hidden(): boolean

  Returns if item is hidden

  Returns boolean

loadPromise

• get loadPromise(): Promise<void>

  Returns the load promise for this legend item

  Returns Promise<void>

name

• get name(): string

  Returns the item's name

  Returns string

• set name(name: string): void

  Sets the item's name

  Parameters

  • name: string

    new item name

  Returns void

parent

• get parent(): LegendItem | undefined

  Returns item's parent - not yet initialized

  Returns LegendItem | undefined

• set parent(parent: LegendItem | undefined): void

  Sets new parent for the legend item

  Parameters

  • parent: LegendItem | undefined

  Returns void

type

• get type(): LegendType

  Returns the item's type

  Returns LegendType

uid

• get uid(): string

  Returns the item's uid

  Returns string

visibility

• get visibility(): boolean

  Returns if item has visibility

  Returns boolean

checkVisibility

• checkVisibility(toggledChild: LegendItem): void

  Updates parent visibility after a child item's visibility toggles.

  Parameters

  • toggledChild: LegendItem

    given child legend item

  Returns void

checkVisibilityRules

• checkVisibilityRules(): void

  Ensures visibility rules are followed if legend item is nested in another item on initialization.

  Returns void

controlAvailable

• controlAvailable(control: LegendControl): boolean | undefined

  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 boolean | undefined

error

• error(): void

  Sets legend item to an error state

  Returns void

getConfig

• getConfig(): any

  Returns a legend config representation of this item.

  Returns any

load

• load(): void

  Sets legend item to a loaded state.

  Returns void

onAdded

• onAdded(): void

  Runs right after legend item is added

  Returns void

onRemoved

• onRemoved(): void

  Runs right before legend item is removed

  Returns void

reload

• reload(): void

  Sets legend item back to a loading/placeholder state

  Returns void

setControl

• setControl(control: LegendControl, enable: boolean): 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

toggleExpanded

• toggleExpanded(expanded?: boolean): void

  Toggle expand state of a legend item.

  Parameters

  • Optionalexpanded: boolean

    set legend item to expanded/not expanded if given, otherwise toggle

  Returns void

toggleHidden

• toggleHidden(hidden?: boolean): void

  Toggle hidden state of a legend item.

  Parameters

  • Optionalhidden: boolean

    set legend item to hidden/not hidden if given, otherwise toggle

  Returns void

toggleVisibility

• toggleVisibility(visible?: boolean, updateParent?: boolean): 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