Telogis.GeoBase.MapLayers.Balloon

Arguments

• config (Object) - Configuration options for the MapLayers.Balloon.

  Properties

  Name	Type	Description
  behavior	Number	The behavior pattern that determines how the balloon responds to UI events. This may be any meaningful combination of the static behavior flags on the MapLayers.Balloon object. Defaults to Balloon.HOVER_ACTIVE. This property may also be referenced by the name: behaviour.
  content	String	The HTML or text to display in the balloon. Defaults to ''.
  contentFunc ()	Function	A function to provide the content of the balloon, which will be re-evaluated each time the balloon is shown. This should take no arguments, and return an HTML string. Either content or contentFunc should be provided, not both. Returns String - The HTML string to populate the balloon with.
  hAlign	Number	The horizontal alignment of the balloon relative to its target element. Valid values for this are MapLayers.Balloon.ALIGN_LEFT and MapLayers.Balloon.ALIGN_RIGHT. Defaults to Balloon.ALIGN_RIGHT.
  location	LatLon	The location on the map that the balloon should originate from. Defaults to new LatLon (0.0, 0.0).
  show	Boolean	Whether the balloon should be initially shown. Defaults to false.
  skin	MapLayers.BalloonSkin	A reference to the skin to use for the balloon. Several of these are pre-defined as static properties of the MapLayers.BalloonSkin object. Defaults to BalloonSkin.standard.
  vAlign	String	The vertical alignment of the balloon relative to its target element. Valid values for this are MapLayers.Balloon.ALIGN_TOP and MapLayers.Balloon.ALIGN_BOTTOM. Defaults to Balloon.ALIGN_TOP.

Removes all the events registered to describe the balloon's behavior, either as a deallocation step or so that a new behavior can be set up.

// Create a Balloon instance on the map ('map') with a balloon containing text
var myBalloon = new Telogis.GeoBase.MapLayers.Balloon({
    content: "<a href='http://www.telogis.com'>Telogis</a>",
    location: new Telogis.GeoBase.LatLon(33.587137,-117.742878),
    show: true,
    map: map
});

// Call a test function when the canvas is clicked
document.onclick = myTestFunction;
function myTestFunction() {
    // Clear the Balloon's behavior, returning it to default state
    myBalloon.clearBehavior();
};

Releases all resources used by the balloon when it is no longer needed, and frees the corresponding memory to avoid leaks.

// Create a Balloon instance on the map ('map') with a balloon containing text
var myBalloon = new Telogis.GeoBase.MapLayers.Balloon({
    content: "<a href='http://www.telogis.com'>Telogis</a>",
    location: new Telogis.GeoBase.LatLon(33.587137,-117.742878),
    show: true,
    map: map
});

// Call a test function when the canvas is clicked
document.onclick = myTestFunction;
function myTestFunction() {
    // Destroy the Balloon object
    myBalloon.destroy();
};

A wrapper for AbstractDOMEntity.hide that only takes action if the balloon has not had its visibility explicitly adjusted. This enables manual handling of balloon toggling in addition to a default behavior. Additionally, if the balloon is in a suspended state (i.e. part-way through another action) the hide is queued until that action completes.

// Create a Balloon instance on the map ('map') with a balloon containing text
var myBalloon = new Telogis.GeoBase.MapLayers.Balloon({
    content: "<a href='http://www.telogis.com'>Telogis</a>",
    location: new Telogis.GeoBase.LatLon(33.587137,-117.742878),
    show: true,
    map: map
});

// Call a test function when the canvas is clicked
document.onclick = myTestFunction;
function myTestFunction() {
    // Hide the Balloon object
    myBalloon.hide();
};

Sets the horizontal and vertical alignments of the balloon, relative to its target element.

// Create a Balloon instance on the map ('map') with a balloon containing text or HTML
var myBalloon = new Telogis.GeoBase.MapLayers.Balloon({
    content: "<a href='http://www.telogis.com'>Telogis</a>",
    location: new Telogis.GeoBase.LatLon(33.587137,-117.742878),
    show: true,
    map: map
});

