Warning: file_put_contents(/var/www/html/wp-content/shield/test_write_file.txt): failed to open stream: No space left on device in /var/www/html/wp-content/plugins/wp-simple-firewall/src/lib/vendor/fernleafsystems/wordpress-services/src/Core/Fs.php on line 421 Warning: file_put_contents(/var/www/html/wp-content/uploads/shield/test_write_file.txt): failed to open stream: No space left on device in /var/www/html/wp-content/plugins/wp-simple-firewall/src/lib/vendor/fernleafsystems/wordpress-services/src/Core/Fs.php on line 421 Warning: file_put_contents(/tmp/shield/test_write_file.txt): failed to open stream: No space left on device in /var/www/html/wp-content/plugins/wp-simple-firewall/src/lib/vendor/fernleafsystems/wordpress-services/src/Core/Fs.php on line 421 Warning: file_put_contents(/tmp/shield/test_write_file.txt): failed to open stream: No space left on device in /var/www/html/wp-content/plugins/wp-simple-firewall/src/lib/vendor/fernleafsystems/wordpress-services/src/Core/Fs.php on line 421 Warning: Cannot modify header information - headers already sent by (output started at /var/www/html/wp-content/plugins/wp-simple-firewall/src/lib/vendor/fernleafsystems/wordpress-services/src/Core/Fs.php:421) in /var/www/html/wp-includes/rest-api/class-wp-rest-server.php on line 1831 {"id":3887,"date":"2021-04-24T16:55:00","date_gmt":"2021-04-24T12:25:00","guid":{"rendered":"https:\/\/help.map.ir\/?post_type=manual_documentation&p=3887"},"modified":"2021-09-18T14:25:45","modified_gmt":"2021-09-18T09:55:45","slug":"reactsdk-symbollayer","status":"publish","type":"manual_documentation","link":"https:\/\/help.map.ir\/documentation\/reactsdk-docs\/reactsdk-symbollayer\/","title":{"rendered":"SymbolLayer"},"content":{"rendered":"\n

SymbolLayer is a style layer that renders icon and text labels at points or along lines on the map<\/p>\n\n\n\n

\u0642\u0627\u0628\u0644\u06cc\u062a\u200c\u0647\u0627:<\/strong><\/p>\n\n\n\n

Description<\/th>Required<\/th>Default<\/th>Type<\/th>Prop<\/th><\/tr><\/thead>
A string that uniquely identifies the source in the style to which it is added<\/td>false<\/td>none<\/td>string<\/td>id<\/td><\/tr>
The source from which to obtain the data to style, If the source has not yet been added to the current style, the behavior is undefined<\/td>false<\/td>MapboxGL.StyleSource.DefaultSourceID<\/code><\/td>string<\/td>sourceID<\/td><\/tr>
Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style<\/td>false<\/td>none<\/td>string<\/td>sourceLayerID<\/td><\/tr>
Inserts a layer above aboveLayerID<\/td>false<\/td>none<\/td>string<\/td>aboveLayerID<\/td><\/tr>
Inserts a layer below belowLayerID<\/td>false<\/td>none<\/td>string<\/td>belowLayerID<\/td><\/tr>
Inserts a layer below belowLayerID<\/td>false<\/td>none<\/td>number<\/td>layerIndex<\/td><\/tr>
Filter only the features in the source layer that satisfy a condition that you define<\/td>false<\/td>none<\/td>array<\/td>filter<\/td><\/tr>
The minimum zoom level at which the layer gets parsed and appears<\/td>false<\/td>none<\/td>number<\/td>minZoomLevel<\/td><\/tr>
The maximum zoom level at which the layer gets parsed and appears<\/td>false<\/td>none<\/td>number<\/td>maxZoomLevel<\/td><\/tr>
Customizable style attributes<\/td><\/td>none<\/td>union<\/td>style<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Styles<\/h4>\n\n\n

Name<\/h4>\n

symbolPlacement<\/code><\/p>\n

Description<\/h4>\n

Label placement relative to its geometry.<\/p>\n

Type<\/h4>\n

enum<\/code><\/p>\n

Default Value<\/h4>\n

point<\/code><\/p>\n

Supported Values<\/h4>\n

point<\/strong> – The label is placed at the point where the geometry is located.
line<\/strong> – The label is placed along the line of the geometry. Can only be used onLineString<\/code>andPolygon<\/code>geometries.<\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

symbolSpacing<\/code><\/p>\n

Description<\/h4>\n

Distance between two symbol anchors.<\/p>\n

Type<\/h4>\n

number<\/code><\/p>\n

Default Value<\/h4>\n

\u06f2\u06f5\u06f0<\/code><\/p>\n

Units<\/h4>\n

pixels<\/code><\/p>\n

Minimum<\/h4>\n

\u06f1<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

symbolAvoidEdges<\/code><\/p>\n

Description<\/h4>\n

If true, the symbols will not cross tile edges to avoid mutual collisions. Recommended in layers that don’t have enough padding in the vector tile to prevent collisions, or if it is a point symbol layer placed after a line symbol layer.<\/p>\n

Type<\/h4>\n

boolean<\/code><\/p>\n

Default Value<\/h4>\n

false<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

iconAllowOverlap<\/code><\/p>\n

Description<\/h4>\n

If true, the icon will be visible even if it collides with other previously drawn symbols.<\/p>\n

Type<\/h4>\n

boolean<\/code><\/p>\n

Default Value<\/h4>\n

false<\/code><\/p>\n

Requires<\/h4>\n

iconImage<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

iconIgnorePlacement<\/code><\/p>\n

Description<\/h4>\n

If true, other symbols can be visible even if they collide with the icon.<\/p>\n

Type<\/h4>\n

boolean<\/code><\/p>\n

Default Value<\/h4>\n

false<\/code><\/p>\n

Requires<\/h4>\n

iconImage<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

iconOptional<\/code><\/p>\n

Description<\/h4>\n

If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not.<\/p>\n

Type<\/h4>\n

boolean<\/code><\/p>\n

Default Value<\/h4>\n

false<\/code><\/p>\n

Requires<\/h4>\n

iconImage, textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

iconRotationAlignment<\/code><\/p>\n

Description<\/h4>\n

In combination withsymbolPlacement<\/code>, determines the rotation behavior of icons.<\/p>\n

Type<\/h4>\n

enum<\/code><\/p>\n

Default Value<\/h4>\n

auto<\/code><\/p>\n

Supported Values<\/h4>\n

map<\/strong> – Whensymbol-placement<\/code>is set topoint<\/code>, aligns icons east-west. Whensymbol-placement<\/code>is set toline<\/code>, aligns icon x-axes with the line.
viewport<\/strong> – Produces icons whose x-axes are aligned with the x-axis of the viewport, regardless of the value ofsymbol-placement<\/code>.
auto<\/strong> – Whensymbol-placement<\/code>is set topoint<\/code>, this is equivalent toviewport<\/code>. Whensymbol-placement<\/code>is set toline<\/code>, this is equivalent tomap<\/code>.<\/p>\n

Requires<\/h4>\n

iconImage<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

iconSize<\/code><\/p>\n

Description<\/h4>\n

Scales the original size of the icon by the provided factor. The new pixel size of the image will be the original pixel size multiplied byiconSize<\/code>. \u06f1 is the original size; 3 triples the size of the image.<\/p>\n

Type<\/h4>\n

number<\/code><\/p>\n

Default Value<\/h4>\n

\u06f1<\/code><\/p>\n

Units<\/h4>\n

factor of the original icon size<\/code><\/p>\n

Minimum<\/h4>\n

\u06f0<\/code><\/p>\n

Requires<\/h4>\n

iconImage<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera, source, composite<\/code><\/p>\n

\n

Name<\/h4>\n

iconTextFit<\/code><\/p>\n

Description<\/h4>\n

Scales the icon to fit around the associated text.<\/p>\n

Type<\/h4>\n

enum<\/code><\/p>\n

Default Value<\/h4>\n

none<\/code><\/p>\n

Supported Values<\/h4>\n

none<\/strong> – The icon is displayed at its intrinsic aspect ratio.
width<\/strong> – The icon is scaled in the x-dimension to fit the width of the text.
height<\/strong> – The icon is scaled in the y-dimension to fit the height of the text.
both<\/strong> – The icon is scaled in both x- and y-dimensions.<\/p>\n

Requires<\/h4>\n

iconImage, textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

iconTextFitPadding<\/code><\/p>\n

Description<\/h4>\n

Size of the additional area added to dimensions determined byiconTextFit<\/code>, in clockwise order: top, right, bottom, left.<\/p>\n

Type<\/h4>\n

array<number><\/code><\/p>\n

Default Value<\/h4>\n

[\u06f0,\u06f0,\u06f0,\u06f0]<\/code><\/p>\n

Units<\/h4>\n

pixels<\/code><\/p>\n

Requires<\/h4>\n

iconImage, textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

iconImage<\/code><\/p>\n

Description<\/h4>\n

Name of image in sprite to use for drawing an image background. A string with{tokens}<\/code>replaced, referencing the data property to pull from. ({token}<\/code>replacement is only supported for literaliconImage<\/code>values; not for property functions.)<\/p>\n

Type<\/h4>\n

string<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera, source, composite<\/code><\/p>\n

\n

Name<\/h4>\n

iconRotate<\/code><\/p>\n

Description<\/h4>\n

Rotates the icon clockwise.<\/p>\n

Type<\/h4>\n

number<\/code><\/p>\n

Default Value<\/h4>\n

\u06f0<\/code><\/p>\n

Units<\/h4>\n

degrees<\/code><\/p>\n

Requires<\/h4>\n

iconImage<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera, source, composite<\/code><\/p>\n

\n

Name<\/h4>\n

iconPadding<\/code><\/p>\n

Description<\/h4>\n

Size of the additional area around the icon bounding box used for detecting symbol collisions.<\/p>\n

Type<\/h4>\n

number<\/code><\/p>\n

Default Value<\/h4>\n

\u06f2<\/code><\/p>\n

Units<\/h4>\n

pixels<\/code><\/p>\n

Minimum<\/h4>\n

\u06f0<\/code><\/p>\n

Requires<\/h4>\n

iconImage<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

iconKeepUpright<\/code><\/p>\n

Description<\/h4>\n

If true, the icon may be flipped to prevent it from being rendered upsideDown.<\/p>\n

Type<\/h4>\n

boolean<\/code><\/p>\n

Default Value<\/h4>\n

false<\/code><\/p>\n

Requires<\/h4>\n

iconImage<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

iconOffset<\/code><\/p>\n

Description<\/h4>\n

Offset distance of icon from its anchor. Positive values indicate right and down, while negative values indicate left and up. When combined withiconRotate<\/code>the offset will be as if the rotated direction was up.<\/p>\n

Type<\/h4>\n

array<number><\/code><\/p>\n

Default Value<\/h4>\n

[\u06f0,\u06f0]<\/code><\/p>\n

Units<\/h4>\n

pixels multiplied by the value of "icon-size"<\/code><\/p>\n

Requires<\/h4>\n

iconImage<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera, source, composite<\/code><\/p>\n

\n

Name<\/h4>\n

iconAnchor<\/code><\/p>\n

Description<\/h4>\n

Part of the icon placed closest to the anchor.<\/p>\n

Type<\/h4>\n

enum<\/code><\/p>\n

Default Value<\/h4>\n

center<\/code><\/p>\n

Supported Values<\/h4>\n

center<\/strong> – The center of the icon is placed closest to the anchor.
left<\/strong> – The left side of the icon is placed closest to the anchor.
right<\/strong> – The right side of the icon is placed closest to the anchor.
top<\/strong> – The top of the icon is placed closest to the anchor.
bottom<\/strong> – The bottom of the icon is placed closest to the anchor.
top-left<\/strong> – The top left corner of the icon is placed closest to the anchor.
top-right<\/strong> – The top right corner of the icon is placed closest to the anchor.
bottom-left<\/strong> – The bottom left corner of the icon is placed closest to the anchor.
bottom-right<\/strong> – The bottom right corner of the icon is placed closest to the anchor.<\/p>\n

Requires<\/h4>\n

iconImage<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera, source, composite<\/code><\/p>\n

\n

Name<\/h4>\n

iconPitchAlignment<\/code><\/p>\n

Description<\/h4>\n

Orientation of icon when map is pitched.<\/p>\n

Type<\/h4>\n

enum<\/code><\/p>\n

Default Value<\/h4>\n

auto<\/code><\/p>\n

Supported Values<\/h4>\n

map<\/strong> – The icon is aligned to the plane of the map.
viewport<\/strong> – The icon is aligned to the plane of the viewport.
auto<\/strong> – Automatically matches the value oficon-rotation-alignment<\/code>.<\/p>\n

Requires<\/h4>\n

iconImage<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

textPitchAlignment<\/code><\/p>\n

Description<\/h4>\n

Orientation of text when map is pitched.<\/p>\n

Type<\/h4>\n

enum<\/code><\/p>\n

Default Value<\/h4>\n

auto<\/code><\/p>\n

Supported Values<\/h4>\n

map<\/strong> – The text is aligned to the plane of the map.
viewport<\/strong> – The text is aligned to the plane of the viewport.
auto<\/strong> – Automatically matches the value oftext-rotation-alignment<\/code>.<\/p>\n

Requires<\/h4>\n

textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

textRotationAlignment<\/code><\/p>\n

Description<\/h4>\n

In combination withsymbolPlacement<\/code>, determines the rotation behavior of the individual glyphs forming the text.<\/p>\n

Type<\/h4>\n

enum<\/code><\/p>\n

Default Value<\/h4>\n

auto<\/code><\/p>\n

Supported Values<\/h4>\n

map<\/strong> – Whensymbol-placement<\/code>is set topoint<\/code>, aligns text east-west. Whensymbol-placement<\/code>is set toline<\/code>, aligns text x-axes with the line.
viewport<\/strong> – Produces glyphs whose x-axes are aligned with the x-axis of the viewport, regardless of the value ofsymbol-placement<\/code>.
auto<\/strong> – Whensymbol-placement<\/code>is set topoint<\/code>, this is equivalent toviewport<\/code>. Whensymbol-placement<\/code>is set toline<\/code>, this is equivalent tomap<\/code>.<\/p>\n

Requires<\/h4>\n

textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

textField<\/code><\/p>\n

Description<\/h4>\n

Value to use for a text label. Feature properties are specified using tokens like{field_name}<\/code>. ({token}<\/code>replacement is only supported for literaltextField<\/code>values; not for property functions.)<\/p>\n

Type<\/h4>\n

string<\/code><\/p>\n

Default Value<\/h4>\n

empty string<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera, source, composite<\/code><\/p>\n

\n

Name<\/h4>\n

textFont<\/code><\/p>\n

Description<\/h4>\n

Font stack to use for displaying text.<\/p>\n

Type<\/h4>\n

array<string><\/code><\/p>\n

Default Value<\/h4>\n

[Open Sans Regular,Arial Unicode MS Regular]<\/code><\/p>\n

Requires<\/h4>\n

textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

textSize<\/code><\/p>\n

Description<\/h4>\n

Font size.<\/p>\n

Type<\/h4>\n

number<\/code><\/p>\n

Default Value<\/h4>\n

\u06f1\u06f6<\/code><\/p>\n

Units<\/h4>\n

pixels<\/code><\/p>\n

Minimum<\/h4>\n

\u06f0<\/code><\/p>\n

Requires<\/h4>\n

textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera, source, composite<\/code><\/p>\n

\n

Name<\/h4>\n

textMaxWidth<\/code><\/p>\n

Description<\/h4>\n

The maximum line width for text wrapping.<\/p>\n

Type<\/h4>\n

number<\/code><\/p>\n

Default Value<\/h4>\n

\u06f1\u06f0<\/code><\/p>\n

Units<\/h4>\n

ems<\/code><\/p>\n

Minimum<\/h4>\n

\u06f0<\/code><\/p>\n

Requires<\/h4>\n

textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

textLineHeight<\/code><\/p>\n

Description<\/h4>\n

Text leading value for multiLine text.<\/p>\n

Type<\/h4>\n

number<\/code><\/p>\n

Default Value<\/h4>\n

\u06f1.\u06f2<\/code><\/p>\n

Units<\/h4>\n

ems<\/code><\/p>\n

Requires<\/h4>\n

textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

textLetterSpacing<\/code><\/p>\n

Description<\/h4>\n

Text tracking amount.<\/p>\n

Type<\/h4>\n

number<\/code><\/p>\n

Default Value<\/h4>\n

\u06f0<\/code><\/p>\n

Units<\/h4>\n

ems<\/code><\/p>\n

Requires<\/h4>\n

textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

textJustify<\/code><\/p>\n

Description<\/h4>\n

Text justification options.<\/p>\n

Type<\/h4>\n

enum<\/code><\/p>\n

Default Value<\/h4>\n

center<\/code><\/p>\n

Supported Values<\/h4>\n

left<\/strong> – The text is aligned to the left.
center<\/strong> – The text is centered.
right<\/strong> – The text is aligned to the right.<\/p>\n

Requires<\/h4>\n

textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

textAnchor<\/code><\/p>\n

Description<\/h4>\n

Part of the text placed closest to the anchor.<\/p>\n

Type<\/h4>\n

enum<\/code><\/p>\n

Default Value<\/h4>\n

center<\/code><\/p>\n

Supported Values<\/h4>\n

center<\/strong> – The center of the text is placed closest to the anchor.
left<\/strong> – The left side of the text is placed closest to the anchor.
right<\/strong> – The right side of the text is placed closest to the anchor.
top<\/strong> – The top of the text is placed closest to the anchor.
bottom<\/strong> – The bottom of the text is placed closest to the anchor.
top-left<\/strong> – The top left corner of the text is placed closest to the anchor.
top-right<\/strong> – The top right corner of the text is placed closest to the anchor.
bottom-left<\/strong> – The bottom left corner of the text is placed closest to the anchor.
bottom-right<\/strong> – The bottom right corner of the text is placed closest to the anchor.<\/p>\n

Requires<\/h4>\n

textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

textMaxAngle<\/code><\/p>\n

Description<\/h4>\n

Maximum angle change between adjacent characters.<\/p>\n

Type<\/h4>\n

number<\/code><\/p>\n

Default Value<\/h4>\n

\u06f4\u06f5<\/code><\/p>\n

Units<\/h4>\n

degrees<\/code><\/p>\n

Requires<\/h4>\n

textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

textRotate<\/code><\/p>\n

Description<\/h4>\n

Rotates the text clockwise.<\/p>\n

Type<\/h4>\n

number<\/code><\/p>\n

Default Value<\/h4>\n

\u06f0<\/code><\/p>\n

Units<\/h4>\n

degrees<\/code><\/p>\n

Requires<\/h4>\n

textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera, source, composite<\/code><\/p>\n

\n

Name<\/h4>\n

textPadding<\/code><\/p>\n

Description<\/h4>\n

Size of the additional area around the text bounding box used for detecting symbol collisions.<\/p>\n

Type<\/h4>\n

number<\/code><\/p>\n

Default Value<\/h4>\n

\u06f2<\/code><\/p>\n

Units<\/h4>\n

pixels<\/code><\/p>\n

Minimum<\/h4>\n

\u06f0<\/code><\/p>\n

Requires<\/h4>\n

textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

textKeepUpright<\/code><\/p>\n

Description<\/h4>\n

If true, the text may be flipped vertically to prevent it from being rendered upsideDown.<\/p>\n

Type<\/h4>\n

boolean<\/code><\/p>\n

Default Value<\/h4>\n

true<\/code><\/p>\n

Requires<\/h4>\n

textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

textTransform<\/code><\/p>\n

Description<\/h4>\n

Specifies how to capitalize text, similar to the CSStextTransform<\/code>property.<\/p>\n

Type<\/h4>\n

enum<\/code><\/p>\n

Default Value<\/h4>\n

none<\/code><\/p>\n

Supported Values<\/h4>\n

none<\/strong> – The text is not altered.
uppercase<\/strong> – Forces all letters to be displayed in uppercase.
lowercase<\/strong> – Forces all letters to be displayed in lowercase.<\/p>\n

Requires<\/h4>\n

textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera, source, composite<\/code><\/p>\n

\n

Name<\/h4>\n

textOffset<\/code><\/p>\n

Description<\/h4>\n

Offset distance of text from its anchor. Positive values indicate right and down, while negative values indicate left and up.<\/p>\n

Type<\/h4>\n

array<number><\/code><\/p>\n

Default Value<\/h4>\n

[\u06f0,\u06f0]<\/code><\/p>\n

Units<\/h4>\n

ems<\/code><\/p>\n

Requires<\/h4>\n

textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera, source, composite<\/code><\/p>\n

\n

Name<\/h4>\n

textAllowOverlap<\/code><\/p>\n

Description<\/h4>\n

If true, the text will be visible even if it collides with other previously drawn symbols.<\/p>\n

Type<\/h4>\n

boolean<\/code><\/p>\n

Default Value<\/h4>\n

false<\/code><\/p>\n

Requires<\/h4>\n

textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

textIgnorePlacement<\/code><\/p>\n

Description<\/h4>\n

If true, other symbols can be visible even if they collide with the text.<\/p>\n

Type<\/h4>\n

boolean<\/code><\/p>\n

Default Value<\/h4>\n

false<\/code><\/p>\n

Requires<\/h4>\n

textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

textOptional<\/code><\/p>\n

Description<\/h4>\n

If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not.<\/p>\n

Type<\/h4>\n

boolean<\/code><\/p>\n

Default Value<\/h4>\n

false<\/code><\/p>\n

Requires<\/h4>\n

textField, iconImage<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

visibility<\/code><\/p>\n

Description<\/h4>\n

Whether this layer is displayed.<\/p>\n

Type<\/h4>\n

enum<\/code><\/p>\n

Default Value<\/h4>\n

visible<\/code><\/p>\n

Supported Values<\/h4>\n

visible<\/strong> – The layer is shown.
none<\/strong> – The layer is not shown.<\/p>\n

\n

Name<\/h4>\n

iconOpacity<\/code><\/p>\n

Description<\/h4>\n

The opacity at which the icon will be drawn.<\/p>\n

Type<\/h4>\n

number<\/code><\/p>\n

Default Value<\/h4>\n

\u06f1<\/code><\/p>\n

Minimum<\/h4>\n

\u06f0<\/code><\/p>\n

Maximum<\/h4>\n

\u06f1<\/code><\/p>\n

Requires<\/h4>\n

iconImage<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera, source, composite<\/code><\/p>\n

\n

Name<\/h4>\n

iconColor<\/code><\/p>\n

Description<\/h4>\n

The color of the icon. This can only be used with sdf icons.<\/p>\n

Type<\/h4>\n

color<\/code><\/p>\n

Default Value<\/h4>\n

#\u06f0\u06f0\u06f0\u06f0\u06f0\u06f0<\/code><\/p>\n

Requires<\/h4>\n

iconImage<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera, source, composite<\/code><\/p>\n

\n

Name<\/h4>\n

iconHaloColor<\/code><\/p>\n

Description<\/h4>\n

The color of the icon’s halo. Icon halos can only be used with SDF icons.<\/p>\n

Type<\/h4>\n

color<\/code><\/p>\n

Default Value<\/h4>\n

rgba(0, 0, 0, 0)<\/code><\/p>\n

Requires<\/h4>\n

iconImage<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera, source, composite<\/code><\/p>\n

\n

Name<\/h4>\n

iconHaloWidth<\/code><\/p>\n

Description<\/h4>\n

Distance of halo to the icon outline.<\/p>\n

Type<\/h4>\n

number<\/code><\/p>\n

Default Value<\/h4>\n

\u06f0<\/code><\/p>\n

Units<\/h4>\n

pixels<\/code><\/p>\n

Minimum<\/h4>\n

\u06f0<\/code><\/p>\n

Requires<\/h4>\n

iconImage<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera, source, composite<\/code><\/p>\n

\n

Name<\/h4>\n

iconHaloBlur<\/code><\/p>\n

Description<\/h4>\n

Fade out the halo towards the outside.<\/p>\n

Type<\/h4>\n

number<\/code><\/p>\n

Default Value<\/h4>\n

\u06f0<\/code><\/p>\n

Units<\/h4>\n

pixels<\/code><\/p>\n

Minimum<\/h4>\n

\u06f0<\/code><\/p>\n

Requires<\/h4>\n

iconImage<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera, source, composite<\/code><\/p>\n

\n

Name<\/h4>\n

iconTranslate<\/code><\/p>\n

Description<\/h4>\n

Distance that the icon’s anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.<\/p>\n

Type<\/h4>\n

array<number><\/code><\/p>\n

Default Value<\/h4>\n

[\u06f0,\u06f0]<\/code><\/p>\n

Units<\/h4>\n

pixels<\/code><\/p>\n

Requires<\/h4>\n

iconImage<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

iconTranslateAnchor<\/code><\/p>\n

Description<\/h4>\n

Controls the frame of reference foriconTranslate<\/code>.<\/p>\n

Type<\/h4>\n

enum<\/code><\/p>\n

Default Value<\/h4>\n

map<\/code><\/p>\n

Supported Values<\/h4>\n

map<\/strong> – Icons are translated relative to the map.
viewport<\/strong> – Icons are translated relative to the viewport.<\/p>\n

Requires<\/h4>\n

iconImage, iconTranslate<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

textOpacity<\/code><\/p>\n

Description<\/h4>\n

The opacity at which the text will be drawn.<\/p>\n

Type<\/h4>\n

number<\/code><\/p>\n

Default Value<\/h4>\n

\u06f1<\/code><\/p>\n

Minimum<\/h4>\n

\u06f0<\/code><\/p>\n

Maximum<\/h4>\n

\u06f1<\/code><\/p>\n

Requires<\/h4>\n

textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera, source, composite<\/code><\/p>\n

\n

Name<\/h4>\n

textColor<\/code><\/p>\n

Description<\/h4>\n

The color with which the text will be drawn.<\/p>\n

Type<\/h4>\n

color<\/code><\/p>\n

Default Value<\/h4>\n

#\u06f0\u06f0\u06f0\u06f0\u06f0\u06f0<\/code><\/p>\n

Requires<\/h4>\n

textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera, source, composite<\/code><\/p>\n

\n

Name<\/h4>\n

textHaloColor<\/code><\/p>\n

Description<\/h4>\n

The color of the text’s halo, which helps it stand out from backgrounds.<\/p>\n

Type<\/h4>\n

color<\/code><\/p>\n

Default Value<\/h4>\n

rgba(0, 0, 0, 0)<\/code><\/p>\n

Requires<\/h4>\n

textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera, source, composite<\/code><\/p>\n

\n

Name<\/h4>\n

textHaloWidth<\/code><\/p>\n

Description<\/h4>\n

Distance of halo to the font outline. Max text halo width is 1\/4 of the fontSize.<\/p>\n

Type<\/h4>\n

number<\/code><\/p>\n

Default Value<\/h4>\n

\u06f0<\/code><\/p>\n

Units<\/h4>\n

pixels<\/code><\/p>\n

Minimum<\/h4>\n

\u06f0<\/code><\/p>\n

Requires<\/h4>\n

textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera, source, composite<\/code><\/p>\n

\n

Name<\/h4>\n

textHaloBlur<\/code><\/p>\n

Description<\/h4>\n

The halo’s fadeout distance towards the outside.<\/p>\n

Type<\/h4>\n

number<\/code><\/p>\n

Default Value<\/h4>\n

\u06f0<\/code><\/p>\n

Units<\/h4>\n

pixels<\/code><\/p>\n

Minimum<\/h4>\n

\u06f0<\/code><\/p>\n

Requires<\/h4>\n

textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera, source, composite<\/code><\/p>\n

\n

Name<\/h4>\n

textTranslate<\/code><\/p>\n

Description<\/h4>\n

Distance that the text’s anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.<\/p>\n

Type<\/h4>\n

array<number><\/code><\/p>\n

Default Value<\/h4>\n

[\u06f0,\u06f0]<\/code><\/p>\n

Units<\/h4>\n

pixels<\/code><\/p>\n

Requires<\/h4>\n

textField<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>\n

\n

Name<\/h4>\n

textTranslateAnchor<\/code><\/p>\n

Description<\/h4>\n

Controls the frame of reference fortextTranslate<\/code>.<\/p>\n

Type<\/h4>\n

enum<\/code><\/p>\n

Default Value<\/h4>\n

map<\/code><\/p>\n

Supported Values<\/h4>\n

map<\/strong> – The text is translated relative to the map.
viewport<\/strong> – The text is translated relative to the viewport.<\/p>\n

Requires<\/h4>\n

textField, textTranslate<\/code><\/p>\n

Supported Style Functions<\/h4>\n

camera<\/code><\/p>","protected":false},"author":4,"featured_media":0,"parent":3734,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","manualdocumentationcategory":[97],"yoast_head":"\nSymbolLayer - \u0633\u0627\u06cc\u062a \u067e\u0634\u062a\u06cc\u0628\u0627\u0646\u06cc \u0646\u0642\u0634\u0647\u0654 \u0645\u067e<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/help.map.ir\/documentation\/reactsdk-docs\/reactsdk-symbollayer\/\" \/>\n<meta property=\"og:locale\" content=\"fa_IR\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"SymbolLayer - \u0633\u0627\u06cc\u062a \u067e\u0634\u062a\u06cc\u0628\u0627\u0646\u06cc \u0646\u0642\u0634\u0647\u0654 \u0645\u067e\" \/>\n<meta property=\"og:description\" content=\"SymbolLayer is a style layer that renders icon and text labels at points or along lines on the map \u0642\u0627\u0628\u0644\u06cc\u062a\u200c\u0647\u0627: […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/help.map.ir\/documentation\/reactsdk-docs\/reactsdk-symbollayer\/\" \/>\n<meta property=\"og:site_name\" content=\"\u0633\u0627\u06cc\u062a \u067e\u0634\u062a\u06cc\u0628\u0627\u0646\u06cc \u0646\u0642\u0634\u0647\u0654 \u0645\u067e\" \/>\n<meta property=\"article:modified_time\" content=\"2021-09-18T09:55:45+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:site\" content=\"@map_ir_Official\" \/>\n<meta name=\"twitter:label1\" content=\"\u0632\u0645\u0627\u0646 \u062a\u0642\u0631\u06cc\u0628\u06cc \u0628\u0631\u0627\u06cc \u062e\u0648\u0627\u0646\u062f\u0646\" \/>\n\t<meta name=\"twitter:data1\" content=\"11 \u062f\u0642\u06cc\u0642\u0647\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/help.map.ir\/documentation\/reactsdk-docs\/reactsdk-symbollayer\/\",\"url\":\"https:\/\/help.map.ir\/documentation\/reactsdk-docs\/reactsdk-symbollayer\/\",\"name\":\"SymbolLayer - \u0633\u0627\u06cc\u062a \u067e\u0634\u062a\u06cc\u0628\u0627\u0646\u06cc \u0646\u0642\u0634\u0647\u0654 \u0645\u067e\",\"isPartOf\":{\"@id\":\"https:\/\/help.map.ir\/#website\"},\"datePublished\":\"2021-04-24T12:25:00+00:00\",\"dateModified\":\"2021-09-18T09:55:45+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/help.map.ir\/documentation\/reactsdk-docs\/reactsdk-symbollayer\/#breadcrumb\"},\"inLanguage\":\"fa-IR\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/help.map.ir\/documentation\/reactsdk-docs\/reactsdk-symbollayer\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/help.map.ir\/documentation\/reactsdk-docs\/reactsdk-symbollayer\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"\u062e\u0627\u0646\u0647\",\"item\":\"https:\/\/help.map.ir\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"\u0645\u0633\u062a\u0646\u062f\u0627\u062a\",\"item\":\"https:\/\/help.map.ir\/documentation\/reactsdk-docs\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"SymbolLayer\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/help.map.ir\/#website\",\"url\":\"https:\/\/help.map.ir\/\",\"name\":\"\u0633\u0627\u06cc\u062a \u067e\u0634\u062a\u06cc\u0628\u0627\u0646\u06cc \u0646\u0642\u0634\u0647\u0654 \u0645\u067e\",\"description\":\"\u067e\u0634\u062a\u06cc\u0628\u0627\u0646\u06cc \u0646\u0642\u0634\u0647\u0654 \u0645\u067e\",\"publisher\":{\"@id\":\"https:\/\/help.map.ir\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/help.map.ir\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"fa-IR\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/help.map.ir\/#organization\",\"name\":\"\u0646\u0642\u0634\u0647 \u0645\u067e\",\"url\":\"https:\/\/help.map.ir\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"fa-IR\",\"@id\":\"https:\/\/help.map.ir\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/help.map.ir\/wp-content\/uploads\/2021\/04\/Logo.png\",\"contentUrl\":\"https:\/\/help.map.ir\/wp-content\/uploads\/2021\/04\/Logo.png\",\"width\":735,\"height\":885,\"caption\":\"\u0646\u0642\u0634\u0647 \u0645\u067e\"},\"image\":{\"@id\":\"https:\/\/help.map.ir\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/x.com\/map_ir_Official\",\"https:\/\/www.linkedin.com\/company\/map-ir\/\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"SymbolLayer - \u0633\u0627\u06cc\u062a \u067e\u0634\u062a\u06cc\u0628\u0627\u0646\u06cc \u0646\u0642\u0634\u0647\u0654 \u0645\u067e","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/help.map.ir\/documentation\/reactsdk-docs\/reactsdk-symbollayer\/","og_locale":"fa_IR","og_type":"article","og_title":"SymbolLayer - \u0633\u0627\u06cc\u062a \u067e\u0634\u062a\u06cc\u0628\u0627\u0646\u06cc \u0646\u0642\u0634\u0647\u0654 \u0645\u067e","og_description":"SymbolLayer is a style layer that renders icon and text labels at points or along lines on the map \u0642\u0627\u0628\u0644\u06cc\u062a\u200c\u0647\u0627: […]","og_url":"https:\/\/help.map.ir\/documentation\/reactsdk-docs\/reactsdk-symbollayer\/","og_site_name":"\u0633\u0627\u06cc\u062a \u067e\u0634\u062a\u06cc\u0628\u0627\u0646\u06cc \u0646\u0642\u0634\u0647\u0654 \u0645\u067e","article_modified_time":"2021-09-18T09:55:45+00:00","twitter_card":"summary_large_image","twitter_site":"@map_ir_Official","twitter_misc":{"\u0632\u0645\u0627\u0646 \u062a\u0642\u0631\u06cc\u0628\u06cc \u0628\u0631\u0627\u06cc \u062e\u0648\u0627\u0646\u062f\u0646":"11 \u062f\u0642\u06cc\u0642\u0647"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/help.map.ir\/documentation\/reactsdk-docs\/reactsdk-symbollayer\/","url":"https:\/\/help.map.ir\/documentation\/reactsdk-docs\/reactsdk-symbollayer\/","name":"SymbolLayer - \u0633\u0627\u06cc\u062a \u067e\u0634\u062a\u06cc\u0628\u0627\u0646\u06cc \u0646\u0642\u0634\u0647\u0654 \u0645\u067e","isPartOf":{"@id":"https:\/\/help.map.ir\/#website"},"datePublished":"2021-04-24T12:25:00+00:00","dateModified":"2021-09-18T09:55:45+00:00","breadcrumb":{"@id":"https:\/\/help.map.ir\/documentation\/reactsdk-docs\/reactsdk-symbollayer\/#breadcrumb"},"inLanguage":"fa-IR","potentialAction":[{"@type":"ReadAction","target":["https:\/\/help.map.ir\/documentation\/reactsdk-docs\/reactsdk-symbollayer\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/help.map.ir\/documentation\/reactsdk-docs\/reactsdk-symbollayer\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"\u062e\u0627\u0646\u0647","item":"https:\/\/help.map.ir\/"},{"@type":"ListItem","position":2,"name":"\u0645\u0633\u062a\u0646\u062f\u0627\u062a","item":"https:\/\/help.map.ir\/documentation\/reactsdk-docs\/"},{"@type":"ListItem","position":3,"name":"SymbolLayer"}]},{"@type":"WebSite","@id":"https:\/\/help.map.ir\/#website","url":"https:\/\/help.map.ir\/","name":"\u0633\u0627\u06cc\u062a \u067e\u0634\u062a\u06cc\u0628\u0627\u0646\u06cc \u0646\u0642\u0634\u0647\u0654 \u0645\u067e","description":"\u067e\u0634\u062a\u06cc\u0628\u0627\u0646\u06cc \u0646\u0642\u0634\u0647\u0654 \u0645\u067e","publisher":{"@id":"https:\/\/help.map.ir\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/help.map.ir\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"fa-IR"},{"@type":"Organization","@id":"https:\/\/help.map.ir\/#organization","name":"\u0646\u0642\u0634\u0647 \u0645\u067e","url":"https:\/\/help.map.ir\/","logo":{"@type":"ImageObject","inLanguage":"fa-IR","@id":"https:\/\/help.map.ir\/#\/schema\/logo\/image\/","url":"https:\/\/help.map.ir\/wp-content\/uploads\/2021\/04\/Logo.png","contentUrl":"https:\/\/help.map.ir\/wp-content\/uploads\/2021\/04\/Logo.png","width":735,"height":885,"caption":"\u0646\u0642\u0634\u0647 \u0645\u067e"},"image":{"@id":"https:\/\/help.map.ir\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/x.com\/map_ir_Official","https:\/\/www.linkedin.com\/company\/map-ir\/"]}]}},"_links":{"self":[{"href":"https:\/\/help.map.ir\/wp-json\/wp\/v2\/manual_documentation\/3887"}],"collection":[{"href":"https:\/\/help.map.ir\/wp-json\/wp\/v2\/manual_documentation"}],"about":[{"href":"https:\/\/help.map.ir\/wp-json\/wp\/v2\/types\/manual_documentation"}],"author":[{"embeddable":true,"href":"https:\/\/help.map.ir\/wp-json\/wp\/v2\/users\/4"}],"replies":[{"embeddable":true,"href":"https:\/\/help.map.ir\/wp-json\/wp\/v2\/comments?post=3887"}],"version-history":[{"count":2,"href":"https:\/\/help.map.ir\/wp-json\/wp\/v2\/manual_documentation\/3887\/revisions"}],"predecessor-version":[{"id":5324,"href":"https:\/\/help.map.ir\/wp-json\/wp\/v2\/manual_documentation\/3887\/revisions\/5324"}],"up":[{"embeddable":true,"href":"https:\/\/help.map.ir\/wp-json\/wp\/v2\/manual_documentation\/3734"}],"wp:attachment":[{"href":"https:\/\/help.map.ir\/wp-json\/wp\/v2\/media?parent=3887"}],"wp:term":[{"taxonomy":"manualdocumentationcategory","embeddable":true,"href":"https:\/\/help.map.ir\/wp-json\/wp\/v2\/manualdocumentationcategory?post=3887"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}