Class: NavSourceFormatter
Utility class for creating nav source name formatters.
Constructors
constructor
• new NavSourceFormatter(): NavSourceFormatter
Returns
Methods
create
▸ create(showGpsIndex
, showNavIndex
): (sourceName
: G3XTouchNavSourceName
) => string
Creates a function which generates formatted nav source names.
Parameters
Name | Type | Description |
---|---|---|
showGpsIndex | boolean | Whether to show the index for GPS-type nav sources. |
showNavIndex | boolean | Whether to show the index for NAV-type nav sources. |
Returns
fn
A function which generates formatted nav source names.
▸ (sourceName
): string
Parameters
Name | Type |
---|---|
sourceName | G3XTouchNavSourceName |
Returns
string
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Graphics/Text/NavSourceFormatter.ts:18
createForBearingPointerSetting
▸ createForBearingPointerSetting(showNavIndex
): (bearingPointerSource
: PfdBearingPointerSource
) => string
Creates a function which generates formatted nav source names for nav sources.
Parameters
Name | Type | Description |
---|---|---|
showNavIndex | boolean | Whether to show the index for NAV-type nav sources. |
Returns
fn
A function which generates formatted nav source names for nav sources.
▸ (bearingPointerSource
): string
Parameters
Name | Type |
---|---|
bearingPointerSource | PfdBearingPointerSource |
Returns
string
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Graphics/Text/NavSourceFormatter.ts:100
createForIndicator
▸ createForIndicator(showGpsIndex
, showNavIndex
, showNavType
): (indicator
: G3XTouchNavIndicator
) => string
Creates a function which generates formatted nav source names for nav indicators.
Parameters
Name | Type | Description |
---|---|---|
showGpsIndex | boolean | Whether to show the index for GPS-type nav sources. |
showNavIndex | boolean | Whether to show the index for NAV-type nav sources. |
showNavType | boolean | Whether to show the navaid type (VOR vs LOC) for NAV-type nav sources. If false , 'VLOC' will be used as the name for all NAV-type sources. |
Returns
fn
A function which generates formatted nav source names for nav indicators.
▸ (indicator
): string
Parameters
Name | Type |
---|---|
indicator | G3XTouchNavIndicator |
Returns
string
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Graphics/Text/NavSourceFormatter.ts:61
createForSource
▸ createForSource(showGpsIndex
, showNavIndex
): (source
: NavReferenceSource
<G3XTouchNavSourceName
>) => string
Creates a function which generates formatted nav source names for nav sources.
Parameters
Name | Type | Description |
---|---|---|
showGpsIndex | boolean | Whether to show the index for GPS-type nav sources. |
showNavIndex | boolean | Whether to show the index for NAV-type nav sources. |
Returns
fn
A function which generates formatted nav source names for nav sources.
▸ (source
): string
Parameters
Name | Type |
---|---|
source | NavReferenceSource <G3XTouchNavSourceName > |
Returns
string
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Graphics/Text/NavSourceFormatter.ts:42