// Call a test function when the canvas is clicked
document.onclick = myTestFunction;
function myTestFunction() {
    // Change Balloon alignment to bottom-left of the target location
    myBalloon.setAlignment(Telogis.GeoBase.MapLayers.Balloon.ALIGN_LEFT,
        Telogis.GeoBase.MapLayers.Balloon.ALIGN_BOTTOM);
};

• (Optional) hAlign (Number) - A static flag of the MapLayers.Balloon object representing the horizontal alignment of the balloon. For example, MapLayers.Balloon.ALIGN_LEFT causes the balloon to be positioned to the left of its target element. Defaults to this._hAlign.

• (Optional) vAlign (Number) - A static flag of the MapLayers.Balloon object representing the vertical alignment of the balloon. For example, MapLayers.Balloon.ALIGN_TOP causes the balloon to be positioned above its target element. Defaults to this._vAlign.

Sets up the balloon to behave in a certain way, as described at creation or passed as a parameter.

// Create a Balloon instance on the map ('map') with a balloon containing HTML or text
var myBalloon = new Telogis.GeoBase.MapLayers.Balloon({
    content: "<a href='http://www.telogis.com'>Telogis</a>",
    location: new Telogis.GeoBase.LatLon(33.587137,-117.742878),
    show: true,
    map: map
});

// Set the Balloon's behavior to hide on right-click
myBalloon.setBehavior(Telogis.GeoBase.MapLayers.Balloon.BALLOON_RIGHT_CLICK_HIDE);

• (Optional) behavior (Number) - The behavior pattern that determines how the balloon responds to UI events. This may be any meaningful combination of the MapLayers.Balloon object's static behavior flags. Defaults to this._behavior.

• (Optional) target (Element) - The element from which the balloon should respond to events. Defaults to this._target.

Sets or changes the HTML displayed inside the balloon. This also re-calculates the dimensions of the balloon's body accordingly.

// Create a Balloon instance on the map ('map') with a balloon containing text
var myBalloon = new Telogis.GeoBase.MapLayers.Balloon({
    content: 'Click me to change this text content',
    location: new Telogis.GeoBase.LatLon(33.587137,-117.742878),
    show: true,
    map: map
});

// Call a test function when the canvas is clicked
document.onclick = myTestFunction;
function myTestFunction() {
    // Change the balloon's content
    myBalloon.setContent('You just clicked the balloon'); // Text or HTML
};

• content (String) - The HTML to display in the balloon's body element.

• content (Element) - The DOM element to attach to the balloon's body. If the content is not a string, it is assumed to be a DOM element.

Sets or changes the function used to recalculate the HTML to display inside the balloon.

// Create some test functions
var newDiv = document.createElement('Div');
newDiv.appendChild(document.createTextNode('Click Me'));
newDiv.onclick = function() {alert('You clicked me! You should click a button next.')};
var updateDiv = document.createElement('Button');
updateDiv.appendChild(document.createTextNode('Now Click This Button'));
updateDiv.onclick = function() {alert('You clicked the button on '+ Date())};

// Create a Balloon instance on the map ('map') with balloon content generated from a function
var myBalloon = new Telogis.GeoBase.MapLayers.Balloon({
    contentFunc: function() {return newDiv},
    location: new Telogis.GeoBase.LatLon(33.587137,-117.742878),
    show: true,
    map: map
});

// Call a test function when the canvas is clicked
document.onclick = myTestFunction;
function myTestFunction() {
    // Change the balloon's content function
    myBalloon.setContentFunc(function() {return updateDiv});
};

• (Optional) contentFunc (Function) - The function to use. This should take no arguments, and return a HTML string. Defaults to this._contentFunc.

Sets the layer containing the balloon in the same way as for any other map object, but ensures that its alignment is correctly updated once this operation has completed.

• newLayer (Widgets.Map or MapLayers.ObjectLayer or MapLayers.XSLTObjectLayer or String) - The layer to attach the calling object to.

Repositions the element used to display the MapLayers.Balloon.

