Skip to main content

Interface: MapWaypointDisplayBuilder

Defined in: src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:67

Configures how waypoints are rendered.

Methods

withFactory()

withFactory(roles, icon, label): this

Defined in: src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:76

Configures this builder to have the waypoint renderer use specific icon and label factories for certain render roles.

Parameters

ParameterTypeDescription
rolesnumberThe render roles for which to use the factories.
icon() => MapWaypointRendererIconFactory<Waypoint>A function which creates the icon factory to use.
label() => MapWaypointRendererLabelFactory<Waypoint>A function which creates the label factory to use.

Returns

this

This builder, after it has been configured.


withFlightPlanActiveStyles()

withFlightPlanActiveStyles(imgCache, iconStyleSelector, labelStyleSelector): this

Defined in: src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:124

Configures this builder to have the waypoint renderer use specific icon and label styles for waypoints rendered under the active flight plan role. Icon and label factories which respect the specified styles will automatically be created for the role.

Parameters

ParameterTypeDescription
imgCacheWaypointIconImageCache-
iconStyleSelector(waypoint) => MapWaypointIconStylesA function which selects styles for icons.
labelStyleSelector(waypoint) => MapWaypointLabelStylesA function which selects styles for labels.

Returns

this

This builder, after it has been configured.


withFlightPlanInactiveStyles()

withFlightPlanInactiveStyles(imgCache, iconStyleSelector, labelStyleSelector): this

Defined in: src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:110

Configures this builder to have the waypoint renderer use specific icon and label styles for waypoints rendered under the inactive flight plan role. Icon and label factories which respect the specified styles will automatically be created for the role.

Parameters

ParameterTypeDescription
imgCacheWaypointIconImageCache-
iconStyleSelector(waypoint) => MapWaypointIconStylesA function which selects styles for icons.
labelStyleSelector(waypoint) => MapWaypointLabelStylesA function which selects styles for labels.

Returns

this

This builder, after it has been configured.


withHighlightStyles()

withHighlightStyles(imgCache, iconStyleSelector, labelStyleSelector): this

Defined in: src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:138

Configures this builder to have the waypoint renderer use specific icon and label styles for waypoints rendered under the highlight role. Icon and label factories which respect the specified styles will automatically be created for the role.

Parameters

ParameterTypeDescription
imgCacheWaypointIconImageCache-
iconStyleSelector(waypoint) => MapWaypointIconStylesA function which selects styles for icons.
labelStyleSelector(waypoint) => MapWaypointLabelStylesA function which selects styles for labels.

Returns

this

This builder, after it has been configured.


withNormalStyles()

withNormalStyles(imgCache, iconStyleSelector, labelStyleSelector, runwayOutlineIconStyleSelector?, runwayDesignationImgCache?): this

Defined in: src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:94

Configures this builder to have the waypoint renderer use specific icon and label styles for waypoints rendered under the normal role. Icon and label factories which respect the specified styles will automatically be created for the role.

Parameters

ParameterTypeDescription
imgCacheWaypointIconImageCache-
iconStyleSelector(waypoint) => MapWaypointIconStylesA function which selects styles for icons.
labelStyleSelector(waypoint) => MapWaypointLabelStylesA function which selects styles for labels.
runwayOutlineIconStyleSelector?(waypoint) => MapRunwayOutlineIconStylesA function which selects styles for runway outline icons. If not defined, runway outline icons will not be rendered.
runwayDesignationImgCache?MapRunwayDesignationImageCacheThe image cache from which this factory retrieves runway designation images. If not defined, runway designations will not be rendered.

Returns

this

This builder, after it has been configured.


withProcPreviewStyles()

withProcPreviewStyles(imgCache, iconStyleSelector, labelStyleSelector): this

Defined in: src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:166

Configures this builder to have the waypoint renderer use specific icon and label styles for waypoints rendered under the procedure preview role. Icon and label factories which respect the specified styles will automatically be created for the role.

Parameters

ParameterTypeDescription
imgCacheWaypointIconImageCache-
iconStyleSelector(waypoint) => MapWaypointIconStylesA function which selects styles for icons.
labelStyleSelector(waypoint) => MapWaypointLabelStylesA function which selects styles for labels.

Returns

this

This builder, after it has been configured.


withProcTransitionPreviewStyles()

withProcTransitionPreviewStyles(imgCache, iconStyleSelector, labelStyleSelector): this

Defined in: src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:180

Configures this builder to have the waypoint renderer use specific icon and label styles for waypoints rendered under the procedure transition preview role. Icon and label factories which respect the specified styles will automatically be created for the role.

Parameters

ParameterTypeDescription
imgCacheWaypointIconImageCache-
iconStyleSelector(waypoint) => MapWaypointIconStylesA function which selects styles for icons.
labelStyleSelector(waypoint) => MapWaypointLabelStylesA function which selects styles for labels.

Returns

this

This builder, after it has been configured.


withVNavStyles()

withVNavStyles(imgCache, iconStyleSelector, labelStyleSelector): this

Defined in: src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:152

Configures this builder to have the waypoint renderer use specific icon and label styles for waypoints rendered under the VNAV role. Icon and label factories which respect the specified styles will automatically be created for the role.

Parameters

ParameterTypeDescription
imgCacheWaypointIconImageCache-
iconStyleSelector(waypoint) => MapWaypointIconStylesA function which selects styles for icons.
labelStyleSelector(waypoint) => MapWaypointLabelStylesA function which selects styles for labels.

Returns

this

This builder, after it has been configured.