{"id":5950,"date":"2022-12-26T12:17:20","date_gmt":"2022-12-26T08:47:20","guid":{"rendered":"https:\/\/en.geobox.ir\/developers\/?post_type=docs&p=5950"},"modified":"2023-01-21T12:38:27","modified_gmt":"2023-01-21T09:08:27","slug":"data-manipulation","status":"publish","type":"docs","link":"https:\/\/en.geobox.ir\/developers\/docs\/working-with-features\/data-manipulation\/","title":{"rendered":"Working with feature"},"content":{"rendered":"

Tip: To use all the methods below, you must first select the desired layer through the result array of the map.getFeatureLayers().<\/p>\n

Properties:<\/h2>\n

selectionSet<\/h3>\n

After selecting features, you can access the list of selected Ids using selectionSet.<\/p>\n

Returns:<\/strong><\/p>\n

Set: Returns a set of ids<\/p>\n

Example:<\/strong><\/p>\n

const\u00a0allFeatureLayers\u00a0=\u00a0map.getFeatureLayers();\u00a0\r\nconst intendedLayer = allFeatureLayers[\"<intended layer name>\"];\u00a0\r\nconst Ids = intendedLayer.selectionSet;<\/pre>\n
highlightSet<\/h3>\n
After highlighting features, you can access the list of highlighted Ids using highlightSet .<\/p>\n
Returns:<\/strong><\/p>\n
Set: Returns a set of ids<\/p>\n
Example:<\/strong><\/p>\n
const\u00a0allFeatureLayers\u00a0=\u00a0map.getFeatureLayers();\u00a0\r\nconst intendedLayer = allFeatureLayers[\"<intended layer name>\"];\u00a0\r\nconst Ids = intendedLayer.highlightSet;<\/pre>\n
Methods:<\/h2>\n
select(Ids)<\/h3>\n
Selects one or multiple features.<\/p>\n
Parameters:<\/strong><\/p>\n
Ids(Number | Array): Array of features ids. If you want a single feature, insert id as a number.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows selecting features was successful or not. Null message means selecting was successful.<\/p>\n
Example:<\/strong><\/p>\n
const allFeatureLayers = map.getFeatureLayers();\r\nconst intendedLayer = allFeatureLayers[\"<intended layer name>\"];\r\nintendedLayer.select([10,25]); \r\n\r\n<\/pre>\n
addToSelection(Ids)<\/h3>\n
Adds one or multiple features from the layer to the selected features.<\/p>\n
Parameters:<\/strong><\/p>\n
Ids(Number | Array): Array of features ids. If you want a single feature, insert id as a number.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows selecting features was successful or not. Null message means selecting was successful.<\/p>\n
Example:<\/strong><\/p>\n
const allFeatureLayers = map.getFeatureLayers();\r\nconst intendedLayer = allFeatureLayers[\"<intended layer name>\"];\r\nintendedLayer.addToSelection([10,25]); \r\n\r\n<\/pre>\n
removeFromSelecion(Ids)<\/h3>\n
Deselects one or multiple features.<\/p>\n
Parameters:<\/strong><\/p>\n
Ids(Number | Array): Array of features ids. If you want a single feature, insert id as a number.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows deselecting features was successful or not. Null message means deselecting was successful.<\/p>\n
Example:<\/strong><\/p>\n
const allFeatureLayers = map.getFeatureLayers();\r\nconst intendedLayer = allFeatureLayers[\"<intended layer name>\"];\r\nintendedLayer.removeFromSelection([10,25]); \r\n\r\n<\/pre>\n
clearSelection()<\/h3>\n
Deselects all features.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows deselecting features was successful or not. Null message means deselecting was successful.<\/p>\n
Example:<\/strong><\/p>\n
const allFeatureLayers = map.getFeatureLayers();\r\nconst intendedLayer = allFeatureLayers[\"<intended layer name>\"];\r\nintendedLayer.clearSelection(); \r\n\r\n<\/pre>\n
highlight (Ids)<\/h3>\n
Highlights one or multiple features.<\/p>\n
Parameters:<\/strong><\/p>\n
Ids(Number | Array): Array of features ids. If you want a single feature, insert id as a number.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows highlighting features was successful or not. Null message means highlighting was successful.<\/p>\n
Example:<\/strong><\/p>\n
const allFeatureLayers = map.getFeatureLayers();\r\nconst intendedLayer = allFeatureLayers[\"<intended layer name>\"];\r\nintendedLayer.highlight([10,25]); \r\n\r\n<\/pre>\n
\n
addToHighlight(Ids)<\/span><\/h3>\n<\/div>\n
Adds one or multiple features from the layer to the highlighted features.<\/p>\n
Parameters:<\/strong><\/p>\n
Ids(Number | Array): Array of features ids. If you want a single feature, insert id as a number.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows highlighting features was successful or not. Null message means highlighting was successful.<\/p>\n
Example:<\/strong><\/p>\n
const allFeatureLayers = map.getFeatureLayers();\r\nconst intendedLayer = allFeatureLayers[\"<intended layer name>\"];\r\nintendedLayer.addToHighlight([10,25]); \r\n\r\n<\/pre>\n
removeFromHighlight(Ids)<\/h3>\n
Removes one or multiple features from the highlight mode.<\/p>\n
Parameters:<\/strong><\/p>\n
Ids(Number | Array): Array of features ids. If you want a single feature, insert id as a number.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows removing features from highlight mode was successful or not. Null message means removing features from highlight mode was successful.<\/p>\n
Example:<\/strong><\/p>\n
const allFeatureLayers = map.getFeatureLayers();\r\nconst intendedLayer = allFeatureLayers[\"<intended layer name>\"];\r\nintendedLayer.removeFromHighlight([10,25]); \r\n\r\n<\/pre>\n
clearHighlight()<\/h3>\n
Removes all features from the highlight mode.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows removing all features from highlight mode was successful or not. Null message means removing all features from highlight mode\u00a0was successful.<\/p>\n
Example:<\/strong><\/p>\n
const allFeatureLayers = map.getFeatureLayers();\r\nconst intendedLayer = allFeatureLayers[\"<intended layer name>\"];\r\nintendedLayer.clearHighlight(); \r\n\r\n<\/pre>\n
flashFeature(Id)<\/h3>\n
Sets a feature to blink.<\/p>\n
Parameters:<\/strong><\/p>\n
Id (Number): A feature id.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows flashing feature was successful or not. Null message means flashing was successful.<\/p>\n
Example:<\/strong><\/p>\n
const allFeatureLayers = map.getFeatureLayers();\r\nconst intendedLayer = allFeatureLayers[\"<intended layer name>\"];\r\nintendedLayer.flashFeature(10); \r\n<\/pre>\n
\nSee the Pen Contact Form \u2013 Pen a Day 20<\/a> by Geobox (@geobox-gl-demo<\/a>) on CodePen<\/a>.1<\/p>\n