Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EditableFeatureProviderOptions

Configuration options of a EditableFeatureProviderOptions.

Hierarchy

Index

Properties

Optional editable

editable: boolean

Allow or prevent editing by the Editor module.

defaultvalue

false

Optional enforceRandomFeatureId

enforceRandomFeatureId: boolean

Enforce random ids for newly created features. If "enforceRandomFeatureId" is set to true, the ids of features created by editor.addFeature are ignored and randomly created. If "enforceRandomFeatureId" is set to false, ids of features created by editor.addFeature can be set. Random ids are only generated if none have been set.

defaultvalue

true

Optional hooks

hooks: { Coordinates.update?: CoordinatesUpdateHook | CoordinatesUpdateHook[]; Feature.remove?: FeatureRemoveHook | FeatureRemoveHook[]; Navlink.disconnect?: NavlinkDisconnectHook | NavlinkDisconnectHook[]; Navlink.split?: NavlinkSplitHook | NavlinkSplitHook[] }

Add hook functions that will be called during the execution of the corresponding "editing operation". The "hooks" option is a map with the "editing operation" as its key and the corresponding Hook or Array of Hook function(s) as its value.

Available editing operations are 'Navlink.disconnect', 'Navlink.split', 'Feature.remove', 'Coordinates.remove'.

see

editor.addHook

Type declaration

  • Optional Coordinates.update?: CoordinatesUpdateHook | CoordinatesUpdateHook[]

    The CoordinatesUpdateHook(s) will be called whenever the coordinates of a feature are added, updated or removed ('Coordinates.update' operation).

  • Optional Feature.remove?: FeatureRemoveHook | FeatureRemoveHook[]

    The FeatureRemoveHook(s) will be called when a feature is being removed ('Feature.remove' operation).

  • Optional Navlink.disconnect?: NavlinkDisconnectHook | NavlinkDisconnectHook[]

    The NavlinkDisconnectHook(s) will be called whenever a Navlink is disconnected from an intersection ('Navlink.disconnect' operation).

  • Optional Navlink.split?: NavlinkSplitHook | NavlinkSplitHook[]

    The NavlinkSplitHook(s) will be called whenever a Navlink is devided into two new Navlinks. ('Navlink.split' operation).

Optional id

id: string

optional id to identify the provider.

Optional margin

margin: number

Tile margin of the provider.

Optional name

name: string

Name of the provider.

Generated using TypeDoc