import "@arcgis/map-components/components/arcgis-sketch-tooltip-controls";- Inheritance
- ArcgisSketchTooltipControls→
HTMLElement
Properties
| Property | Attribute | Type |
|---|---|---|
| readonly | | |
| direction-mode | ||
| hide-labels-toggle | ||
| hide-tooltips-toggle | ||
| label | ||
| labels-enabled | ||
| show-direction-mode-picker | ||
| show-header | ||
| | ||
| tooltips-enabled |
directionMode
- Type
- TooltipDirectionMode
Indicates whether the direction (deflection) of the segment being drawn is measured relative to the previous segment or from the main axis of the map (usually north). See SketchTooltipOptions and SketchValueOptions.
- Attribute
- direction-mode
hideLabelsToggle
- Type
- boolean
Controls whether the labels toggle is shown for this component.
Note: If this component is contained in another component, the parent component is responsible for setting this property based on any known limitations, including properties on the view. Specifically, as of 5.1, if the view is a 2d video or linkchart instead of a map, the parent component should set this property to
true.
- Attribute
- hide-labels-toggle
- Default value
- false
hideTooltipsToggle
- Type
- boolean
Controls whether the tooltips toggle is shown for this component.
- Attribute
- hide-tooltips-toggle
- Default value
- false
labelsEnabled
- Type
- boolean
Indicates whether labels are shown next to each segment of the graphic being sketched.
- Attribute
- labels-enabled
- Default value
- false
showDirectionModePicker
- Type
- boolean
Controls whether the direction mode picker is shown for this component.
- Attribute
- show-direction-mode-picker
- Default value
- false
showHeader
- Type
- boolean
Controls whether a header is shown for this component.
- Attribute
- show-header
- Default value
- false
tooltipsEnabled
- Type
- boolean
Indicates whether tooltips are shown while sketching and editing.
- Attribute
- tooltips-enabled
- Default value
- false
Methods
| Method | Signature |
|---|---|
| inherited | componentOnReady(): Promise<this> |
componentOnReady
- Signature
-
componentOnReady (): Promise<this>
Creates a promise that resolves once the component is fully loaded.
- Returns
- Promise<this>
- Example
- const arcgisSketchTooltipControls = document.createElement("arcgis-sketch-tooltip-controls");document.body.append(arcgisSketchTooltipControls);await arcgisSketchTooltipControls.componentOnReady();console.log("arcgis-sketch-tooltip-controls is ready to go!");
Events
| Name | Type |
|---|---|
| CustomEvent<{ name: "tooltipsEnabled" | "labelsEnabled" | "directionMode"; }> |
arcgisPropertyChange
arcgisPropertyChange: CustomEvent<{ name: "tooltipsEnabled" | "labelsEnabled" | "directionMode"; }> Emitted when the value of a property is changed. Use this to listen to changes to properties.