Class: UIComponent

UIComponent

Base class for all the UI component classes, a UI component is a HTMLElement positioned with geographic coordinate.
It is abstract and not intended to be instantiated.

(abstract) new ui.UIComponent(options) [source]

Some instance methods subclasses needs to implement:

1. Optional, returns the Dom element's position offset
function getOffset : Point

2. Method to create UI's Dom element
function buildOn : HTMLElement

3 Optional, to provide an event map to register event listeners.
function getEvents : void
4 Optional, a callback when dom is removed.
function onDomRemove : void
5 Optional, a callback when UI Component is removed.
function onRemove : void
Parameter Type Description
options Object configuration options
Extends:
Mixes From:
Fires:

Members

  • (constant) options

    • Properties:
    Name Type Description
    options Object
    Properties
    Name Type Default Description
    eventsPropagation opt Boolean false whether stop ALL events' propagation.
    eventsToStop opt Boolean null UI's dom events to stop propagation if eventsPropagation is true.
    dx opt Number 0 pixel offset on x axis
    dy opt Number 0 pixel offset on y axis
    autoPan opt Boolean false set it to false if you don't want the map to do panning animation to fit the opened UI.
    autoPanDuration opt Boolean 600 duration for auto panning animation.
    single opt Boolean true whether the UI is a global single one, only one UI will be shown at the same time if set to true.
    animation opt Boolean null fade | scale | fade,scale, add animation effect when showing and hiding.
    animationDuration opt Number 300 animation duration, in milliseconds.
    pitchWithMap opt Boolean false whether tilt with map
    rotateWithMap opt Boolean false whether rotate with map
    Source:

    Methods

  • addTo(owner) [source]

    • Adds the UI Component to a geometry or a map
    Parameter Type Description
    owner Geometry | Map geometry or map to addto.
    Fires:
    Returns:
    ui.UIComponent: this

  • getMap() [source]

    • Get the map it added to
    Returns:
    Map: map instance

  • show(coordinateopt) [source]

    • Show the UI Component, if it is a global single one, it will close previous one.
    Parameter Type Default Description
    coordinate opt Coordinate null coordinate to show, default is owner's center
    Fires:
    Returns:
    ui.UIComponent: this

  • hide() [source]

    • Hide the UI Component.
    Fires:
    Returns:
    ui.UIComponent: this

  • isVisible() [source]

    • Decide whether the ui component is open
    Returns:
    Boolean: true|false

  • remove() [source]

    • Remove the UI Component
    Fires:
    Returns:
    ui.UIComponent: this

  • getSize() [source]

    • Get pixel size of the UI Component.
    Returns:
    Size: size

  • (mixin) on(eventsOn, handler, contextopt) [source]

    • Register a handler function to be called whenever this event is fired. 
    foo.on('mousedown mousemove mouseup', onMouseEvent, foo);
    Parameter Type Default Description
    eventsOn String event types to register, seperated by space if more than one.
    handler function handler function to be called
    context opt Object null the context of the handler
    Mixes From:
    Returns:
    Any: this

  • (mixin) addEventListener(eventTypes, handler, contextopt) [source]

    • Alias for on
    Parameter Type Default Description
    eventTypes String event types to register, seperated by space if more than one.
    handler function handler function to be called
    context opt Object null the context of the handler
    Mixes From:
    Returns:
    : this

  • (mixin) once(eventTypes, handler, contextopt) [source]

    • Same as on, except the listener will only get fired once and then removed. 
    foo.once('mousedown mousemove mouseup', onMouseEvent, foo);
    Parameter Type Default Description
    eventTypes String event types to register, seperated by space if more than one.
    handler function listener handler
    context opt Object null the context of the handler
    Mixes From:
    Returns:
    : this

  • (mixin) off(eventsOff, handler, contextopt) [source]

    • Unregister the event handler for the specified event types. 
    foo.off('mousedown mousemove mouseup', onMouseEvent, foo);
    Parameter Type Default Description
    eventsOff String event types to unregister, seperated by space if more than one.
    handler function listener handler
    context opt Object null the context of the handler
    Mixes From:
    Returns:
    : this

  • (mixin) removeEventListener(eventTypes, handler, contextopt) [source]

    • Alias for off
    Parameter Type Default Description
    eventTypes String event types to unregister, seperated by space if more than one.
    handler function listener handler
    context opt Object null the context of the handler
    Mixes From:
    Returns:
    : this

  • (mixin) listens(eventType, hanlderopt, contextopt) [source]

    • Returns listener's count registered for the event type.
    Parameter Type Default Description
    eventType String an event type
    hanlder opt function null listener function
    context opt Object null the context of the handler
    Mixes From:
    Returns:
    Number:

  • (mixin) copyEventListeners(target) [source]

    • Copy all the event listener to the target object
    Parameter Type Description
    target Object target object to copy to.
    Mixes From:
    Returns:
    : this

  • (mixin) fire(eventType, param) [source]

    • Fire an event, causing all handlers for that event name to run.
    Parameter Type Description
    eventType String an event type to fire
    param Object parameters for the listener function.
    Mixes From:
    Returns:
    : this

  • (inherited) callInitHooks() [source]

    • Visit and call all the init hooks defined on Class and its parents.
    Inherited From:
    Returns:
    Class: this

  • (inherited) setOptions(options) [source]

    • Merges options with the default options of the object.
    Parameter Type Description
    options Object options to set
    Inherited From:
    Returns:
    Class: this

  • (inherited) config(conf) [source]

    • 1. Return object's options if no parameter is provided.
    2. update an option and enable/disable the handler if a handler with the same name existed. 
    // Get marker's options;
var options = marker.config();
// Set map's option "draggable" to false and disable map's draggable handler.
map.config('draggable', false);
// You can update more than one options like this:
map.config({
    'scrollWheelZoom' : false,
    'doubleClickZoom' : false
});
    Parameter Type Description
    conf Object config to update
    Inherited From:
    Returns:
    Class: this

  • (inherited) onConfig() [source]

    • Default callback when config is called
    Inherited From:

    Events

  • add [source]

    • add event.
    Properties:
    Name Type Description
    type String add
    target ui.UIComponent UIComponent
    Source:

  • showstart [source]

    • showstart event.
    Properties:
    Name Type Description
    type String showstart
    target ui.UIComponent UIComponent
    Source:

  • showend [source]

    • showend event.
    Properties:
    Name Type Description
    type String showend
    target ui.UIComponent UIComponent
    Source:

  • hide [source]

    • hide event.
    Properties:
    Name Type Description
    type String hide
    target ui.UIComponent UIComponent
    Source:

  • remove [source]

    • remove event.
    Properties:
    Name Type Description
    type String remove
    target ui.UIComponent UIComponent
    Source: