Class: EditRouteStyle

alk.style.EditRouteStyle

An instance of this class is a RoutingLayer style function for the alk.layer.RoutingLayer. However, this particular one is used on a alk.interaction.RouteModify object to style the the features being modified.

new alk.style.EditRouteStyle(opt_options)

This constructor creates a Style function that styles the Routing Layer that will be editing the route.

Essentially this object reverses the stroke and fill colors of the stops.

Name Type Description
options Object

Subclasses

Extends

Members

layer{ol.layer.Vector}

Methods

clearStrokeForRouteId(routeId) inherited

This function clears the assigned, if any, stroke style for the given routeId identifier.

Name Type Description
routeId string

defaultDestinationImage(){ol.style.Image} inherited

This function returns the default style for a stop feature with the feature's 'stopType' property of alk.val.StopType.Destination.

For this implementation, the defaultOriginImage is used for all stopTypes of alk.val.StopType.Destination regardless of the route's stroke color.

defaultOriginImage(){ol.style.Image} inherited

This function returns the default image for a stop feature with the feature's 'stopType' property of alk.val.StopType.Origin.

For this implementation, the defaultOriginImage is used for all stopTypes of alk.val.StopType.Origin regardless of the route's stroke color.

defaultViaPointImage(){ol.style.Image}

This function returns the default image for a stop feature with the feature's 'stopType' property of alk.val.StopType.ViaPoint.

It is the reverse of the default used in alk.style.StopsRouteStyle. This image is only used as a backup if there is no stroke for the route.

defaultWayPointImage(){ol.style.Image} inherited

This function returns the default image for a stop feature with the feature's 'stopType' property of alk.val.StopType.WayPoint.

For this implementation, the defaultOriginImage is NOT used. The alk.style.StopsRouteStyle#getWayPointImage returns a different image according to the route's stroke color.

getDestinationImage(stroke){ol.style.Image} inherited

This function returns the image to use in styling a stop feature with the feature's 'stopType' property of alk.val.StopType.Destination.

This implementation ignores the stroke style and returns the alk.style.StopsRouteStyle#defaultDestinationImage.

Name Type Description
stroke ol.style.Stroke

The route's stroke style.

getDestinationStyleFunction(feature, resolution){ol.style.Style|null} inherited

This style function returns a style for a stop with the feature's 'stopType' property of alk.val.StopType.Destination.

This implementation returns a style containing the image returned by alk.style.StopsRouteStyle#getDestinationImage.

Name Type Description
feature ol.Feature

The stop feature
resolution number

getOriginImage(stroke){ol.style.Image} inherited

This function returns the image to use in styling a stop feature with the feature's 'stopType' property of alk.val.StopType.Origin.

This implementation ignores the stroke style and returns the default origin image.

Name Type Description
stroke ol.style.Stroke

The route's stroke style.

getOriginStyleFunction(feature, resolution){ol.style.Style|null} inherited

This function returns the ol.style.Style stop feature with the feature's 'stopType' property set to alk.val.StopType.Origin.

Name Type Description
feature ol.Feature

The stop feature
resolution number

getStopStyle(feature, resolution){ol.style.Style|null} inherited

This function returns an ol.style.Style that styles a stop feature. The feature will be a Point geometry and will have its 'routeId', 'stop', 'stopIndex', and 'stopType', and 'logicalStopIndex' properties set.

This implementation calls out getOriginStyleFunction, getWayPointStyleFunction, getViaPointStyleFunction, and getDestinationStyleFunction, for each of the stop features.

Name Type Description
feature ol.Feature

The stop feature.
resolution number

The display resolution.
Returns:
If this returns null, no stop will be drawn.

getStrokeQueue(){alk.style.StrokeQueue|undefined} inherited

This function returns the stroke Queue.

getStrokeStyle(feature, resolution){ol.style.Stroke} inherited

This function returns the stroke style for the route.

Name Type Description
feature ol.Feature
resolution number

getUpdateStrokeStyle(feature, resolution){ol.style.Stroke} inherited

This function returns the Update Stroke Style, which is the same for all features and resolutions.

Name Type Description
feature ol.Feature

This argument is ignored.
resolution number

This argument is ignored.

getViaPointImage(stroke){ol.style.Image}

This function returns the image to use in styling a stop feature with the feature's 'stopType' property of alk.val.StopType.ViaPoint.

This implementation returns a ol.style.Circle styled with a white border, and a color fill of the route's stroke color. The width of the stroke is 1 pixels, and the radius of the circle is 5 pixels.

Name Type Description
stroke ol.style.Stroke

The route's stroke style.

getViaPointStyleFunction(feature, resolution){ol.style.Style|null} inherited

This style function returns a style for a stop feature with the feature's 'stopType' property of alk.val.StopType.ViaPoint.

This implementation returns a style containing the image returned by alk.style.StopsRouteStyle#getViaPointImage.

Name Type Description
feature ol.Feature

The stop feature
resolution number

getWayPointImage(stroke){ol.style.Image} inherited

This function returns the image to use in styling a stop feature with the feature's 'stopType' property of alk.val.StopType.WayPoint.

This implementation returns a ol.style.Circle styled with a white fill, and a color border of the route's stroke color. The width of the stroke is 3 pixels, and the radius of the circle is 9 pixels. The stroke color is 1.0 opacity equivalent to the route's stroke color, which should be at 0.5 opacity.

Name Type Description
stroke ol.style.Stroke

The route's stroke style.

getWayPointStyleFunction(feature, resolution){ol.style.Style|null}

This style function returns a style for a stop feature with the feature's 'stopType' property of alk.val.StopType.WayPoint.

This implementation returns the image returned by alk.style.EditRouteStyle#getViaPointImage as the purpose is not to move way points so they shouldn't be styled. However, the Route Modify wants something to style with, so it is given a via point style.

Name Type Description
feature ol.Feature

The stop feature
resolution number

setStrokeQueue(strokeQueue) inherited

This function sets the stroke style for this QueuedLineRouteStyle.

Name Type Description
strokeQueue alk.style.StrokeQueue

setStrokeStyle(strokeStyle) inherited

This function sets the stroke style for this LineRouteStyle.

Name Type Description
strokeStyle ol.style.Stroke

setUpdateStrokeStyle(stroke) inherited

This function sets the update stroke style.

Name Type Description
stroke ol.style.Stroke

setUpdating(value) inherited

This method is called when the 'updating' property of alk.layer.RoutingLayer is changed. This call gives the style the ability to style things differently when being updated.

Name Type Description
value boolean

styleFunction(feature, resolution){Array.<ol.style.Style>} inherited

This function styles the RoutingLayer.

This particular implementation calls out to getStrokeStyle for color and width of the route. It calls out to getStopStyle to get styling for Stops.

Name Type Description
feature ol.Feature
resolution number