By default, instructions will sometimes use a special format for long-distance instructions,
such as staying on the same highway for a long time. Setting this to YES will disable the use of
such instructions. This can be an overall better experience on space-constrained displays such as
CarPlay.
The primary road shield height to assign when formatting the instructions.
Road shields are the logos for particular highways or other roads. They may be used inline in
the attributed instructions in order to more compactly reference a road. This value controls the
height assigned to such road shields.
The exit cue height to use when formatting the instructions.
When exiting a highway or other limited access road, instructions may reference specific exit
numbers in some situations. When this is done, a graphic highlighting the exit number may be
created. This property allows controlling the height of that graphic.
The exit cue background color to assign when formatting the instructions.
When exiting a highway or other limited access road, instructions may reference specific exit
numbers in some situations. When this is done, a background color may be assigned to the graphic
highlighting the exit number. This property allows controlling that color.
Setting this to nil implies use of the default color from the Google navigation experience.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-15 UTC."],[[["\u003cp\u003e\u003ccode\u003eGMSNavigationInstructionOptions\u003c/code\u003e provides formatting control for attributed instruction strings used in Google Maps navigation.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can customize fonts, colors, road shield display, and exit cue presentation using these options.\u003c/p\u003e\n"],["\u003cp\u003eThe options allow tailoring the visual aspects of navigation instructions for different displays and user experiences.\u003c/p\u003e\n"],["\u003cp\u003eDefault values based on the standard Google navigation experience are used if specific options are not set.\u003c/p\u003e\n"],["\u003cp\u003eThese options offer flexibility in styling navigation instructions, such as customizing fonts for different elements, adjusting road shield sizes, and setting the background color for exit cues.\u003c/p\u003e\n"]]],[],null,["GMSNavigationInstructionOptions \n\n @interface GMSNavigationInstructionOptions : NSObject\n\nOptions for formatting attributed instruction strings.\n- `\n ``\n ``\n `\n\n [imageOptions](#/c:objc(cs)GMSNavigationInstructionOptions(py)imageOptions)`\n ` \n Image options to be used when generating inline images. Setting this to nil specifies using\n a default set of image options. \n\n Declaration \n Swift \n\n @NSCopying var imageOptions: ../Classes/GMSNavigationStepInfoImageOptions.html! { get set }\n\n Objective-C \n\n @property (nonatomic, copy, null_resettable) ../Classes/GMSNavigationStepInfoImageOptions.html *imageOptions;\n\n- `\n ``\n ``\n `\n\n [disableLongDistanceFormat](#/c:objc(cs)GMSNavigationInstructionOptions(py)disableLongDistanceFormat)`\n ` \n By default, instructions will sometimes use a special format for long-distance instructions,\n such as staying on the same highway for a long time. Setting this to YES will disable the use of\n such instructions. This can be an overall better experience on space-constrained displays such as\n CarPlay.\n\n Defaults to NO. \n\n Declaration \n Swift \n\n var disableLongDistanceFormat: Bool { get set }\n\n Objective-C \n\n @property (nonatomic) BOOL disableLongDistanceFormat;\n\n- `\n ``\n ``\n `\n\n [primaryFont](#/c:objc(cs)GMSNavigationInstructionOptions(py)primaryFont)`\n ` \n The primary font to use when formatting the instructions.\n\n Setting this to nil implies use of the default font from the Google navigation experience. \n\n Declaration \n Swift \n\n @NSCopying var primaryFont: UIFont! { get set }\n\n Objective-C \n\n @property (nonatomic, copy, null_resettable) UIFont *primaryFont;\n\n- `\n ``\n ``\n `\n\n [secondaryFont](#/c:objc(cs)GMSNavigationInstructionOptions(py)secondaryFont)`\n ` \n The secondary font to use when formatting the instructions.\n\n Setting this to nil implies use of the default font from the Google navigation experience. \n\n Declaration \n Swift \n\n @NSCopying var secondaryFont: UIFont! { get set }\n\n Objective-C \n\n @property (nonatomic, copy, null_resettable) UIFont *secondaryFont;\n\n- `\n ``\n ``\n `\n\n [tertiaryFont](#/c:objc(cs)GMSNavigationInstructionOptions(py)tertiaryFont)`\n ` \n The font for small elements like exit numbers or conjunctions.\n\n Setting this to nil implies use of the default font from the Google navigation experience. \n\n Declaration \n Swift \n\n @NSCopying var tertiaryFont: UIFont! { get set }\n\n Objective-C \n\n @property (nonatomic, copy, null_resettable) UIFont *tertiaryFont;\n\n- `\n ``\n ``\n `\n\n [textColor](#/c:objc(cs)GMSNavigationInstructionOptions(py)textColor)`\n ` \n The color to use for instruction text.\n\n Setting this to nil implies white. \n\n Declaration \n Swift \n\n @NSCopying var textColor: UIColor! { get set }\n\n Objective-C \n\n @property (nonatomic, copy, null_resettable) UIColor *textColor;\n\n- `\n ``\n ``\n `\n\n [primaryRoadShieldHeight](#/c:objc(cs)GMSNavigationInstructionOptions(py)primaryRoadShieldHeight)`\n ` \n The primary road shield height to assign when formatting the instructions.\n\n Road shields are the logos for particular highways or other roads. They may be used inline in\n the attributed instructions in order to more compactly reference a road. This value controls the\n height assigned to such road shields. \n\n Declaration \n Swift \n\n var primaryRoadShieldHeight: CGFloat { get set }\n\n Objective-C \n\n @property (nonatomic) CGFloat primaryRoadShieldHeight;\n\n- `\n ``\n ``\n `\n\n [secondaryRoadShieldHeight](#/c:objc(cs)GMSNavigationInstructionOptions(py)secondaryRoadShieldHeight)`\n ` \n The secondary road shield height to assign when formatting the instructions.\n\n See [primaryRoadShieldHeight](../Classes/GMSNavigationInstructionOptions.html#/c:objc(cs)GMSNavigationInstructionOptions(py)primaryRoadShieldHeight) for a description of road shields. \n\n Declaration \n Swift \n\n var secondaryRoadShieldHeight: CGFloat { get set }\n\n Objective-C \n\n @property (nonatomic) CGFloat secondaryRoadShieldHeight;\n\n- `\n ``\n ``\n `\n\n [roadShieldOutlineWidth](#/c:objc(cs)GMSNavigationInstructionOptions(py)roadShieldOutlineWidth)`\n ` \n The width of the outline drawn around road shields.\n\n By default, the width is 0, which will cause no outline to be drawn.\n\n See [primaryRoadShieldHeight](../Classes/GMSNavigationInstructionOptions.html#/c:objc(cs)GMSNavigationInstructionOptions(py)primaryRoadShieldHeight) for a description of road shields. \n\n Declaration \n Swift \n\n var roadShieldOutlineWidth: CGFloat { get set }\n\n Objective-C \n\n @property (nonatomic) CGFloat roadShieldOutlineWidth;\n\n- `\n ``\n ``\n `\n\n [roadShieldOutlineColor](#/c:objc(cs)GMSNavigationInstructionOptions(py)roadShieldOutlineColor)`\n ` \n The color of the outline drawn around road shields.\n\n By default, the color is nil, which will cause no outline to be drawn.\n\n See [primaryRoadShieldHeight](../Classes/GMSNavigationInstructionOptions.html#/c:objc(cs)GMSNavigationInstructionOptions(py)primaryRoadShieldHeight) for a description of road shields. \n\n Declaration \n Swift \n\n var roadShieldOutlineColor: UIColor? { get set }\n\n Objective-C \n\n @property (nonatomic, nullable) UIColor *roadShieldOutlineColor;\n\n- `\n ``\n ``\n `\n\n [exitNumberHeight](#/c:objc(cs)GMSNavigationInstructionOptions(py)exitNumberHeight)`\n ` \n The exit cue height to use when formatting the instructions.\n\n When exiting a highway or other limited access road, instructions may reference specific exit\n numbers in some situations. When this is done, a graphic highlighting the exit number may be\n created. This property allows controlling the height of that graphic. \n\n Declaration \n Swift \n\n var exitNumberHeight: CGFloat { get set }\n\n Objective-C \n\n @property (nonatomic) CGFloat exitNumberHeight;\n\n- `\n ``\n ``\n `\n\n [exitCueBackgroundColor](#/c:objc(cs)GMSNavigationInstructionOptions(py)exitCueBackgroundColor)`\n ` \n The exit cue background color to assign when formatting the instructions.\n\n When exiting a highway or other limited access road, instructions may reference specific exit\n numbers in some situations. When this is done, a background color may be assigned to the graphic\n highlighting the exit number. This property allows controlling that color.\n\n Setting this to nil implies use of the default color from the Google navigation experience. \n\n Declaration \n Swift \n\n @NSCopying var exitCueBackgroundColor: UIColor! { get set }\n\n Objective-C \n\n @property (nonatomic, copy, null_resettable) UIColor *exitCueBackgroundColor;"]]