Files
openlayers/src/ol/style/textstyle.js
Andreas Hocevar fbdbbfb7a7 Get rid of stability annotations and document stability with api
This change adds a stability value to the api annotation, with
'experimental' as default value.

enum, typedef and event annotations are never exportable, but
api annotations are needed there to make them appear in the
docs.

Nested typedefs are no longer inlined recursively, because the
resulting tables get too wide with the current template.
2014-04-29 09:53:07 -06:00

162 lines
2.6 KiB
JavaScript

goog.provide('ol.style.Text');
/**
* @constructor
* @param {olx.style.TextOptions=} opt_options Options.
* @todo api
*/
ol.style.Text = function(opt_options) {
var options = goog.isDef(opt_options) ? opt_options : {};
/**
* @private
* @type {string|undefined}
*/
this.font_ = options.font;
/**
* @private
* @type {number|undefined}
*/
this.rotation_ = options.rotation;
/**
* @private
* @type {number|undefined}
*/
this.scale_ = options.scale;
/**
* @private
* @type {string|undefined}
*/
this.text_ = options.text;
/**
* @private
* @type {string|undefined}
*/
this.textAlign_ = options.textAlign;
/**
* @private
* @type {string|undefined}
*/
this.textBaseline_ = options.textBaseline;
/**
* @private
* @type {ol.style.Fill}
*/
this.fill_ = goog.isDef(options.fill) ? options.fill : null;
/**
* @private
* @type {ol.style.Stroke}
*/
this.stroke_ = goog.isDef(options.stroke) ? options.stroke : null;
/**
* @private
* @type {number}
*/
this.offsetX_ = goog.isDef(options.offsetX) ? options.offsetX : 0;
/**
* @private
* @type {number}
*/
this.offsetY_ = goog.isDef(options.offsetY) ? options.offsetY : 0;
};
/**
* @return {string|undefined} Font.
* @todo api
*/
ol.style.Text.prototype.getFont = function() {
return this.font_;
};
/**
* @return {number} Horizontal text offset.
*/
ol.style.Text.prototype.getOffsetX = function() {
return this.offsetX_;
};
/**
* @return {number} Vertical text offset.
*/
ol.style.Text.prototype.getOffsetY = function() {
return this.offsetY_;
};
/**
* @return {ol.style.Fill} Fill style.
* @todo api
*/
ol.style.Text.prototype.getFill = function() {
return this.fill_;
};
/**
* @return {number|undefined} Rotation.
* @todo api
*/
ol.style.Text.prototype.getRotation = function() {
return this.rotation_;
};
/**
* @return {number|undefined} Scale.
* @todo api
*/
ol.style.Text.prototype.getScale = function() {
return this.scale_;
};
/**
* @return {ol.style.Stroke} Stroke style.
* @todo api
*/
ol.style.Text.prototype.getStroke = function() {
return this.stroke_;
};
/**
* @return {string|undefined} Text.
* @todo api
*/
ol.style.Text.prototype.getText = function() {
return this.text_;
};
/**
* @return {string|undefined} Text align.
* @todo api
*/
ol.style.Text.prototype.getTextAlign = function() {
return this.textAlign_;
};
/**
* @return {string|undefined} Text baseline.
* @todo api
*/
ol.style.Text.prototype.getTextBaseline = function() {
return this.textBaseline_;
};