new CopyRight()
This class defines the CopyRight object
Parameters:
Name | Type | Description |
---|---|---|
options. |
Object | An object, or literal, specifying the content and style. It has the following attributes.
|
Returns:
An instance of OM.control.CopyRight
- Type
- OM.control.CopyRight
Extends
Methods
-
isVisible()
-
Get the visibility of the decoration.
- Inherited From:
Returns:
True if the decoration is currently visible,
False if the decoration is currently not visible.- Type
- Boolean
-
on()
-
A shorthand name for the member function addListener.
- Inherited From:
- Mixes In:
-
setDraggable()
-
Set whether the decoration should be draggable
Parameters:
Name Type Description draggable.
Boolean True if draggable, false if not.
- Inherited From:
Returns:
- Type
- void
-
setPosition(offsetX, offsetY)
-
Set the map decoration position
Parameters:
Name Type Description offsetX
Float in pixels to the dock icon if the value is greater than 1, or percentage if it is less than 1.
offsetY
Float in pixels to the dock icon if the value is greater than 1, or percentage if it is less than 1.
- Inherited From:
Returns:
- Type
- void
-
setSize(width, height)
-
Set the map decoration size
Parameters:
Name Type Description width
int height
int - Inherited From:
Returns:
- Type
- void
-
setStyle(contentStyle)
-
Set the text style for the copyright content
Parameters:
Name Type Description contentStyle
Object : Object, or literal specifying the font family and size.
- fontSize {int} The fon t size in points
- fontFamily {String} The font-family name, e.g. Helvetica
-
setVisible(visible)
-
Set the visibility.
Parameters:
Name Type Description visible
Boolean True if visible, false if not.
- Inherited From:
Returns:
- Type
- void