Skip to content

Commit

Permalink
docs: Update docs (#444)
Browse files Browse the repository at this point in the history
  • Loading branch information
googlemaps-bot authored Oct 25, 2023
1 parent 8ab8fe9 commit 4434ff1
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ <h1 class="cover"><span>Street</span><wbr><span><span>View</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":maps-compose:dokkaHtmlPartial/release"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html"><span class="token annotation builtin">Composable</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><a href="-street-view.html"><span class="token function">StreetView</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">modifier<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier.html">Modifier</a><span class="token operator"> = </span>Modifier<span class="token punctuation">, </span></span><span class="parameter ">cameraPositionState<span class="token operator">: </span><a href="-street-view-camera-position-state/index.html">StreetViewCameraPositionState</a><span class="token operator"> = </span>rememberStreetViewCameraPositionState()<span class="token punctuation">, </span></span><span class="parameter ">streetViewPanoramaOptionsFactory<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><span data-unresolved-link="com.google.android.gms.maps/StreetViewPanoramaOptions///PointingToDeclaration/">StreetViewPanoramaOptions</span><span class="token operator"> = </span>{
StreetViewPanoramaOptions()
}<span class="token punctuation">, </span></span><span class="parameter ">isPanningGesturesEnabled<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span><span class="token punctuation">, </span></span><span class="parameter ">isStreetNamesEnabled<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span><span class="token punctuation">, </span></span><span class="parameter ">isUserNavigationEnabled<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span><span class="token punctuation">, </span></span><span class="parameter ">isZoomGesturesEnabled<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span><span class="token punctuation">, </span></span><span class="parameter ">onClick<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><span data-unresolved-link="com.google.android.gms.maps.model/StreetViewPanoramaOrientation///PointingToDeclaration/">StreetViewPanoramaOrientation</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator"> = </span>{}<span class="token punctuation">, </span></span><span class="parameter ">onLongClick<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><span data-unresolved-link="com.google.android.gms.maps.model/StreetViewPanoramaOrientation///PointingToDeclaration/">StreetViewPanoramaOrientation</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator"> = </span>{}</span></span><span class="token punctuation">)</span></div><p class="paragraph">A composable for displaying a Street View for a given location.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":maps-compose:dokkaHtmlPartial/release" data-filterable-set=":maps-compose:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>modifier</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Modifier to be applied to the StreetView</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose:dokkaHtmlPartial/release" data-filterable-set=":maps-compose:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>camera</span><wbr><span>Position</span><wbr><span><span>State</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the <a href="-street-view-camera-position-state/index.html">StreetViewCameraPositionState</a> to be used to control or observe the Street View's camera</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose:dokkaHtmlPartial/release" data-filterable-set=":maps-compose:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>street</span><wbr><span>View</span><wbr><span>Panorama</span><wbr><span>Options</span><wbr><span><span>Factory</span></span></u></div></span></div><div><div class="title"><p class="paragraph">a factory lambda for providing a <span data-unresolved-link="com.google.android.gms.maps/StreetViewPanoramaOptions///PointingToDeclaration/">StreetViewPanoramaOptions</span> object which is used when the underlying <span data-unresolved-link="com.google.android.gms.maps/StreetViewPanoramaView///PointingToDeclaration/">StreetViewPanoramaView</span> is constructed</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose:dokkaHtmlPartial/release" data-filterable-set=":maps-compose:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>is</span><wbr><span>Panning</span><wbr><span>Gestures</span><wbr><span><span>Enabled</span></span></u></div></span></div><div><div class="title"><p class="paragraph">whether panning gestures are enabled or not</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose:dokkaHtmlPartial/release" data-filterable-set=":maps-compose:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>is</span><wbr><span>Street</span><wbr><span>Names</span><wbr><span><span>Enabled</span></span></u></div></span></div><div><div class="title"><p class="paragraph">whether street names are enabled or not</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose:dokkaHtmlPartial/release" data-filterable-set=":maps-compose:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>is</span><wbr><span>User</span><wbr><span>Navigation</span><wbr><span><span>Enabled</span></span></u></div></span></div><div><div class="title"><p class="paragraph">whether user navigation is enabled or not</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose:dokkaHtmlPartial/release" data-filterable-set=":maps-compose:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>is</span><wbr><span>Zoom</span><wbr><span>Gestures</span><wbr><span><span>Enabled</span></span></u></div></span></div><div><div class="title"><p class="paragraph">whether zoom gestures are enabled or not</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose:dokkaHtmlPartial/release" data-filterable-set=":maps-compose:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr><span><span>Click</span></span></u></div></span></div><div><div class="title"><p class="paragraph">lambda to receive events when the Street View is clicked</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose:dokkaHtmlPartial/release" data-filterable-set=":maps-compose:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr><span>Long</span><wbr><span><span>Click</span></span></u></div></span></div><div><div class="title"><p class="paragraph">lambda to receive events when the Street View is long clicked</p></div></div></div></div></div></div></div>
}<span class="token punctuation">, </span></span><span class="parameter ">isPanningGesturesEnabled<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span><span class="token punctuation">, </span></span><span class="parameter ">isStreetNamesEnabled<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span><span class="token punctuation">, </span></span><span class="parameter ">isUserNavigationEnabled<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span><span class="token punctuation">, </span></span><span class="parameter ">isZoomGesturesEnabled<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span><span class="token punctuation">, </span></span><span class="parameter ">onClick<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><span data-unresolved-link="com.google.android.gms.maps.model/StreetViewPanoramaOrientation///PointingToDeclaration/">StreetViewPanoramaOrientation</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator"> = </span>{}<span class="token punctuation">, </span></span><span class="parameter ">onLongClick<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><span data-unresolved-link="com.google.android.gms.maps.model/StreetViewPanoramaOrientation///PointingToDeclaration/">StreetViewPanoramaOrientation</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator"> = </span>{}</span></span><span class="token punctuation">)</span></div><p class="paragraph">A composable for displaying a Street View for a given location. A location might not be available for a given set of coordinates. We recommend you to check our sample on StreetViewActivity using our utility function in StreetViewUtils to manage non-existing locations.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":maps-compose:dokkaHtmlPartial/release" data-filterable-set=":maps-compose:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>modifier</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Modifier to be applied to the StreetView</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose:dokkaHtmlPartial/release" data-filterable-set=":maps-compose:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>camera</span><wbr><span>Position</span><wbr><span><span>State</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the <a href="-street-view-camera-position-state/index.html">StreetViewCameraPositionState</a> to be used to control or observe the Street View's camera</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose:dokkaHtmlPartial/release" data-filterable-set=":maps-compose:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>street</span><wbr><span>View</span><wbr><span>Panorama</span><wbr><span>Options</span><wbr><span><span>Factory</span></span></u></div></span></div><div><div class="title"><p class="paragraph">a factory lambda for providing a <span data-unresolved-link="com.google.android.gms.maps/StreetViewPanoramaOptions///PointingToDeclaration/">StreetViewPanoramaOptions</span> object which is used when the underlying <span data-unresolved-link="com.google.android.gms.maps/StreetViewPanoramaView///PointingToDeclaration/">StreetViewPanoramaView</span> is constructed</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose:dokkaHtmlPartial/release" data-filterable-set=":maps-compose:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>is</span><wbr><span>Panning</span><wbr><span>Gestures</span><wbr><span><span>Enabled</span></span></u></div></span></div><div><div class="title"><p class="paragraph">whether panning gestures are enabled or not</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose:dokkaHtmlPartial/release" data-filterable-set=":maps-compose:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>is</span><wbr><span>Street</span><wbr><span>Names</span><wbr><span><span>Enabled</span></span></u></div></span></div><div><div class="title"><p class="paragraph">whether street names are enabled or not</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose:dokkaHtmlPartial/release" data-filterable-set=":maps-compose:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>is</span><wbr><span>User</span><wbr><span>Navigation</span><wbr><span><span>Enabled</span></span></u></div></span></div><div><div class="title"><p class="paragraph">whether user navigation is enabled or not</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose:dokkaHtmlPartial/release" data-filterable-set=":maps-compose:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>is</span><wbr><span>Zoom</span><wbr><span>Gestures</span><wbr><span><span>Enabled</span></span></u></div></span></div><div><div class="title"><p class="paragraph">whether zoom gestures are enabled or not</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose:dokkaHtmlPartial/release" data-filterable-set=":maps-compose:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr><span><span>Click</span></span></u></div></span></div><div><div class="title"><p class="paragraph">lambda to receive events when the Street View is clicked</p></div></div></div></div><div class="table-row" data-filterable-current=":maps-compose:dokkaHtmlPartial/release" data-filterable-set=":maps-compose:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr><span>Long</span><wbr><span><span>Click</span></span></u></div></span></div><div><div class="title"><p class="paragraph">lambda to receive events when the Street View is long clicked</p></div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
Expand Down
Loading

0 comments on commit 4434ff1

Please sign in to comment.