Readonly$iThe instance of RampMap API scoped to a single Vue R4MP application.
ReadonlyidID of this fixture.
Indicates whether to keep the fixture when the language changes. Defaults to true. If only one config is provided for all languages, the fixture will be kept on language change, regardless of the value of the flag.
Returns the ID of the graphics layer used by the draw fixture.
Parses the draw fixture configuration and sets up the draw store.
The configuration object for the draw fixture.
OptionaladdedStarts a draw-shape JSON file download using the same export format as exportShapes.
If no selection is supplied, all draw shapes are exported. Supply a shape ID, an array of
shape IDs, or an options object with ids to export specific shapes. A custom file name can
be supplied either as the second parameter or through the options object.
Optionalselection: DrawShapeDownloadSelectionOptional shape ID selection.
OptionalfileName: stringOptional file name for the downloaded JSON file.
true when a file download was started; false when there are no matching shapes.
Convert all the drawings to RAMP Geometries. Some fidelity will be lost (e.g. special types like circles and rectangles become polygons, styles are dropped, buffers are currently not included)
array of RAMP geometries
Exports draw shapes to the same JSON object produced by the Draw fixture export buttons.
If no selection is supplied, all draw shapes are exported. Supply a shape ID, an array of
shape IDs, or an options object with ids to export specific shapes.
Optionalselection: DrawShapeExportSelectionOptional shape ID selection.
Draw-shape export JSON object.
For a point / click on the map, return the geometry in the drawing layer that should represent the identifiable area (think of selecting a shape to use as an identify region).
point on the map to look for a drawing graphic
the drawing graphic, including any buffer, as a RAMP Geometry. Undefined if no shapes found.
Get this fixture's config from the layer config with the given layer id
Will return undefined if layer config did not specify a config for this fixture
The layer's id
This fixture's config for the given layer
Combines this fixtures configs from layer configs into an indexed-dictionary
Dictionary where key is the layer id and the value is this fixture's config for that layer
Returns the IDs of all draw shapes currently tracked by the draw fixture.
If the panelTeleport property is provided, handle specified panelTeleport for the given fixture.
list of panel names for the calling fixture
If the panelWidth property is provided, handle default and specified panel widths for the given fixture.
list of panel names for the calling fixture
Import ramp geometries to the drawing tool. The "new shape" settings will be applied (styles, buffers, etc).
a ramp geometry or array of ramp geometries
Imports one or more draw shapes from a draw-shape JSON object, a single shape record, an array of shape records, or a URL that resolves to one of those JSON payloads.
Draw-shape JSON payload or URL.
Number of valid shapes queued for import.
Optionalinitialized[Optional] Called after the core map logic has executed. If the fixture is added after the map initialization, this is called immediately.
At this point, any custom content (panels, on-map components, etc.) can be added to R4MP. Custom content can also be added throughout the life of the [module].
Remove all drawings
OptionalremovedSet the current buffer distance (for the fixture, not for an already existing drawing)
distance value, non-negative, in whatever the current buffer unit is
Set the units for the buffer distance (for the fixture, not for an already existing drawing)
the unit string
Allows the provider to stop the standard map identify request, and do processing on the map click.
the incoming click for the identify request.
true if this provider wants the map identify request blocked.
StaticupdateAdds missing functions and properties to the object implementing FixtureBase interface. This is only needed for external fixtures that do not inherit from FixtureInstance.
TODO: If you know a better way to deep-mixin props/getters/functions from a class into another class instance, please tell me. I honestly don't know 🤷♂️.
Allows optional tools to adjust or suppress map identify geometry without making identify depend on those tools.