Interface: MapWaypointDisplayBuilder
Configures how waypoints are rendered.
Implemented by
Methods
withFactory
▸ withFactory(roles, icon, label): this
Configures this builder to have the waypoint renderer use specific icon and label factories for certain render roles.
Parameters
| Name | Type | Description |
|---|---|---|
roles | number | The 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.
Defined in
src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:76
withFlightPlanActiveStyles
▸ withFlightPlanActiveStyles(imgCache, iconStyleSelector, labelStyleSelector): this
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
| Name | Type | Description |
|---|---|---|
imgCache | WaypointIconImageCache | - |
iconStyleSelector | (waypoint: Waypoint) => MapWaypointIconStyles | A function which selects styles for icons. |
labelStyleSelector | (waypoint: Waypoint) => MapWaypointLabelStyles | A function which selects styles for labels. |
Returns
this
This builder, after it has been configured.
Defined in
src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:124
withFlightPlanInactiveStyles
▸ withFlightPlanInactiveStyles(imgCache, iconStyleSelector, labelStyleSelector): this
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
| Name | Type | Description |
|---|---|---|
imgCache | WaypointIconImageCache | - |
iconStyleSelector | (waypoint: Waypoint) => MapWaypointIconStyles | A function which selects styles for icons. |
labelStyleSelector | (waypoint: Waypoint) => MapWaypointLabelStyles | A function which selects styles for labels. |
Returns
this
This builder, after it has been configured.
Defined in
src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:110
withHighlightStyles
▸ withHighlightStyles(imgCache, iconStyleSelector, labelStyleSelector): this
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
| Name | Type | Description |
|---|---|---|
imgCache | WaypointIconImageCache | - |
iconStyleSelector | (waypoint: Waypoint) => MapWaypointIconStyles | A function which selects styles for icons. |
labelStyleSelector | (waypoint: Waypoint) => MapWaypointLabelStyles | A function which selects styles for labels. |
Returns
this
This builder, after it has been configured.
Defined in
src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:138
withNormalStyles
▸ withNormalStyles(imgCache, iconStyleSelector, labelStyleSelector, runwayOutlineIconStyleSelector?, runwayDesignationImgCache?): this
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
| Name | Type | Description |
|---|---|---|
imgCache | WaypointIconImageCache | - |
iconStyleSelector | (waypoint: Waypoint) => MapWaypointIconStyles | A function which selects styles for icons. |
labelStyleSelector | (waypoint: Waypoint) => MapWaypointLabelStyles | A function which selects styles for labels. |
runwayOutlineIconStyleSelector? | (waypoint: MapRunwayOutlineWaypoint) => 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.
Defined in
src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:94
withProcPreviewStyles
▸ withProcPreviewStyles(imgCache, iconStyleSelector, labelStyleSelector): this
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
| Name | Type | Description |
|---|---|---|
imgCache | WaypointIconImageCache | - |
iconStyleSelector | (waypoint: Waypoint) => MapWaypointIconStyles | A function which selects styles for icons. |
labelStyleSelector | (waypoint: Waypoint) => MapWaypointLabelStyles | A function which selects styles for labels. |
Returns
this
This builder, after it has been configured.
Defined in
src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:166
withProcTransitionPreviewStyles
▸ withProcTransitionPreviewStyles(imgCache, iconStyleSelector, labelStyleSelector): this
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
| Name | Type | Description |
|---|---|---|
imgCache | WaypointIconImageCache | - |
iconStyleSelector | (waypoint: Waypoint) => MapWaypointIconStyles | A function which selects styles for icons. |
labelStyleSelector | (waypoint: Waypoint) => MapWaypointLabelStyles | A function which selects styles for labels. |
Returns
this
This builder, after it has been configured.
Defined in
src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:180
withVNavStyles
▸ withVNavStyles(imgCache, iconStyleSelector, labelStyleSelector): this
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
| Name | Type | Description |
|---|---|---|
imgCache | WaypointIconImageCache | - |
iconStyleSelector | (waypoint: Waypoint) => MapWaypointIconStyles | A function which selects styles for icons. |
labelStyleSelector | (waypoint: Waypoint) => MapWaypointLabelStyles | A function which selects styles for labels. |
Returns
this
This builder, after it has been configured.
Defined in
src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:152