// Create a Balloon instance on the map ('map') with a balloon containing text
var myBalloon = new Telogis.GeoBase.MapLayers.Balloon({
    content: 'Balloon Text',
    location: new Telogis.GeoBase.LatLon(33.587137,-117.742878),
    show: true,
    map: map
});

// Call a test function when the canvas is clicked
document.onclick = myTestFunction;
function myTestFunction() {
    // Move the location of the balloon to a new LatLon coordinate
    myBalloon.setLocation(new Telogis.GeoBase.LatLon(33.573873,-117.772208));
};

• pos (Point or LatLon) - The location to place the balloon at. This may be specified as a pair of x-y pixel coordinates on the map, or as a latitude-longitude location.

Sets or changes a function to be called each time the balloon is displayed.

• (Optional) showCallback (Function) - The function to call. This should take no arguments. Defaults to this._userShowCallback.

A wrapper for AbstractDOMEntity.show that only takes action if the balloon has not had its visibility explicitly adjusted. This enables manual handling of balloon toggling in addition to a default behavior. Additionally, if the balloon is in a suspended state (i.e. part-way through another action) the show is queued until that action completes.

Manually toggles the balloon. Calls MapLayers.Balloon.toggleOut if the balloon is visible, or MapLayers.Balloon.toggleIn if it is not.

Manually toggles the balloon so it is visible. While this is a wrapper to MapLayers.Balloon.show, it should always be called in its stead if visibility control is desired: a balloon shown with MapLayers.Balloon.toggleIn may only be hidden by MapLayers.Balloon.toggleOut (i.e. is unaffected by mouse events).

Manually toggles the balloon so it is invisible. While this is a wrapper to MapLayers.Balloon.hide, it should always be called in its stead (and in complement with MapLayers.Balloon.toggleIn if visibility control is desired.

Performs any alignment adjustments necessary for the MapLayers.Balloon's behavior when the map it has been placed on is updated.

• updateType (Number) - The flag or combination of flags specifying the type of update that has occurred. Each of these may be any of the static Map.UPDATE_* values.

A flag specifying that the balloon's vertical alignment should be below its target marker.

A flag specifying that the balloon's horizontal alignment should be centered.

A flag specifying that the balloon's horizontal alignment should be to the left of its target marker.

A flag specifying that the balloon's horizontal alignment should be to the right of its target marker.

A flag specifying that the balloon's vertical alignment should be above its target marker.

A flag specifying that a balloon should be hidden when the balloon itself is left-clicked.

A flag specifying that a balloon should be hidden when the balloon itself is right-clicked.

A flag specifying that a balloon should be able to be re-positioned by dragging it within a certain constrained area.

A flag to enable handling of the event triggered when the MapLayers.Balloon is unsuspended.

A flag specifying that a balloon should be shown when the mouse moves over its element, and hidden again once the mouse leaves both its element and the balloon itself.

A combination of MapLayers.Balloon.BALLOON_LEFT_CLICK_HIDE and MapLayers.Balloon.TARGET_LEFT_CLICK_TOGGLE.

A flag specifying no automated toggling behavior for a balloon.

A flag specifying that a balloon should have its alignment automatically changed to keep it in the map viewport for as long as possible (when it may otherwise be moved off the edge by a pan). This behavior is overridden by MapLayers.Balloon.DRAGGABLE.

A combination of MapLayers.Balloon.BALLOON_RIGHT_CLICK_HIDE and MapLayers.Balloon.TARGET_RIGHT_CLICK_TOGGLE.

A flag specifying that the balloon's tag should be aligned either horizontally or vertically depending on which fits best.

A flag specifying that the balloon's tag should be aligned horizontally, i.e., either above or below the balloon. This is the default.

A flag specifying that the balloon's tag should be aligned vertically, i.e., either to the left or to the right of the balloon.

A flag specifying that a balloon should be toggled when its target element is left-clicked.

A flag specifying that a balloon should be toggled when its target element is right-clicked.

An event handler used to queue callbacks (such as calls to MapLayers.Balloon.hide) that cannot be executed while another action is being performed (i.e. the balloon is suspended). Such suspending actions include dragging the balloon, since the balloon should not be hidden during the drag's duration. This handler is triggered once the suspending action completes.