map-element
Functions
- _assert(v, message)
Custom assert for local validation
- mapElement(options) ⇒
Object A helper to build your own component for the plugin
_assert(v, message)
Custom assert for local validation
Kind: global function
| Param | Type | Description |
|---|---|---|
| v | boolean | The expression that should return a boolean value, if false the assertion fails |
| message | string | Error message to be displayed |
mapElement(options) ⇒ Object
A helper to build your own component for the plugin
Kind: global function
Returns: Object - A component object that should be exported by default from a Vue component
| Param | Type | Description |
|---|---|---|
| options | Object | |
| options.mappedProps | Object | Definitions of props |
| options.mappedProps.PROP.type | Object | Value type |
| options.mappedProps.PROP.twoWay | Boolean | - Whether the prop has a corresponding PROP_changed event |
| options.mappedProps.PROP.noBind | Boolean | - If true, do not apply the default bindProps / bindEvents. However it will still be added to the list of component props |
| options.props | Object | Regular Vue-style props. Note: must be in the Object form because it will be merged with the mappedProps |
| options.events | Object | Google Maps API events that are not bound to a corresponding prop |
| options.name | String | e.g. polyline |
| options.ctr | function | constructor, e.g. google.maps.Polyline. However, since this is not generally available during library load, this becomes a function instead, e.g. () => google.maps.Polyline which will be called only after the API has been loaded default: () => String |
| options.ctrArgs | function | If the constructor in ctr needs to be called with arguments other than a single options object, e.g. for GroundOverlay, we call new GroundOverlay(url, bounds, options) then pass in a function that returns the argument list as an array default: (MappedProps, OtherVueProps) => Array Otherwise, the constructor will be called with an options object, with property and values merged from: 1. the options property, if any 2. a map property with the Google Maps 3. all the properties passed to the component in mappedProps |
| options.beforeCreate | function | Hook to modify the options passed to the initializer default: (Object) => Any |
| options.afterCreate | function | Hook called when default: (options.ctr, Object) => Any |