Class: MapWaypointDisplayBuilderClass
Defined in: src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:216
Configures how waypoints are rendered.
Implements
Constructors
Constructor
new MapWaypointDisplayBuilderClass():
MapWaypointDisplayBuilderClass
Returns
MapWaypointDisplayBuilderClass
Methods
apply()
apply(
renderer):void
Defined in: src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:391
Applies this builder's configurations to a waypoint renderer.
Parameters
| Parameter | Type | Description |
|---|---|---|
renderer | MapWaypointRenderer | A waypoint renderer. |
Returns
void
withFactory()
withFactory(
role,icon,label):this
Defined in: src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:220
Configures this builder to have the waypoint renderer use specific icon and label factories for a certain render role.
Parameters
| Parameter | Type | Description |
|---|---|---|
role | number | The render role 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:267
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
| Parameter | Type | Description |
|---|---|---|
imgCache | WaypointIconImageCache | - |
iconStyleSelector | (waypoint) => MapWaypointIconStyles | A function which selects styles for icons. |
labelStyleSelector | (waypoint) => MapWaypointLabelStyles | A 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:250
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
| Parameter | Type | Description |
|---|---|---|
imgCache | WaypointIconImageCache | - |
iconStyleSelector | (waypoint) => MapWaypointIconStyles | A function which selects styles for icons. |
labelStyleSelector | (waypoint) => MapWaypointLabelStyles | A 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:284
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
| Parameter | Type | Description |
|---|---|---|
imgCache | WaypointIconImageCache | - |
iconStyleSelector | (waypoint) => MapWaypointIconHighlightStyles | A function which selects styles for icons. |
labelStyleSelector | (waypoint) => MapWaypointLabelStyles | A function which selects styles for labels. |
Returns
this
This builder, after it has been configured.
Implementation of
MapWaypointDisplayBuilder.withHighlightStyles
withHoverStyles()
withHoverStyles(
imgCache,iconStyleSelector,labelStyleSelector):this
Defined in: src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:352
Configures this builder to have the waypoint renderer use specific icon and label styles for waypoints rendered under the hovered single role and hovered combined roles. Icon and label factories which respect the specified styles will automatically be created for the roles.
Parameters
| Parameter | Type | Description |
|---|---|---|
imgCache | WaypointIconImageCache | - |
iconStyleSelector | (combinedRole, waypoint) => MapWaypointIconHighlightStyles | A function which selects styles for icons. |
labelStyleSelector | (combinedRole, waypoint) => MapWaypointLabelStyles | A function which selects styles for labels. |
Returns
this
This builder, after it has been configured.
Implementation of
MapWaypointDisplayBuilder.withHoverStyles
withNormalStyles()
withNormalStyles(
imgCache,iconStyleSelector,labelStyleSelector,runwayOutlineIconStyleSelector?,runwayDesignationImgCache?):this
Defined in: src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:231
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
| Parameter | Type | Description |
|---|---|---|
imgCache | WaypointIconImageCache | - |
iconStyleSelector | (waypoint) => MapWaypointIconStyles | A function which selects styles for icons. |
labelStyleSelector | (waypoint) => MapWaypointLabelStyles | A function which selects styles for labels. |
runwayOutlineIconStyleSelector? | (waypoint) => MapRunwayOutlineIconStyles | A function which selects styles for runway outline icons. If not defined, runway outline icons will not be rendered. |
runwayDesignationImgCache? | MapRunwayDesignationImageCache | The 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:318
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
| Parameter | Type | Description |
|---|---|---|
imgCache | WaypointIconImageCache | - |
iconStyleSelector | (waypoint) => MapWaypointIconStyles | A function which selects styles for icons. |
labelStyleSelector | (waypoint) => MapWaypointLabelStyles | A 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:335
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
| Parameter | Type | Description |
|---|---|---|
imgCache | WaypointIconImageCache | - |
iconStyleSelector | (waypoint) => MapWaypointIconStyles | A function which selects styles for icons. |
labelStyleSelector | (waypoint) => MapWaypointLabelStyles | A 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:301
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
| Parameter | Type | Description |
|---|---|---|
imgCache | WaypointIconImageCache | - |
iconStyleSelector | (waypoint) => MapWaypointIconHighlightStyles | A function which selects styles for icons. |
labelStyleSelector | (waypoint) => MapWaypointLabelStyles | A function which selects styles for labels. |
Returns
this
This builder, after it has been configured.