WME-Bootstrap

Bootstrap library for custom Waze Map Editor scripts

This script should not be not be installed directly. It is a library for other scripts to include with the meta directive // @require https://update.greasyfork.org/scripts/450160/1218867/WME-Bootstrap.js

Author
Anton Shevchuk
Version
0.1.5
Created
2022-08-25
Updated
2023-07-12
License
MIT

WME Bootstrap

This is a small Boostrap library for checking WME loading and providing useful events, which you can use for your scripts.

For what?

You can meet the realization of checking loading in the many scripts; it looks like this:

// 👎
function init() {
  /* checking */
  setTimeout(init, 200) 
}

No need more this way; look at the following code:

// 👍
$(document).on('bootstrap.wme', () => { /* your code here */ } )

So I think it's clear.

Need more?

So, it is not all. This script trigger more events for common events in the WME where you can manipulate the arguments.

Require Script

// @require https://greasyfork.org/scripts/450160-wme-bootstrap/code/WME-Bootstrap.js

Events

All following events are triggered on the document

  • bootstrap.wme – when all WME-objects are ready for usage
  • none.wme – when nothing chosen
  • node.wme – when chosen node for edit
  • nodes.wme – when chosen more than one node (I'm not sure how it is possible)
  • segment.wme – when chosen segment for edit
  • segments.wme – when chosen more than one segment
  • venue.wme – when chosen place or point for edit
  • venues.wme – when chosen more than one place or point
  • point.wme – when chosen point place for edit
  • place.wme – when chosen place for edit
  • residential.wme – when chosen residential place for edit

Arguments

  • event – jQuery.Event
  • element – HTMLElement of the sidebar panel
  • model – W.model
  • models – array of W.model

Usage

(function () {
  'use strict'

  $(document)
    .on('bootstrap.wme', function () {
      console.info('ready')
    })
    .on('none.wme', (e) => {
      console.info('none')
    })
    .on('node.wme', (event, element, model) => {
      console.info('node', model)
      console.info('sidebar', element)
    })
    .on('nodes.wme', (event, element, models) => {
      console.info('nodes', models)
    })
    .on('segment.wme', (event, element, model) => {
      console.info('segment', model)
      console.info('sidebar', element)
    })
    .on('segments.wme', (event, element, models) => {
      console.info('segments', models)
    })
    .on('venue.wme', (event, element, model) => {
      console.info('venue', model)
    })
    .on('venues.wme', (event, element, model) => {
      console.info('venues', models)
    })
    .on('point.wme', (event, element, model) => {
      console.info('point', model)
    })
    .on('place.wme', (event, element, model) => {
      console.info('place', model)
    })
    .on('residential.wme', (event, element, model) => {
      console.info('residential', model)
    })
})();

Links

Author homepage: http://anton.shevchuk.name/
Script homepage: https://github.com/AntonShevchuk/wme-bootstrap
GreasyFork: https://greasyfork.org/en/scripts/450160-wme-bootstrap