Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: TextSymbol
[ AMD Module Require | Legacy Module Require ]
require(["esri/symbols/TextSymbol"], function(TextSymbol) { /* code goes here */ });
Description
(Added at v1.0)
Text symbols are used to add text on the graphics layer. Text symbols can also be used to define the symbol property of Graphic if the geometry type is Point or Multipoint.Samples
Search for samples that use this class.Class hierarchy
esri/symbols/Symbol |_esri/symbols/TextSymbol
Constructors
| Name | Summary |
|---|---|
| new TextSymbol(text) | Creates a new TextSymbol object that includes only the text. |
| new TextSymbol(text, font, color) | Creates a new TextSymbol object. |
| new TextSymbol(json) | Creates a new TextSymbol object using a JSON object. |
Constants
| Name | Description |
|---|---|
ALIGN_END | The end of the text string is aligned with the point. |
ALIGN_MIDDLE | The center of the text string is aligned with the point. |
ALIGN_START | The beginning of the text string is aligned with the point. |
DECORATION_LINETHROUGH | Text has a lined striked through it. |
DECORATION_NONE | Text has no decoration. |
DECORATION_OVERLINE | Text has a line along the top. |
DECORATION_UNDERLINE | Text is underlined. |
Properties
| Name | Type | Summary |
|---|---|---|
| align | String | The text alignment in relation to the point. |
| angle | Number | Text angle. |
| color | Color | Symbol color. |
| decoration | String | The decoration on the text. |
| font | Font | Font for displaying text. |
| haloColor | Color | The halo color used for the text symbol. |
| haloSize | Number | The size (in pixel units) used if setting a halo on a text symbol. |
| horizontalAlignment | String | Horizontal alignment of the text with respect to the graphic. |
| kerning | Boolean | Determines whether to adjust the spacing between characters in the text string. |
| rotated | Boolean | Determines whether every character in the text string is rotated. |
| text | String | Text string for display in the graphics layer. |
| type | String | The type of symbol. |
| verticalAlignment | String | Vertical alignment of the text with respect to the graphic.Vertical alignment is not supported in Internet Explorer versions 7-10. |
| xoffset | Number | The offset on the x-axis in pixels from the point. |
| yoffset | Number | The offset on the y-axis in pixels from the point. |
Methods
| Name | Return type | Summary |
|---|---|---|
| setAlign(align) | TextSymbol | Sets the alignment of the text. |
| setAngle(angle) | TextSymbol | Sets the angle of the text. |
| setColor(color) | Symbol | Sets the symbol color. |
| setDecoration(decoration) | TextSymbol | Sets the decoration for the text. |
| setFont(font) | TextSymbol | Sets the text font. |
| setHaloColor(color) | TextSymbol | Sets a halo color for the text symbol.NOTE: Known limitations when working with the text symbol halo:
|
| setHaloSize(size) | TextSymbol | Sets the size of the halo (in pixels) used for the text symbol.NOTE: Known limitations when working with the text symbol halo:
|
| setHorizontalAlignment(alignment) | TextSymbol | Updates the horizontal alignment of the text symbol. |
| setKerning(kerning) | TextSymbol | Sets whether to adjust the spacing between characters in the text string. |
| setOffset(x, y) | TextSymbol | Sets the x and y offset of the text. |
| setRotated(rotated) | TextSymbol | Sets whether every character in the text string is rotated. |
| setText(text) | TextSymbol | Sets the text string. |
| setVerticalAlignment(alignment) | TextSymbol | Updates the vertical alignment of the text symbol. |
| toJson() | Object | Converts object to its ArcGIS Server JSON representation. |
Constructor Details
Creates a new TextSymbol object that includes only the text.
Parameters:
< |
Required | Text string for display in the graphics layer. |
Sample:
Create a new text symbol using the default values for color, size, etc.
require([
"esri/symbols/TextSymbol", ...
], function(TextSymbol, ... ) {
var textSym = new TextSymbol("Hello World");
...
});
Create a new text symbol and set new values for color, weight, font and angle.
require([
"esri/symbols/TextSymbol", "esri/Color", "esri/symbols/Font", ...
], function(TextSymbol, Color, Font, ... ) {
var textSymbol = new TextSymbol("Hello World").setColor(
new Color([128,0,0])).setAlign(Font.ALIGN_START).setAngle(45).setFont(
new Font("12pt").setWeight(Font.WEIGHT_BOLD)) ;
...
});
Creates a new TextSymbol object.
Creates a new TextSymbol object using a JSON object.
Parameters:
< |
Required | JSON object representing the TextSymbol. View the Symbol Objects (Common data types in ArcGIS) for details
on creating a JSON symbol. Note that when specifying symbol width and height using JSON the values should be entered in points, the JavaScript API then converts the point values to pixels. The TextSymbol does not support backgroundColor, borderLineColor, verticalAlignment or horizontalAlignment properties. |
Property Details
<String
StringThe text alignment in relation to the point. See the Constants table for valid values. Deprecated at v3.8. Use
horizontalAlignment and verticalAlignment instead.Default value:
ALIGN_MIDDLESee also: setAlign()
<Number
NumberText angle. 0 is horizontal and the angle moves clockwise.
Default value:
0See also: setAngle()
<Color
ColorSymbol color.
<String
StringThe decoration on the text. See the Constants table for valid values. Deprecated at v3.8. Use Font.decoration instead.
Default value:
DECORATION_NONESee also: setDecoration()
<Color
ColorThe halo color used for the text symbol.Known limitations:
- IE 9 and below not supported.
- Sub-pixel halo (i.e. fractional size such as 1.25px) renders inconsistently in various browsers.
<Number
NumberThe size (in pixel units) used if setting a halo on a text symbol.Known limitations:
- IE 9 and below not supported.
- Sub-pixel halo (i.e. fractional size such as 1.25px) renders inconsistently in various browsers.
<String
StringHorizontal alignment of the
text with respect to the graphic. (Added at v3.8)Known values:
"left" | "right" | "center" | "justify"Default value:
"center"<Boolean
BooleanDetermines whether to adjust the spacing between characters in the text string.
Known values:
true | falseDefault value:
trueSee also: setKerning()
<Boolean
BooleanDetermines whether every character in the text string is rotated.
Known values:
true | falseDefault value:
falseSee also: setRotated()
<String
StringThe type of symbol.
Known values:
simplemarkersymbol | picturemarkersymbol | simplelinesymbol | cartographiclinesymbol | simplefillsymbol | picturefillsymbol | textsymbol<String
StringVertical alignment of the
Vertical alignment is not supported in Internet Explorer versions 7-10. Also, it is not supported when the graphics layer uses HTML Canvas to draw graphics. (Added at v3.8)
text with respect to the graphic.Vertical alignment is not supported in Internet Explorer versions 7-10. Also, it is not supported when the graphics layer uses HTML Canvas to draw graphics. (Added at v3.8)
Known values:
"baseline" | "top" | "middle" | "bottom"Default value:
"baseline"<Number
NumberThe offset on the x-axis in pixels from the point.
Default value:
0See also: setOffset()
<Number
NumberThe offset on the y-axis in pixels from the point.
Default value:
0See also: setOffset()
Method Details
Sets the alignment of the text. Deprecated at v3.8. Use
setHorizontalAlignment and setVerticalAlignment instead.Return type:
TextSymbolParameters:
< |
Required | The text alignment. See the Constants table for valid values. |
Sample:
require([
"esri/symbols/TextSymbol", ...
], function(TextSymbol, ... ) {
var textSymbol = new TextSymbol();
textSymbol.setAlign(TextSymbol.ALIGN_START);
...
});
See also: align
Sets the angle of the text.
Return type:
TextSymbolParameters:
< |
Required | Angle value between 0 and 359. |
Sample:
textSymbol.setAngle(15);
See also: angle
Sets the symbol color.
Return type:
SymbolParameters:
< |
Required | Symbol color. |
Sample:
require([
"esri/Color", ...
], function(Color, ... ) {
symbol.setColor(new Color([255,255,0,0.5]));
...
});
Sets the decoration for the text. Many browsers including Internet Explorer 7, Firefox and Opera 9 do not support the decoration properties for text symbols. Deprecated at v3.8. Use Font.setDecoration instead.
Return type:
TextSymbolParameters:
< |
Required | The decoration on the text. See the Constants table for valid values. |
See also: decoration
Sets the text font.
Return type:
TextSymbolParameters:
< |
Required | Text font. |
Sample:
require([
"esri/symbols/TextSymbol", "esri/symbols/Font", ...
], function(TextSymbol, Font, ... ) {
var textSymbol = new TextSymbol( ... );
var font = new Font();
font.setSize("12pt");
font.setWeight(Font.WEIGHT_BOLD);
textSymbol.setFont(font);
...
});
See also: font
Sets a halo color for the text symbol.NOTE: Known limitations when working with the text symbol halo:
- IE 9 and below not supported.
- Sub-pixel halo (i.e. fractional size such as 1.25px) renders inconsistently in various browsers.
Return type:
TextSymbolParameters:
< |
Required | The color used for the text symbol halo. |
Sample:
ts.setHaloColor(new Color([255, 0, 0]));
Sets the size of the halo (in pixels) used for the text symbol.NOTE: Known limitations when working with the text symbol halo:
- IE 9 and below not supported.
- Sub-pixel halo (i.e. fractional size such as 1.25px) renders inconsistently in various browsers.
Return type:
TextSymbolParameters:
< |
Required | The size (in pixels) of the text symbol halo. |
Sample:
ts.setHaloSize(1);
Updates the horizontal alignment of the text symbol. (Added at v3.8)
Return type:
TextSymbolParameters:
< |
Required | Horizontal alignment of the text with respect to the graphic. See horizontalAlignment property for the list of supported options. |
Sets whether to adjust the spacing between characters in the text string.
Return type:
TextSymbolParameters:
< |
Required | Set to true for kerning. |
See also: kerning
Sets the x and y offset of the text.
Return type:
TextSymbolSets whether every character in the text string is rotated. Many browsers including Internet Explorer 7, Firefox and Opera 9 do not support rotated for text symbols.
Return type:
TextSymbolParameters:
< |
Required | Set to true to rotate all characters in the string. |
See also: rotated
Sets the text string.
Return type:
TextSymbolParameters:
< |
Required | The text string. |
See also: text
Updates the vertical alignment of the text symbol. (Added at v3.8)
Return type:
TextSymbolParameters:
< |
Required | Vertical alignment of the text with respect to the graphic. See verticalAlignment property for the list of supported options. |