Timemap.js v.1.6

Class Index | File Index

Class TimeMapTheme

Defined in:
timemap.js

Predefined visual themes for datasets, defining colors and images for map markers and timeline events. Note that theme is only used at creation time - updating the theme of an existing object won't do anything.

Constructor

TimeMapTheme(options)

Static Methods

Method
TimeMapTheme.create(theme, options)
Create a theme, based on an optional new or pre-set theme

Fields

Field
classicTape :{Boolean}
Whether to use the "classic" style timeline event tape
color :{String}
Default color in hex
eventColor :{String}
Background color for duration events
eventIcon :{String}
Full URL for instant event icons
eventIconImage :{String}
Filename of instant event icon image
eventIconPath :{String}
Path to instant event icon directory
eventTextColor :{String}
Text color for duration events
fillColor :{String}
Fill color for polygons
fillOpacity :{Number}
Opacity for polygon fill
icon :{GIcon}
Marker icon for placemarks
iconImage :{String}
Icon image for marker placemarks
lineColor :{String}
Line color for polylines
lineOpacity :{Number}
Opacity for polylines
lineWeight :{Number}
Line weight in pixels for polylines
polgonLineOpacity :{Number}
Opacity for polygon outlines
polygonLineColor :{String}
Line color for polygons
polygonLineWeight :{Number}
Line weight for polygon outlines
Class Detail
TimeMapTheme(options)
Parameters (optional)
options {Object} A container for optional arguments
options.icon {GIcon} Icon for marker placemarks.
Default: G_DEFAULT_ICON
options.iconImage {String} Icon image for marker placemarks (assumes G_MARKER_ICON for the rest of the icon settings)
Default: red-dot.png
options.color {String} Default color in hex for events, polylines, polygons.
Default: #FE766A
options.lineColor {String} Color for polylines.
Default: color
options.polygonLineColor {String} Color for polygon outlines.
Default: lineColor
options.lineOpacity {Number} Opacity for polylines.
Default: 1
options.polgonLineOpacity {Number} Opacity for polygon outlines.
Default: lineOpacity
options.lineWeight {Number} Line weight in pixels for polylines.
Default: 2
options.polygonLineWeight {Number} Line weight for polygon outlines.
Default: lineWeight
options.fillColor {String} Color for polygon fill.
Default: color
options.fillOpacity {String} Opacity for polygon fill.
Default: 0.25
options.eventColor {String} Background color for duration events.
Default: color
options.eventTextColor {String} Text color for events (null=Timeline default).
Default: null
options.eventIconPath {String} Path to instant event icon directory.
Default: timemap/images/
options.eventIconImage {String} Filename of instant event icon image.
Default: red-circle.gif
options.eventIcon {URL} URL for instant event icons.
Default: eventIconPath+eventIconImage
options.classicTape {Boolean} Whether to use the "classic" style timeline event tape (needs additional css to work - see examples/artists.html).
Default: false
Static Method Details
TimeMapTheme.create(theme, options) :{TimeMapTheme}
Create a theme, based on an optional new or pre-set theme
Parameters (optional)
theme {TimeMapTheme} Existing theme to clone
options {Object} Optional settings to overwrite - see TimeMapTheme
Returns:
{TimeMapTheme} Configured theme
Field Details
classicTape :{Boolean}
Whether to use the "classic" style timeline event tape
color :{String}
Default color in hex
eventColor :{String}
Background color for duration events
eventIcon :{String}
Full URL for instant event icons
eventIconImage :{String}
Filename of instant event icon image
eventIconPath :{String}
Path to instant event icon directory
eventTextColor :{String}
Text color for duration events
fillColor :{String}
Fill color for polygons
fillOpacity :{Number}
Opacity for polygon fill
icon :{GIcon}
Marker icon for placemarks
iconImage :{String}
Icon image for marker placemarks
lineColor :{String}
Line color for polylines
lineOpacity :{Number}
Opacity for polylines
lineWeight :{Number}
Line weight in pixels for polylines
polgonLineOpacity :{Number}
Opacity for polygon outlines
polygonLineColor :{String}
Line color for polygons
polygonLineWeight :{Number}
Line weight for polygon outlines
©2010 Nick Rabinowitz
Documentation generated by JsDoc Toolkit 2.3.2 on Thu Jun 24 2010 13:58:04 GMT-0700 (PDT)