geoview-core
    Preparing search index...

    Class OLTransform

    OpenLayers Transform interaction OLTransform

    Hierarchy

    • PointerInteraction
      • OLTransform
    Index

    Constructors

    Properties

    angle: number = 0

    The angle for rotation

    center?: Coordinate

    The center of the feature being transformed

    currentHandle?: Feature<Geometry>

    The current handle being dragged

    disposed: boolean

    The object has already been disposed.

    features: Collection<Feature<Geometry>>

    The collection of features to transform

    handleLayer: VectorLayer<VectorSource<Feature<Geometry>>>

    The layer used to display handles

    handleSource: VectorSource

    The source for the handle layer

    handlingDownUpSequence: boolean
    mapViewer?: MapViewer

    The map viewer

    on: InteractionOnSignature<EventsKey>
    once: InteractionOnSignature<EventsKey>
    onDeletefeature?: (event: TransformDeleteFeatureEvent) => void
    onSelectionChange?: (event: TransformSelectionEvent) => void
    onTransformend?: (event: TransformEvent) => void
    onTransforming?: (event: TransformEvent) => void
    onTransformstart?: (event: TransformEvent) => void

    Callback functions for events

    Options for the transform interaction

    selectedFeature?: Feature<Geometry>

    The currently selected feature

    startCoordinate?: Coordinate

    The start coordinates when dragging

    startGeometry?: Geometry

    The start geometry when transforming

    targetPointers: PointerEvent[]
    un: InteractionOnSignature<void>

    Methods

    • Parameters

      • key: string

        Key name.

      • listener: Listener

        Listener.

      Returns void

    • Parameters

      • type: string

        Type.

      • listener: Listener

        Listener.

      Returns void

    • Protected

      Apply any properties from another object without triggering events.

      Parameters

      • source: BaseObject

        The source object.

      Returns void

    • Increases the revision counter and dispatches a 'change' event.

      Returns void

    • Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

      Parameters

      • event: string | BaseEvent

        Event object.

      Returns boolean | undefined

      false if anyone called preventDefault on the event object or if any of the listeners returned false.

    • Protected

      Extension point for disposable objects.

      Returns void

    • Gets a value.

      Parameters

      • key: string

        Key name.

      Returns any

      Value.

    • Return whether the interaction is currently active.

      Returns boolean

      true if the interaction is active, false otherwise.

    • Get a list of object property names.

      Returns string[]

      List of property names.

    • Get the listeners for a specified event type. Listeners are returned in the order that they will be called in.

      Parameters

      • type: string

        Type.

      Returns Listener[] | undefined

      Listeners.

    • Get the map associated with this interaction.

      Returns Map | null

      Map.

    • Returns the current number of pointers involved in the interaction, e.g. 2 when two fingers are used.

      Returns number

      The number of pointers.

    • Get an object of all property names and values.

      Returns { [x: string]: any }

      Object.

    • Get an object of all property names and values.

      Returns { [x: string]: any } | null

      Object.

    • Get the version number for this object. Each time the object is modified, its version number will be incremented.

      Returns number

      Revision.

    • Handle pointer move events. Not to be confused with moving handles. This overrides the move event from OL Pointer

      Parameters

      • event: MapBrowserEvent<PointerEvent>

        The map browser event.

      Returns void

    • Parameters

      • Optionaltype: string

        Type. If not provided, true will be returned if this event target has any listeners.

      Returns boolean

      Has listeners.

    • Returns boolean

      The object has properties.

    • Parameters

      • key: string

        Key name.

      • oldValue: any

        Old value.

      Returns void

    • Protected

      Parameters

      • type: string | string[]

        Type.

      • listener: (arg0: Event | BaseEvent) => unknown

        Listener.

      Returns EventsKey | EventsKey[]

      Event key.

    • Protected

      Parameters

      • type: string | string[]

        Type.

      • listener: (arg0: Event | BaseEvent) => unknown

        Listener.

      Returns EventsKey | EventsKey[]

      Event key.

    • Parameters

      • key: string

        Key name.

      • listener: Listener

        Listener.

      Returns void

    • Parameters

      • type: string

        Type.

      • listener: Listener

        Listener.

      Returns void

    • Sets a value.

      Parameters

      • key: string

        Key name.

      • value: any

        Value.

      • Optionalsilent: boolean

        Update without triggering an event.

      Returns void

    • Activate or deactivate the interaction.

      Parameters

      • active: boolean

        Active.

      Returns void

    • Remove the interaction from its current map and attach it to the new map. Subclasses may set up event handlers to get notified about changes to the map here.

      Parameters

      • map: Map | null

        Map.

      Returns void

    • Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

      Parameters

      • values: { [x: string]: any }

        Values.

      • Optionalsilent: boolean

        Update without triggering an event.

      Returns void

    • This function is used to determine if "down" events should be propagated to other interactions or should be stopped.

      Parameters

      • handled: boolean

        Was the event handled by the interaction?

      Returns boolean

      Should the down event be stopped?

    • Protected

      Unlisten for a certain type of event.

      Parameters

      • type: string | string[]

        Type.

      • listener: (arg0: Event | BaseEvent) => unknown

        Listener.

      Returns void

    • Unsets a property.

      Parameters

      • key: string

        Key name.

      • Optionalsilent: boolean

        Unset without triggering an event.

      Returns void