Skip to main content

Class: MapWaypointDisplayBuilderClass

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

Implements

Constructors

Constructor

new MapWaypointDisplayBuilderClass(): MapWaypointDisplayBuilderClass

Returns

MapWaypointDisplayBuilderClass

Methods

apply()

apply(renderer): void

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

Applies this builder's configurations to a waypoint renderer.

Parameters

ParameterTypeDescription
rendererMapWaypointRendererA waypoint renderer.

Returns

void


withFactory()

withFactory(roles, icon, label): this

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

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.

Implementation of

MapWaypointDisplayBuilder.withFactory


withFlightPlanActiveStyles()

withFlightPlanActiveStyles(imgCache, iconStyleSelector, labelStyleSelector): this

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

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.

Implementation of

MapWaypointDisplayBuilder.withFlightPlanActiveStyles


withFlightPlanInactiveStyles()

withFlightPlanInactiveStyles(imgCache, iconStyleSelector, labelStyleSelector): this

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

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.

Implementation of

MapWaypointDisplayBuilder.withFlightPlanInactiveStyles


withHighlightStyles()

withHighlightStyles(imgCache, iconStyleSelector, labelStyleSelector): this

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

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) => MapWaypointIconHighlightStylesA function which selects styles for icons.
labelStyleSelector(waypoint) => MapWaypointLabelStylesA function which selects styles for labels.

Returns

this

This builder, after it has been configured.

Implementation of

MapWaypointDisplayBuilder.withHighlightStyles


withNormalStyles()

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

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

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.

Implementation of

MapWaypointDisplayBuilder.withNormalStyles


withProcPreviewStyles()

withProcPreviewStyles(imgCache, iconStyleSelector, labelStyleSelector): this

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

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.

Implementation of

MapWaypointDisplayBuilder.withProcPreviewStyles


withProcTransitionPreviewStyles()

withProcTransitionPreviewStyles(imgCache, iconStyleSelector, labelStyleSelector): this

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

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.

Implementation of

MapWaypointDisplayBuilder.withProcTransitionPreviewStyles


withVNavStyles()

withVNavStyles(imgCache, iconStyleSelector, labelStyleSelector): this

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

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) => MapWaypointIconHighlightStylesA function which selects styles for icons.
labelStyleSelector(waypoint) => MapWaypointLabelStylesA function which selects styles for labels.

Returns

this

This builder, after it has been configured.

Implementation of

MapWaypointDisplayBuilder.withVNavStyles