org.cesiumjs.cs.core

Class PinBuilder

java.lang.Object

org.cesiumjs.cs.core.PinBuilder

@JsType(isNative=true,
        namespace="Cesium",
        name="PinBuilder")
public class PinBuilder
extends Object

Author:

Serge Silaev aka iSergio

Constructor Summary

Constructors

Constructor and Description
PinBuilder() A utility class for generating custom map pins as canvas elements.

Method Summary

Modifier and Type	Method and Description
com.google.gwt.dom.client.CanvasElement	fromColor(Color color, int size) Creates an empty pin of the specified color and size.
com.google.gwt.dom.client.CanvasElement	fromMakiIconId(String id, Color color, int size) Creates a pin with the specified maki icon identifier, color, and size.
Promise<com.google.gwt.dom.client.CanvasElement,Void>	fromMakiIconIdPromise(String id, Color color, int size) Creates a pin with the specified maki icon identifier, color, and size.
com.google.gwt.dom.client.CanvasElement	fromText(String text, Color color, int size) Creates a pin with the specified text, color, and size.
com.google.gwt.dom.client.CanvasElement	fromUrl(String url, Color color, int size) Creates a pin with the specified icon, color, and size.
Promise<com.google.gwt.dom.client.CanvasElement,Void>	fromUrlPromise(String url, Color color, int size) Creates a pin with the specified icon, color, and size.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PinBuilder

@JsConstructor
public PinBuilder()

A utility class for generating custom map pins as canvas elements.

Method Detail

fromColor

@JsMethod
public com.google.gwt.dom.client.CanvasElement fromColor(Color color,
                                                                   int size)

Creates an empty pin of the specified color and size.

Parameters:

color - The color of the pin.

size - The size of the pin, in pixels.

Returns:

The canvas element that represents the generated pin.

fromMakiIconId

@JsMethod
public com.google.gwt.dom.client.CanvasElement fromMakiIconId(String id,
                                                                        Color color,
                                                                        int size)

Creates a pin with the specified maki icon identifier, color, and size.

Parameters:

id - The id of the maki icon to be stamped onto the pin.

color - The color of the pin.

size - The size of the pin, in pixels.

Returns:

The canvas element to the canvas element that represents the generated pin.

fromMakiIconIdPromise

@JsMethod(name="fromMakiIconId")
public Promise<com.google.gwt.dom.client.CanvasElement,Void> fromMakiIconIdPromise(String id,
                                                                                                                    Color color,
                                                                                                                    int size)

Creates a pin with the specified maki icon identifier, color, and size.

Parameters:

id - The id of the maki icon to be stamped onto the pin.

color - The color of the pin.

size - The size of the pin, in pixels.

Returns:

The Promise to the canvas element that represents the generated pin.

fromText

@JsMethod
public com.google.gwt.dom.client.CanvasElement fromText(String text,
                                                                  Color color,
                                                                  int size)

Creates a pin with the specified text, color, and size. The text will be sized to be as large as possible while still being contained completely within the pin.

Parameters:

text - The text to be stamped onto the pin.

color - The color of the pin.

size - The size of the pin, in pixels.

Returns:

The canvas element that represents the generated pin.

fromUrl

@JsMethod
public com.google.gwt.dom.client.CanvasElement fromUrl(String url,
                                                                 Color color,
                                                                 int size)

Creates a pin with the specified icon, color, and size.

Parameters:

url - The url of the image to be stamped onto the pin.

color - The color of the pin.

size - The size of the pin, in pixels.

Returns:

The canvas element or a Promise to the canvas element that represents the generated pin.

fromUrlPromise

@JsMethod(name="fromUrl")
public Promise<com.google.gwt.dom.client.CanvasElement,Void> fromUrlPromise(String url,
                                                                                                      Color color,
                                                                                                      int size)

Creates a pin with the specified icon, color, and size.

Parameters:

url - The url of the image to be stamped onto the pin.

color - The color of the pin.

size - The size of the pin, in pixels.

Returns:

The canvas element or a Promise to the canvas element that represents the generated pin.