Skip to content

Commit

Permalink
docs: Update docs (#657)
Browse files Browse the repository at this point in the history
  • Loading branch information
@googlemaps-bot
googlemaps-bot authored Dec 3, 2024
1 parent e57a832 commit 767e6d2
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion maps-compose/com.google.maps.android.compose/-circle.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
<div class="cover ">
<h1 class="cover"><span><span>Circle</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">fun </span><a href="-circle.html"><span class="token function">Circle</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">center<span class="token operator">: </span><span data-unresolved-link="com.google.android.gms.maps.model/LatLng///PointingToDeclaration/">LatLng</span><span class="token punctuation">, </span></span><span class="parameter ">clickable<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">false</span><span class="token punctuation">, </span></span><span class="parameter ">fillColor<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color.html">Color</a><span class="token operator"> = </span>Color.Transparent<span class="token punctuation">, </span></span><span class="parameter ">radius<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token operator"> = </span><span class="token constant">0.0</span><span class="token punctuation">, </span></span><span class="parameter ">strokeColor<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color.html">Color</a><span class="token operator"> = </span>Color.Black<span class="token punctuation">, </span></span><span class="parameter ">strokePattern<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span data-unresolved-link="com.google.android.gms.maps.model/PatternItem///PointingToDeclaration/">PatternItem</span><span class="token operator">&gt;</span><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">strokeWidth<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a><span class="token operator"> = </span><span class="token constant">10.0f</span><span class="token punctuation">, </span></span><span class="parameter ">tag<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">visible<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 ">zIndex<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a><span class="token operator"> = </span><span class="token constant">0.0f</span><span class="token punctuation">, </span></span><span class="parameter ">onClick<span class="token operator">: </span><span class="token punctuation">(</span><span data-unresolved-link="com.google.android.gms.maps.model/Circle///PointingToDeclaration/">Circle</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </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 a circle on the map.</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>center</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the <span data-unresolved-link="com.google.android.gms.maps.model/LatLng///PointingToDeclaration/">LatLng</span> to use for the center of this circle</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><span>clickable</span></span></u></div></span></div><div><div class="title"><p class="paragraph">boolean indicating if the circle is clickable 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>fill</span><wbr><span><span>Color</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the fill color of the circle</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><span>radius</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the radius of the circle in meters.</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>stroke</span><wbr><span><span>Color</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the stroke color of the circle</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>stroke</span><wbr><span><span>Pattern</span></span></u></div></span></div><div><div class="title"><p class="paragraph">a sequence of <span data-unresolved-link="com.google.android.gms.maps.model/PatternItem///PointingToDeclaration/">PatternItem</span> to be repeated along the circle's outline (null represents a solid line)</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><span>tag</span></span></u></div></span></div><div><div class="title"><p class="paragraph">optional tag to be associated with the circle</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>stroke</span><wbr><span><span>Width</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the width of the circle's outline in screen pixels</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><span>visible</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the visibility of the circle</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>z</span><wbr><span><span>Index</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the z-index of the circle</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">a lambda invoked when the circle is clicked</p></div></div></div></div></div></div></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">fun </span><a href="-circle.html"><span class="token function">Circle</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">center<span class="token operator">: </span><span data-unresolved-link="com.google.android.gms.maps.model/LatLng///PointingToDeclaration/">LatLng</span><span class="token punctuation">, </span></span><span class="parameter ">clickable<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">false</span><span class="token punctuation">, </span></span><span class="parameter ">fillColor<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color.html">Color</a><span class="token operator"> = </span>Color.Black<span class="token punctuation">, </span></span><span class="parameter ">radius<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token operator"> = </span><span class="token constant">10.0</span><span class="token punctuation">, </span></span><span class="parameter ">strokeColor<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color.html">Color</a><span class="token operator"> = </span>Color.Black<span class="token punctuation">, </span></span><span class="parameter ">strokePattern<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span data-unresolved-link="com.google.android.gms.maps.model/PatternItem///PointingToDeclaration/">PatternItem</span><span class="token operator">&gt;</span><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">strokeWidth<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a><span class="token operator"> = </span><span class="token constant">10.0f</span><span class="token punctuation">, </span></span><span class="parameter ">tag<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">visible<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 ">zIndex<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a><span class="token operator"> = </span><span class="token constant">0.0f</span><span class="token punctuation">, </span></span><span class="parameter ">onClick<span class="token operator">: </span><span class="token punctuation">(</span><span data-unresolved-link="com.google.android.gms.maps.model/Circle///PointingToDeclaration/">Circle</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </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 a circle on the map.</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>center</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the <span data-unresolved-link="com.google.android.gms.maps.model/LatLng///PointingToDeclaration/">LatLng</span> to use for the center of this circle</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><span>clickable</span></span></u></div></span></div><div><div class="title"><p class="paragraph">boolean indicating if the circle is clickable 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>fill</span><wbr><span><span>Color</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the fill color of the circle</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><span>radius</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the radius of the circle in meters.</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>stroke</span><wbr><span><span>Color</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the stroke color of the circle</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>stroke</span><wbr><span><span>Pattern</span></span></u></div></span></div><div><div class="title"><p class="paragraph">a sequence of <span data-unresolved-link="com.google.android.gms.maps.model/PatternItem///PointingToDeclaration/">PatternItem</span> to be repeated along the circle's outline (null represents a solid line)</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><span>tag</span></span></u></div></span></div><div><div class="title"><p class="paragraph">optional tag to be associated with the circle</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>stroke</span><wbr><span><span>Width</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the width of the circle's outline in screen pixels</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><span>visible</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the visibility of the circle</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>z</span><wbr><span><span>Index</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the z-index of the circle</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">a lambda invoked when the circle is 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>© 2024 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 767e6d2

Please sign in to comment.