Documentation
    Preparing search index...

    Hierarchy

    • MeasurementAnnotationController
      • CustomMeasurementController
    Index

    Constructors

    Accessors

    • get cursor(): null | string

      The CSS cursor to Map.cursorManager use on the map, for this controller. If null, the map will fall back to the previous cursor that was set on the map.

      Note that changing this cursor will update Map.cursorManager the cursor on the map's DOM node. When using multiple controllers (e.g. in a CompositeController), the controller that updates the cursor last (to a non-null value), will override any other non-null cursors of active controllers on the map.

      Returns null | string

      Map.cursorManager

      2022.1

    • set cursor(cssCursor: null | string): void

      Parameters

      • cssCursor: null | string

      Returns void

    • get enabled(): boolean

      Returns boolean

    • set enabled(enabled: boolean): void

      Parameters

      • enabled: boolean

      Returns void

    • get finished(): boolean

      Returns boolean

    • get map(): null | Map

      The map on which this controller is currently active or null if this controller is not currently active. This property is read-only.

      Returns null | Map

    • set map(_value: null | Map): void

      Parameters

      • _value: null | Map

      Returns void

    • get measurement(): Measurement<S>

      Returns Measurement<S>

    • set measurement(value: Measurement<S>): void

      Parameters

      • value: Measurement<S>

      Returns void

    • get measurementStyles(): MeasurementPaintStyles

      Returns MeasurementPaintStyles

    • get projector(): undefined | MeasurementProjector

      Returns undefined | MeasurementProjector

    Methods

    • Protected

      Creates a transformation from the map reference to the reference where measurements happens.

      Parameters

      • map: Map

        The map on which measurements happens.

      Returns Transformation

    • Returns void

    • Call this method to indicate that the controller's appearance has changed. Calling this method ensures the onDraw will be called during the next rendering pass.

      Returns void

    • Callback that allows controller implementations to perform custom drawing on the map. Controller shapes and icons are drawn on top of all other content in the map. Note that the map may perform caching which may cause this method to only be invoked once. When a controller implementation's appearance changes the implementation should call invalidate on itself.

      Parameters

      • geoCanvas: GeoCanvas

        the GeoCanvas on which the controller can draw shapes.

      Returns void

    • Callback that allows controller implementations to draw labels on the map. Note that the map may perform caching which may cause this method to only be invoked once. When a controller implementation's appearance changes the implementation should call invalidate on itself.

      Parameters

      • labelCanvas: LabelCanvas

        the LabelCanvas on which the controller can draw labels.

      Returns void

    • Called when a key event has been received. This method must return a HandleEventResult value to indicate if the event was handled or not, If this method returns EVENT_IGNORED, the map will be given the opportunity to perform default key event behaviour. If default event handling is not desired, this method should return EVENT_HANDLED. (See the Controller class description for the default behavior.)

      Parameters

      • keyEvent: KeyEvent

        The key event to be handled. Note that this is a KeyEvent and not a DOMEvent. You can access the corresponding DOMEvent through KeyEvent.domEvent.

      Returns HandleEventResult

      The key event handling result.

    • Returns void

    • Protected

      Transform a point from the view to the reference where measurements happens. If no point is found, throws OutOfBoundError.

      Parameters

      • viewPoint: Point

        Point on the view, in pixel coordinates.

      Returns Point

    Events

    • An event indicating that this Controller has been activated. Activated means that the controller is active on the map, and the controller's onActivate has been called.

      You can use this event to set up UI elements or other listeners related to the controller and the controller's map.

      Parameters

      • event: string
      • callback: any

      Returns Handle

      2021.0