Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ShowMapElementArgs

Hierarchy

  • ShowMapElementArgs

Index

Constructors

Properties

Methods

Constructors

constructor

  • new ShowMapElementArgs(elementId: string, mapPoint?: Point, content?: any, title?: any): ShowMapElementArgs

  • Initializes a new instance of the ShowMapElementArgs class. ShowMapElementArgs defines the arguments passed to a command relating to a showing an HTML view or element on the map. This class can be used for showing content in a map tip, or for attaching arbitrary HTML content to the map. The content property may be any of the following types:

    • An HTML DOM Element.
    • A framework view, inheriting from {@link framework.ui.ViewBase}.
    • An HTML content string.

    Parameters

    • elementId: string

      The ID to use when referring to the newly created element, e.g. when updating or removing it.

    • Optional mapPoint: Point

      The point (in map space) to anchor the element to.

    • Optional content: any

      Arbitrary content to display in the map element.

    • Optional title: any

      Title of the element.

    Returns ShowMapElementArgs

Properties

Private delay

delay: number

destroyContentView

destroyContentView: boolean

Whether to destroy the child content view when this view is destroyed. Leave this false if the view is going to be reused (for instance as part of a module). Set this to true if the view was created manually with ViewManeger.createView() and then forgotten about.

Methods

contentIsView

  • contentIsView(): boolean

  • Determines if the content property is a {@link geocortex.framework.ui.ViewBase}.

    Returns boolean

getNode

  • getNode(): HTMLElement

  • Gets the HTML element node, based on the content property.

    Returns HTMLElement

getTitleNode

  • getTitleNode(): HTMLElement

  • Gets the HTML element node, based on the title property.

    Returns HTMLElement

titleIsView

  • titleIsView(): boolean

  • Determines if the title property is a {@link geocortex.framework.ui.ViewBase}.

    Returns boolean