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: Font
[ AMD Module Require | Legacy Module Require ]
require(["esri/symbols/Font"], function(Font) { /* code goes here */ });
Description
(Added at v1.0)
Font used for text symbols added to the graphics layer.
Note that
variant is deprecated, and will not available in version 4.Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new Font() | Creates a new Font object. |
| new Font(size?, style?, variant?, weight?, family?) | Creates a new Font object. |
| new Font(json) | Creates a new Font object using a JSON object. |
Constants
| Name | Description |
|---|---|
STYLE_ITALIC | Text is in italics. |
STYLE_NORMAL | Text style is normal. |
STYLE_OBLIQUE | Text is slanted. |
VARIANT_NORMAL | Text variant is normal. Deprecated |
VARIANT_SMALLCAPS | Text is in all small caps. Deprecated |
WEIGHT_BOLD | Text weight is bold. |
WEIGHT_BOLDER | Text weight is extra bold. |
WEIGHT_LIGHTER | Text weight is lighter than normal. |
WEIGHT_NORMAL | Text weight is normal. |
Properties
| Name | Type | Summary |
|---|---|---|
| decoration | String | Text decoration. |
| family | String | Font family. |
| size | Number | Font size. |
| style | String | Text style. |
| variant | String | Text variant (deprecated). |
| weight | String | Text weight. |
Methods
| Name | Return type | Summary |
|---|---|---|
| setDecoration(decoration) | Font | Updates the font with the given decoration. |
| setFamily(family) | Font | Sets the font family. |
| setSize(size) | Font | Sets the font size. |
| setStyle(style) | Font | Sets the font style. |
| setVariant(variant) | Font | Sets the font variant (deprecated). |
| setWeight(weight) | Font | Sets the font weight. |
Constructor Details
Creates a new Font object. This constructor takes no parameters.
Sample:
require([
"esri/symbols/Font", ...
], function(Font, ... ) {
var font = new Font();
...
});
Creates a new Font object.
Parameters:
< |
Optional | Font size. Values can be in "pt", "px", "em", and "%". For example: "12pt", "12px", ".8em", "80%". If no unit is specified with number, defaults to "px". |
< |
Optional | Font style. See Constants table for values. |
< |
Optional | Font variant. See Constants table for values. |
< |
Optional | Font weight. See Constants table for values. |
< |
Optional | Font family. |
Sample:
require([
"esri/symbols/Font", ...
], function(Font, ... ) {
var font = new Font("20pt", Font.STYLE_ITALIC,
Font.VARIANT_NORMAL, Font.WEIGHT_BOLD,"Courier");
...
});
Creates a new Font object using a JSON object.
Parameters:
< |
Required | JSON object representing the font. |
Property Details
<String
StringText decoration. (Added at v3.8)
Known values:
"underline" | "line-through" | "none"Default value:
"none"<String
StringText style. See the Constants table for valid values.
Default value:
STYLE_NORMALSee also: setStyle()
<String
StringText variant (deprecated). See the Constants table for valid values.
Default value:
VARIANT_NORMALSee also: setVariant()
<String
StringText weight. See the Constants table for valid values.
Default value:
WEIGHT_NORMALSee also: setWeight()
Method Details
Updates the font with the given decoration. (Added at v3.8)
Return type:
FontParameters:
< |
Required | Text decoration. See decoration property for the list of supported decorations. |
Sets the font family. The font family property does not work in Internet Explorer 7; Arial is always used.
Return type:
FontParameters:
< |
Required | Font family. |
See also: family
Sets the font size. If no unit is specified with number, defaults to pixels, "px."
Return type:
FontParameters:
< |
Required | Font size. Values can be in "pt", "px", "em", and "%". For example: "12pt", "12px", ".8em", "80%". If no unit is specified with number, defaults to "px". |
Sample:
font.setSize("12pt");
See also: size
Sets the font style.
Return type:
FontParameters:
< |
Required | Font style. See Constants table for values. |
See also: style