6363 </ div >
6464 < div class ="navigation-list-wrapper ">
6565 < ul class ="navigation-list search-empty ">
66+ < li class ="item item-module toggle-manual toggle-manual-show " data-longname ="module:ol/layer/Heatmap " data-name ="ol/layer/heatmap ">
67+ < span class ="title toggle ">
68+ < span class ="fa fa-plus me-2 mt-1 "> </ span >
69+ < span > < a href ="module-ol_layer_Heatmap.html "> ol/layer/Heatmap</ a > </ span >
70+ </ span >
71+ < div class ="member-list " data-type ="typedefs ">
72+ < span class ="subtitle "> Typedefs</ span >
73+ < ul >
74+ < li data-name ="options "> < a href ="module-ol_layer_Heatmap.html#~Options "> Options</ a >
75+ < li data-name ="weightexpression "> < a href ="module-ol_layer_Heatmap.html#~WeightExpression "> WeightExpression</ a >
76+ </ ul >
77+ </ div >
6678 < li class ="loading "> Loading …
6779 </ ul >
6880 </ div >
@@ -457,7 +469,7 @@ <h5 class="subsection-title">Properties:</h5>
457469 < td class ="type ">
458470
459471
460- < span class ="param-type "> number </ span >
472+ < span class ="param-type "> < a href =" module-ol_style_flat.html#~NumberExpression " > NumberExpression </ a > </ span >
461473
462474
463475
@@ -467,7 +479,8 @@ <h5 class="subsection-title">Properties:</h5>
467479 </ td >
468480
469481 < td class ="description last ">
470- < p > Radius size in pixels.</ p >
482+ < p > Radius size in pixels. Note that for LineStrings,
483+ the width of the line will be double the radius.</ p >
471484
472485 </ td >
473486 </ tr >
@@ -482,7 +495,7 @@ <h5 class="subsection-title">Properties:</h5>
482495 < td class ="type ">
483496
484497
485- < span class ="param-type "> number </ span >
498+ < span class ="param-type "> < a href =" module-ol_style_flat.html#~NumberExpression " > NumberExpression </ a > </ span >
486499
487500
488501
@@ -492,7 +505,8 @@ <h5 class="subsection-title">Properties:</h5>
492505 </ td >
493506
494507 < td class ="description last ">
495- < p > Blur size in pixels.</ p >
508+ < p > Blur size in pixels. This is added to the < code > radius</ code >
509+ parameter above to create the final size of the blur effect.</ p >
496510
497511 </ td >
498512 </ tr >
@@ -507,10 +521,7 @@ <h5 class="subsection-title">Properties:</h5>
507521 < td class ="type ">
508522
509523
510- < span class ="param-type "> string</ span >
511- |
512-
513- < span class ="param-type "> function</ span >
524+ < span class ="param-type "> < a href ="module-ol_layer_Heatmap.html#~WeightExpression "> WeightExpression</ a > </ span >
514525
515526
516527
@@ -521,14 +532,60 @@ <h5 class="subsection-title">Properties:</h5>
521532
522533 < td class ="description last ">
523534 < p > The feature
524- attribute to use for the weight or a function that returns a weight from a feature. Weight values
535+ attribute to use for the weight. This also supports expressions returning a number or a function that returns a weight from a feature. Weight values
525536should range from 0 to 1 (and values outside will be clamped to that range).</ p >
526537
527538 </ td >
528539 </ tr >
529540
530541
531542
543+ < tr >
544+
545+ < td class ="name "> < code > filter</ code > </ td >
546+
547+
548+ < td class ="type ">
549+
550+
551+ < span class ="param-type "> < a href ="module-ol_style_flat.html#~BooleanExpression "> BooleanExpression</ a > </ span >
552+
553+ | undefined
554+
555+
556+ </ td >
557+
558+ < td class ="description last ">
559+ < p > Optional filter expression.</ p >
560+
561+ </ td >
562+ </ tr >
563+
564+
565+
566+ < tr >
567+
568+ < td class ="name "> < code > variables</ code > </ td >
569+
570+
571+ < td class ="type ">
572+
573+
574+ < span class ="param-type "> Object.<string, (number|Array.<number> |string|boolean)> </ span >
575+
576+ | undefined
577+
578+
579+ </ td >
580+
581+ < td class ="description last ">
582+ < p > Variables used in expressions (optional)</ p >
583+
584+ </ td >
585+ </ tr >
586+
587+
588+
532589 < tr >
533590
534591 < td class ="name "> < code > source</ code > </ td >
@@ -602,6 +659,82 @@ <h5 class="subsection-title">Properties:</h5>
602659
603660
604661
662+ </ dd >
663+
664+
665+
666+ < dt class ="">
667+
668+ < div class ="nameContainer ">
669+ < div class ="anchor " id ="~WeightExpression ">
670+ </ div >
671+ < h4 class ="name ">
672+ WeightExpression< span class ="signature "> ()</ span >
673+
674+
675+
676+ </ h4 >
677+
678+ < div class ="tag-source ">
679+ < a href ="https://github.com/openlayers/openlayers/blob/main/src/ol/layer/Heatmap.js "> layer/Heatmap.js</ a > ,
680+ < a href ="https://github.com/openlayers/openlayers/blob/main/src/ol/layer/Heatmap.js#L18 "> line 18</ a >
681+ </ div >
682+
683+ </ div >
684+
685+
686+ </ dt >
687+ < dd class ="">
688+
689+
690+
691+
692+
693+
694+
695+
696+
697+
698+
699+
700+
701+
702+ < dl class ="details ">
703+
704+
705+
706+
707+
708+
709+
710+
711+
712+
713+
714+
715+
716+
717+
718+
719+
720+
721+
722+
723+
724+ </ dl >
725+
726+
727+
728+
729+
730+
731+
732+
733+
734+
735+
736+
737+
605738</ dd >
606739
607740 </ dl >
0 commit comments