| 6 | |
| 7 | |
| 8 | class Symbol(_BaseLayoutHierarchyType): |
| 9 | _parent_path_str = "layout.map.layer" |
| 10 | _path_str = "layout.map.layer.symbol" |
| 11 | _valid_props = {"icon", "iconsize", "placement", "text", "textfont", "textposition"} |
| 12 | |
| 13 | @property |
| 14 | def icon(self): |
| 15 | """ |
| 16 | Sets the symbol icon image (map.layer.layout.icon-image). Full |
| 17 | list: https://www.mapbox.com/maki-icons/ |
| 18 | |
| 19 | The 'icon' property is a string and must be specified as: |
| 20 | - A string |
| 21 | - A number that will be converted to a string |
| 22 | |
| 23 | Returns |
| 24 | ------- |
| 25 | str |
| 26 | """ |
| 27 | return self["icon"] |
| 28 | |
| 29 | @icon.setter |
| 30 | def icon(self, val): |
| 31 | self["icon"] = val |
| 32 | |
| 33 | @property |
| 34 | def iconsize(self): |
| 35 | """ |
| 36 | Sets the symbol icon size (map.layer.layout.icon-size). Has an |
| 37 | effect only when `type` is set to "symbol". |
| 38 | |
| 39 | The 'iconsize' property is a number and may be specified as: |
| 40 | - An int or float |
| 41 | |
| 42 | Returns |
| 43 | ------- |
| 44 | int|float |
| 45 | """ |
| 46 | return self["iconsize"] |
| 47 | |
| 48 | @iconsize.setter |
| 49 | def iconsize(self, val): |
| 50 | self["iconsize"] = val |
| 51 | |
| 52 | @property |
| 53 | def placement(self): |
| 54 | """ |
| 55 | Sets the symbol and/or text placement (map.layer.layout.symbol- |
| 56 | placement). If `placement` is "point", the label is placed |
| 57 | where the geometry is located If `placement` is "line", the |
| 58 | label is placed along the line of the geometry If `placement` |
| 59 | is "line-center", the label is placed on the center of the |
| 60 | geometry |
| 61 | |
| 62 | The 'placement' property is an enumeration that may be specified as: |
| 63 | - One of the following enumeration values: |
| 64 | ['point', 'line', 'line-center'] |
| 65 |
no outgoing calls
no test coverage detected