@fusion.dev/helix 0.117.0 → 0.119.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/custom-elements.json +1237 -297
- package/dist/canvas/root/canvas-root.css.js +4 -0
- package/dist/element-events.generated.js +2 -0
- package/dist/map/root/map-root.css.js +0 -37
- package/dist/shared/viewport/viewport.css.js +37 -0
- package/package.json +6 -6
- package/types/jsx.d.ts +506 -120
- package/types/vue.d.ts +152 -37
package/custom-elements.json
CHANGED
|
@@ -14451,6 +14451,19 @@
|
|
|
14451
14451
|
"attribute": "separation",
|
|
14452
14452
|
"reflects": true
|
|
14453
14453
|
},
|
|
14454
|
+
{
|
|
14455
|
+
"kind": "field",
|
|
14456
|
+
"name": "activateHintLabel",
|
|
14457
|
+
"type": {
|
|
14458
|
+
"text": "string | undefined"
|
|
14459
|
+
},
|
|
14460
|
+
"description": "The hint shown when a surface waiting to be pressed is scrolled or\nswiped over, with `gestures=\"activate\"`. Absent is the family's own.",
|
|
14461
|
+
"attribute": "activate-hint-label",
|
|
14462
|
+
"inheritedFrom": {
|
|
14463
|
+
"name": "MixinViewport",
|
|
14464
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14465
|
+
}
|
|
14466
|
+
},
|
|
14454
14467
|
{
|
|
14455
14468
|
"kind": "field",
|
|
14456
14469
|
"name": "controls",
|
|
@@ -14506,6 +14519,19 @@
|
|
|
14506
14519
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14507
14520
|
}
|
|
14508
14521
|
},
|
|
14522
|
+
{
|
|
14523
|
+
"kind": "field",
|
|
14524
|
+
"name": "gestures",
|
|
14525
|
+
"type": {
|
|
14526
|
+
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
14527
|
+
},
|
|
14528
|
+
"description": "Which gestures the surface takes from the page.\n\n- `always`: the surface takes the wheel and one finger, for a surface\n that is the page, such as a full-screen view. A map rests here.\n- Unset is the family's own: `always` for a map, and for a board, a\n drag and a pinch, with the plain wheel left to the page until the\n board fills the screen.\n- `cooperative`: the wheel and one finger scroll the page, and the\n surface takes Ctrl or ⌘ with the wheel, and two fingers. The frame\n says so when a gesture passes to the page. Best for a surface embedded\n in a page.\n- `activate`: the surface takes nothing until it is pressed, and gives it\n back on Escape, when the pointer leaves it, or on a press elsewhere.\n\nThe keyboard and the frame's buttons work in every mode.\n\n**Unreflected and without a default**, because a default that reflected\nwould write an attribute onto every host that no server sent, and the\nhydration that followed would disagree with it.",
|
|
14529
|
+
"attribute": "gestures",
|
|
14530
|
+
"inheritedFrom": {
|
|
14531
|
+
"name": "MixinViewport",
|
|
14532
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14533
|
+
}
|
|
14534
|
+
},
|
|
14509
14535
|
{
|
|
14510
14536
|
"kind": "field",
|
|
14511
14537
|
"name": "idleDelay",
|
|
@@ -14590,6 +14616,45 @@
|
|
|
14590
14616
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14591
14617
|
}
|
|
14592
14618
|
},
|
|
14619
|
+
{
|
|
14620
|
+
"kind": "field",
|
|
14621
|
+
"name": "twoFingerHintLabel",
|
|
14622
|
+
"type": {
|
|
14623
|
+
"text": "string | undefined"
|
|
14624
|
+
},
|
|
14625
|
+
"description": "The hint shown when one finger swipes over a surface with\n`gestures=\"cooperative\"`. Absent is the family's own.",
|
|
14626
|
+
"attribute": "two-finger-hint-label",
|
|
14627
|
+
"inheritedFrom": {
|
|
14628
|
+
"name": "MixinViewport",
|
|
14629
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14630
|
+
}
|
|
14631
|
+
},
|
|
14632
|
+
{
|
|
14633
|
+
"kind": "field",
|
|
14634
|
+
"name": "usingLabel",
|
|
14635
|
+
"type": {
|
|
14636
|
+
"text": "string | undefined"
|
|
14637
|
+
},
|
|
14638
|
+
"description": "The line shown while a surface with `gestures=\"activate\"` has the\ngestures. Absent is the family's own.",
|
|
14639
|
+
"attribute": "using-label",
|
|
14640
|
+
"inheritedFrom": {
|
|
14641
|
+
"name": "MixinViewport",
|
|
14642
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14643
|
+
}
|
|
14644
|
+
},
|
|
14645
|
+
{
|
|
14646
|
+
"kind": "field",
|
|
14647
|
+
"name": "wheelHintLabel",
|
|
14648
|
+
"type": {
|
|
14649
|
+
"text": "string | undefined"
|
|
14650
|
+
},
|
|
14651
|
+
"description": "The hint shown when the wheel scrolls past a surface with\n`gestures=\"cooperative\"`, with `{key}`, which is ⌘ on a Mac and Ctrl\nelsewhere. Absent is the family's own.",
|
|
14652
|
+
"attribute": "wheel-hint-label",
|
|
14653
|
+
"inheritedFrom": {
|
|
14654
|
+
"name": "MixinViewport",
|
|
14655
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14656
|
+
}
|
|
14657
|
+
},
|
|
14593
14658
|
{
|
|
14594
14659
|
"kind": "field",
|
|
14595
14660
|
"name": "zoomInLabel",
|
|
@@ -14632,6 +14697,73 @@
|
|
|
14632
14697
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14633
14698
|
}
|
|
14634
14699
|
},
|
|
14700
|
+
{
|
|
14701
|
+
"kind": "field",
|
|
14702
|
+
"name": "gesturesTaken",
|
|
14703
|
+
"type": {
|
|
14704
|
+
"text": "boolean"
|
|
14705
|
+
},
|
|
14706
|
+
"privacy": "protected",
|
|
14707
|
+
"default": "false",
|
|
14708
|
+
"description": "Whether an `activate` surface has been pressed, and has the gestures.",
|
|
14709
|
+
"inheritedFrom": {
|
|
14710
|
+
"name": "MixinViewport",
|
|
14711
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14712
|
+
}
|
|
14713
|
+
},
|
|
14714
|
+
{
|
|
14715
|
+
"kind": "field",
|
|
14716
|
+
"name": "hint",
|
|
14717
|
+
"type": {
|
|
14718
|
+
"text": "string"
|
|
14719
|
+
},
|
|
14720
|
+
"privacy": "private",
|
|
14721
|
+
"default": "''",
|
|
14722
|
+
"description": "The hint over the surface while one shows, put there by a gesture it let pass.",
|
|
14723
|
+
"inheritedFrom": {
|
|
14724
|
+
"name": "MixinViewport",
|
|
14725
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14726
|
+
}
|
|
14727
|
+
},
|
|
14728
|
+
{
|
|
14729
|
+
"kind": "field",
|
|
14730
|
+
"name": "hinting",
|
|
14731
|
+
"type": {
|
|
14732
|
+
"text": "ReturnType<typeof setTimeout> | undefined"
|
|
14733
|
+
},
|
|
14734
|
+
"privacy": "private",
|
|
14735
|
+
"description": "When the hint goes.",
|
|
14736
|
+
"inheritedFrom": {
|
|
14737
|
+
"name": "MixinViewport",
|
|
14738
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14739
|
+
}
|
|
14740
|
+
},
|
|
14741
|
+
{
|
|
14742
|
+
"kind": "field",
|
|
14743
|
+
"name": "hintAt",
|
|
14744
|
+
"type": {
|
|
14745
|
+
"text": "{ x: number; y: number } | undefined"
|
|
14746
|
+
},
|
|
14747
|
+
"privacy": "private",
|
|
14748
|
+
"description": "Where the gesture was, in the viewport's box, which the hint is shown\nat: where the reader is looking, and on the surface wherever a page laid\nits own content over the rest of it.",
|
|
14749
|
+
"inheritedFrom": {
|
|
14750
|
+
"name": "MixinViewport",
|
|
14751
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14752
|
+
}
|
|
14753
|
+
},
|
|
14754
|
+
{
|
|
14755
|
+
"kind": "field",
|
|
14756
|
+
"name": "takenBy",
|
|
14757
|
+
"type": {
|
|
14758
|
+
"text": "Event | undefined"
|
|
14759
|
+
},
|
|
14760
|
+
"privacy": "private",
|
|
14761
|
+
"description": "The press that took the gestures, which is not also the first gesture.",
|
|
14762
|
+
"inheritedFrom": {
|
|
14763
|
+
"name": "MixinViewport",
|
|
14764
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14765
|
+
}
|
|
14766
|
+
},
|
|
14635
14767
|
{
|
|
14636
14768
|
"kind": "field",
|
|
14637
14769
|
"name": "fullscreen",
|
|
@@ -14682,6 +14814,180 @@
|
|
|
14682
14814
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14683
14815
|
}
|
|
14684
14816
|
},
|
|
14817
|
+
{
|
|
14818
|
+
"kind": "field",
|
|
14819
|
+
"name": "restingGestureLabels",
|
|
14820
|
+
"type": {
|
|
14821
|
+
"text": "ViewportGestureLabels"
|
|
14822
|
+
},
|
|
14823
|
+
"privacy": "protected",
|
|
14824
|
+
"description": "What the surface says about its gestures where the page does not say\nit, which a family overrides to name what it is: \"Press the map to use\nit\" reads better than a word that fits every surface.",
|
|
14825
|
+
"readonly": true,
|
|
14826
|
+
"inheritedFrom": {
|
|
14827
|
+
"name": "MixinViewport",
|
|
14828
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14829
|
+
}
|
|
14830
|
+
},
|
|
14831
|
+
{
|
|
14832
|
+
"kind": "method",
|
|
14833
|
+
"name": "gestureAllowed",
|
|
14834
|
+
"privacy": "protected",
|
|
14835
|
+
"return": {
|
|
14836
|
+
"type": {
|
|
14837
|
+
"text": "boolean"
|
|
14838
|
+
}
|
|
14839
|
+
},
|
|
14840
|
+
"parameters": [
|
|
14841
|
+
{
|
|
14842
|
+
"name": "event",
|
|
14843
|
+
"type": {
|
|
14844
|
+
"text": "Event"
|
|
14845
|
+
}
|
|
14846
|
+
}
|
|
14847
|
+
],
|
|
14848
|
+
"description": "Whether a gesture that started with this event is the surface's to\nanswer, for a family that answers gestures itself. Never while an\n`activate` surface waits, and never on the press that ended the wait:\nthat press hands over the gestures and moves nothing.",
|
|
14849
|
+
"inheritedFrom": {
|
|
14850
|
+
"name": "MixinViewport",
|
|
14851
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14852
|
+
}
|
|
14853
|
+
},
|
|
14854
|
+
{
|
|
14855
|
+
"kind": "method",
|
|
14856
|
+
"name": "gesturesChanged",
|
|
14857
|
+
"privacy": "protected",
|
|
14858
|
+
"return": {
|
|
14859
|
+
"type": {
|
|
14860
|
+
"text": "void"
|
|
14861
|
+
}
|
|
14862
|
+
},
|
|
14863
|
+
"description": "Says that `gestureMode` changed. Nothing here; a family whose renderer\nis told through a connector says it with its own event.",
|
|
14864
|
+
"inheritedFrom": {
|
|
14865
|
+
"name": "MixinViewport",
|
|
14866
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14867
|
+
}
|
|
14868
|
+
},
|
|
14869
|
+
{
|
|
14870
|
+
"kind": "method",
|
|
14871
|
+
"name": "showHint",
|
|
14872
|
+
"privacy": "private",
|
|
14873
|
+
"return": {
|
|
14874
|
+
"type": {
|
|
14875
|
+
"text": "void"
|
|
14876
|
+
}
|
|
14877
|
+
},
|
|
14878
|
+
"parameters": [
|
|
14879
|
+
{
|
|
14880
|
+
"name": "words",
|
|
14881
|
+
"type": {
|
|
14882
|
+
"text": "string"
|
|
14883
|
+
}
|
|
14884
|
+
},
|
|
14885
|
+
{
|
|
14886
|
+
"name": "at",
|
|
14887
|
+
"optional": true,
|
|
14888
|
+
"type": {
|
|
14889
|
+
"text": "{ clientX: number; clientY: number }"
|
|
14890
|
+
}
|
|
14891
|
+
}
|
|
14892
|
+
],
|
|
14893
|
+
"description": "Shows a hint over the surface for a moment, where the gesture was.",
|
|
14894
|
+
"inheritedFrom": {
|
|
14895
|
+
"name": "MixinViewport",
|
|
14896
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14897
|
+
}
|
|
14898
|
+
},
|
|
14899
|
+
{
|
|
14900
|
+
"kind": "field",
|
|
14901
|
+
"name": "handleGestureWheel",
|
|
14902
|
+
"privacy": "private",
|
|
14903
|
+
"readonly": true,
|
|
14904
|
+
"description": "A wheel the surface let pass to the page, which is said: a reader\nscrolling the page past a surface that did not zoom is told why, and how\nto zoom it. **Ctrl or ⌘ with the wheel is the surface's**, and is what a\ntrackpad's pinch arrives as.",
|
|
14905
|
+
"inheritedFrom": {
|
|
14906
|
+
"name": "MixinViewport",
|
|
14907
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14908
|
+
}
|
|
14909
|
+
},
|
|
14910
|
+
{
|
|
14911
|
+
"kind": "field",
|
|
14912
|
+
"name": "handleGestureTouch",
|
|
14913
|
+
"privacy": "private",
|
|
14914
|
+
"readonly": true,
|
|
14915
|
+
"description": "One finger moving over the surface, which scrolls the page, and is said.",
|
|
14916
|
+
"inheritedFrom": {
|
|
14917
|
+
"name": "MixinViewport",
|
|
14918
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14919
|
+
}
|
|
14920
|
+
},
|
|
14921
|
+
{
|
|
14922
|
+
"kind": "field",
|
|
14923
|
+
"name": "handleTake",
|
|
14924
|
+
"privacy": "private",
|
|
14925
|
+
"readonly": true,
|
|
14926
|
+
"description": "A press on the surface itself, which hands a waiting surface the gestures.",
|
|
14927
|
+
"inheritedFrom": {
|
|
14928
|
+
"name": "MixinViewport",
|
|
14929
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14930
|
+
}
|
|
14931
|
+
},
|
|
14932
|
+
{
|
|
14933
|
+
"kind": "field",
|
|
14934
|
+
"name": "handleGiveBackKey",
|
|
14935
|
+
"privacy": "private",
|
|
14936
|
+
"readonly": true,
|
|
14937
|
+
"description": "Escape, which gives the page its scroll back.",
|
|
14938
|
+
"inheritedFrom": {
|
|
14939
|
+
"name": "MixinViewport",
|
|
14940
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14941
|
+
}
|
|
14942
|
+
},
|
|
14943
|
+
{
|
|
14944
|
+
"kind": "field",
|
|
14945
|
+
"name": "handleGiveBackOutside",
|
|
14946
|
+
"privacy": "private",
|
|
14947
|
+
"readonly": true,
|
|
14948
|
+
"description": "A press anywhere else on the page, which gives it its scroll back.",
|
|
14949
|
+
"inheritedFrom": {
|
|
14950
|
+
"name": "MixinViewport",
|
|
14951
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14952
|
+
}
|
|
14953
|
+
},
|
|
14954
|
+
{
|
|
14955
|
+
"kind": "field",
|
|
14956
|
+
"name": "handleGiveBackBlur",
|
|
14957
|
+
"privacy": "private",
|
|
14958
|
+
"readonly": true,
|
|
14959
|
+
"description": "The window losing focus, as a reader switching away does.",
|
|
14960
|
+
"inheritedFrom": {
|
|
14961
|
+
"name": "MixinViewport",
|
|
14962
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14963
|
+
}
|
|
14964
|
+
},
|
|
14965
|
+
{
|
|
14966
|
+
"kind": "field",
|
|
14967
|
+
"name": "handlePointerLeave",
|
|
14968
|
+
"privacy": "protected",
|
|
14969
|
+
"readonly": true,
|
|
14970
|
+
"description": "The pointer leaving the frame, which the family binds on its region.\n**Heard on the frame and not the drawing**, which a pointer resting on\nsomething raised over it has left. **A mouse or a pen and never a\nfinger**, whose `pointerleave` is the finger lifting: a tap took the\nsurface and gave it back in one.",
|
|
14971
|
+
"inheritedFrom": {
|
|
14972
|
+
"name": "MixinViewport",
|
|
14973
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14974
|
+
}
|
|
14975
|
+
},
|
|
14976
|
+
{
|
|
14977
|
+
"kind": "method",
|
|
14978
|
+
"name": "renderGestures",
|
|
14979
|
+
"privacy": "protected",
|
|
14980
|
+
"return": {
|
|
14981
|
+
"type": {
|
|
14982
|
+
"text": "TemplateResult"
|
|
14983
|
+
}
|
|
14984
|
+
},
|
|
14985
|
+
"description": "The hint over the surface and the line while it is in use, which the\nfamily draws inside its viewport, over what was slotted. The parts are\nwritten out, as the controls' are, so the manifest sees them.",
|
|
14986
|
+
"inheritedFrom": {
|
|
14987
|
+
"name": "MixinViewport",
|
|
14988
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14989
|
+
}
|
|
14990
|
+
},
|
|
14685
14991
|
{
|
|
14686
14992
|
"kind": "method",
|
|
14687
14993
|
"name": "panEvent",
|
|
@@ -16768,6 +17074,17 @@
|
|
|
16768
17074
|
"module": "src/canvas/root/canvas-root.ts"
|
|
16769
17075
|
}
|
|
16770
17076
|
},
|
|
17077
|
+
{
|
|
17078
|
+
"kind": "field",
|
|
17079
|
+
"name": "handleTouchStart",
|
|
17080
|
+
"privacy": "private",
|
|
17081
|
+
"readonly": true,
|
|
17082
|
+
"description": "A second finger on a cooperative board, which would otherwise go on\nscrolling the page the first finger started: stopped at the start, so\nthe two fingers pinch and move the board. **Not passive**, which is the\nonly way a start can be stopped.",
|
|
17083
|
+
"inheritedFrom": {
|
|
17084
|
+
"name": "HelixHeadlessCanvas",
|
|
17085
|
+
"module": "src/canvas/root/canvas-root.ts"
|
|
17086
|
+
}
|
|
17087
|
+
},
|
|
16771
17088
|
{
|
|
16772
17089
|
"kind": "field",
|
|
16773
17090
|
"name": "handleStopKeydown",
|
|
@@ -17725,6 +18042,18 @@
|
|
|
17725
18042
|
"description": "How the board is set apart from the page. `plain` draws no frame.\n\nFramed is where it rests. Plain is for a board that fills a panel or an\napp's working area, where the container is already the frame.",
|
|
17726
18043
|
"fieldName": "separation"
|
|
17727
18044
|
},
|
|
18045
|
+
{
|
|
18046
|
+
"name": "activate-hint-label",
|
|
18047
|
+
"type": {
|
|
18048
|
+
"text": "string | undefined"
|
|
18049
|
+
},
|
|
18050
|
+
"description": "The hint shown when a surface waiting to be pressed is scrolled or\nswiped over, with `gestures=\"activate\"`. Absent is the family's own.",
|
|
18051
|
+
"fieldName": "activateHintLabel",
|
|
18052
|
+
"inheritedFrom": {
|
|
18053
|
+
"name": "MixinViewport",
|
|
18054
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
18055
|
+
}
|
|
18056
|
+
},
|
|
17728
18057
|
{
|
|
17729
18058
|
"name": "controls",
|
|
17730
18059
|
"type": {
|
|
@@ -17774,6 +18103,18 @@
|
|
|
17774
18103
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
17775
18104
|
}
|
|
17776
18105
|
},
|
|
18106
|
+
{
|
|
18107
|
+
"name": "gestures",
|
|
18108
|
+
"type": {
|
|
18109
|
+
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
18110
|
+
},
|
|
18111
|
+
"description": "Which gestures the surface takes from the page.\n\n- `always`: the surface takes the wheel and one finger, for a surface\n that is the page, such as a full-screen view. A map rests here.\n- Unset is the family's own: `always` for a map, and for a board, a\n drag and a pinch, with the plain wheel left to the page until the\n board fills the screen.\n- `cooperative`: the wheel and one finger scroll the page, and the\n surface takes Ctrl or ⌘ with the wheel, and two fingers. The frame\n says so when a gesture passes to the page. Best for a surface embedded\n in a page.\n- `activate`: the surface takes nothing until it is pressed, and gives it\n back on Escape, when the pointer leaves it, or on a press elsewhere.\n\nThe keyboard and the frame's buttons work in every mode.\n\n**Unreflected and without a default**, because a default that reflected\nwould write an attribute onto every host that no server sent, and the\nhydration that followed would disagree with it.",
|
|
18112
|
+
"fieldName": "gestures",
|
|
18113
|
+
"inheritedFrom": {
|
|
18114
|
+
"name": "MixinViewport",
|
|
18115
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
18116
|
+
}
|
|
18117
|
+
},
|
|
17777
18118
|
{
|
|
17778
18119
|
"name": "idle-delay",
|
|
17779
18120
|
"type": {
|
|
@@ -17852,6 +18193,42 @@
|
|
|
17852
18193
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
17853
18194
|
}
|
|
17854
18195
|
},
|
|
18196
|
+
{
|
|
18197
|
+
"name": "two-finger-hint-label",
|
|
18198
|
+
"type": {
|
|
18199
|
+
"text": "string | undefined"
|
|
18200
|
+
},
|
|
18201
|
+
"description": "The hint shown when one finger swipes over a surface with\n`gestures=\"cooperative\"`. Absent is the family's own.",
|
|
18202
|
+
"fieldName": "twoFingerHintLabel",
|
|
18203
|
+
"inheritedFrom": {
|
|
18204
|
+
"name": "MixinViewport",
|
|
18205
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
18206
|
+
}
|
|
18207
|
+
},
|
|
18208
|
+
{
|
|
18209
|
+
"name": "using-label",
|
|
18210
|
+
"type": {
|
|
18211
|
+
"text": "string | undefined"
|
|
18212
|
+
},
|
|
18213
|
+
"description": "The line shown while a surface with `gestures=\"activate\"` has the\ngestures. Absent is the family's own.",
|
|
18214
|
+
"fieldName": "usingLabel",
|
|
18215
|
+
"inheritedFrom": {
|
|
18216
|
+
"name": "MixinViewport",
|
|
18217
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
18218
|
+
}
|
|
18219
|
+
},
|
|
18220
|
+
{
|
|
18221
|
+
"name": "wheel-hint-label",
|
|
18222
|
+
"type": {
|
|
18223
|
+
"text": "string | undefined"
|
|
18224
|
+
},
|
|
18225
|
+
"description": "The hint shown when the wheel scrolls past a surface with\n`gestures=\"cooperative\"`, with `{key}`, which is ⌘ on a Mac and Ctrl\nelsewhere. Absent is the family's own.",
|
|
18226
|
+
"fieldName": "wheelHintLabel",
|
|
18227
|
+
"inheritedFrom": {
|
|
18228
|
+
"name": "MixinViewport",
|
|
18229
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
18230
|
+
}
|
|
18231
|
+
},
|
|
17855
18232
|
{
|
|
17856
18233
|
"name": "zoom-in-label",
|
|
17857
18234
|
"type": {
|
|
@@ -18218,6 +18595,22 @@
|
|
|
18218
18595
|
"module": "src/canvas/root/canvas-root.ts"
|
|
18219
18596
|
}
|
|
18220
18597
|
},
|
|
18598
|
+
{
|
|
18599
|
+
"description": "Words over the board for a moment when it lets a gesture pass to the page, such as how to zoom it.",
|
|
18600
|
+
"name": "gesture-hint",
|
|
18601
|
+
"inheritedFrom": {
|
|
18602
|
+
"name": "HelixHeadlessCanvas",
|
|
18603
|
+
"module": "src/canvas/root/canvas-root.ts"
|
|
18604
|
+
}
|
|
18605
|
+
},
|
|
18606
|
+
{
|
|
18607
|
+
"description": "The line shown while a board with `gestures=\"activate\"` has the gestures.",
|
|
18608
|
+
"name": "gesture-status",
|
|
18609
|
+
"inheritedFrom": {
|
|
18610
|
+
"name": "HelixHeadlessCanvas",
|
|
18611
|
+
"module": "src/canvas/root/canvas-root.ts"
|
|
18612
|
+
}
|
|
18613
|
+
},
|
|
18221
18614
|
{
|
|
18222
18615
|
"description": "The strip above the board.",
|
|
18223
18616
|
"name": "header",
|
|
@@ -18538,6 +18931,22 @@
|
|
|
18538
18931
|
"module": "src/canvas/root/canvas-root.ts"
|
|
18539
18932
|
}
|
|
18540
18933
|
},
|
|
18934
|
+
{
|
|
18935
|
+
"description": "The page keeps the plain wheel and one finger, with `gestures=\"cooperative\"` or while a board with `gestures=\"activate\"` waits to be pressed.",
|
|
18936
|
+
"name": "sharing",
|
|
18937
|
+
"inheritedFrom": {
|
|
18938
|
+
"name": "HelixHeadlessCanvas",
|
|
18939
|
+
"module": "src/canvas/root/canvas-root.ts"
|
|
18940
|
+
}
|
|
18941
|
+
},
|
|
18942
|
+
{
|
|
18943
|
+
"description": "A board with `gestures=\"activate\"` has been pressed and has the gestures.",
|
|
18944
|
+
"name": "using",
|
|
18945
|
+
"inheritedFrom": {
|
|
18946
|
+
"name": "HelixHeadlessCanvas",
|
|
18947
|
+
"module": "src/canvas/root/canvas-root.ts"
|
|
18948
|
+
}
|
|
18949
|
+
},
|
|
18541
18950
|
{
|
|
18542
18951
|
"description": "Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.",
|
|
18543
18952
|
"name": "settled",
|
|
@@ -61587,6 +61996,19 @@
|
|
|
61587
61996
|
}
|
|
61588
61997
|
],
|
|
61589
61998
|
"members": [
|
|
61999
|
+
{
|
|
62000
|
+
"kind": "field",
|
|
62001
|
+
"name": "activateHintLabel",
|
|
62002
|
+
"type": {
|
|
62003
|
+
"text": "string | undefined"
|
|
62004
|
+
},
|
|
62005
|
+
"description": "The hint shown when a surface waiting to be pressed is scrolled or\nswiped over, with `gestures=\"activate\"`. Absent is the family's own.",
|
|
62006
|
+
"attribute": "activate-hint-label",
|
|
62007
|
+
"inheritedFrom": {
|
|
62008
|
+
"name": "MixinViewport",
|
|
62009
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62010
|
+
}
|
|
62011
|
+
},
|
|
61590
62012
|
{
|
|
61591
62013
|
"kind": "field",
|
|
61592
62014
|
"name": "controls",
|
|
@@ -61642,6 +62064,19 @@
|
|
|
61642
62064
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
61643
62065
|
}
|
|
61644
62066
|
},
|
|
62067
|
+
{
|
|
62068
|
+
"kind": "field",
|
|
62069
|
+
"name": "gestures",
|
|
62070
|
+
"type": {
|
|
62071
|
+
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
62072
|
+
},
|
|
62073
|
+
"description": "Which gestures the surface takes from the page.\n\n- `always`: the surface takes the wheel and one finger, for a surface\n that is the page, such as a full-screen view. A map rests here.\n- Unset is the family's own: `always` for a map, and for a board, a\n drag and a pinch, with the plain wheel left to the page until the\n board fills the screen.\n- `cooperative`: the wheel and one finger scroll the page, and the\n surface takes Ctrl or ⌘ with the wheel, and two fingers. The frame\n says so when a gesture passes to the page. Best for a surface embedded\n in a page.\n- `activate`: the surface takes nothing until it is pressed, and gives it\n back on Escape, when the pointer leaves it, or on a press elsewhere.\n\nThe keyboard and the frame's buttons work in every mode.\n\n**Unreflected and without a default**, because a default that reflected\nwould write an attribute onto every host that no server sent, and the\nhydration that followed would disagree with it.",
|
|
62074
|
+
"attribute": "gestures",
|
|
62075
|
+
"inheritedFrom": {
|
|
62076
|
+
"name": "MixinViewport",
|
|
62077
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62078
|
+
}
|
|
62079
|
+
},
|
|
61645
62080
|
{
|
|
61646
62081
|
"kind": "field",
|
|
61647
62082
|
"name": "idleDelay",
|
|
@@ -61726,6 +62161,45 @@
|
|
|
61726
62161
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
61727
62162
|
}
|
|
61728
62163
|
},
|
|
62164
|
+
{
|
|
62165
|
+
"kind": "field",
|
|
62166
|
+
"name": "twoFingerHintLabel",
|
|
62167
|
+
"type": {
|
|
62168
|
+
"text": "string | undefined"
|
|
62169
|
+
},
|
|
62170
|
+
"description": "The hint shown when one finger swipes over a surface with\n`gestures=\"cooperative\"`. Absent is the family's own.",
|
|
62171
|
+
"attribute": "two-finger-hint-label",
|
|
62172
|
+
"inheritedFrom": {
|
|
62173
|
+
"name": "MixinViewport",
|
|
62174
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62175
|
+
}
|
|
62176
|
+
},
|
|
62177
|
+
{
|
|
62178
|
+
"kind": "field",
|
|
62179
|
+
"name": "usingLabel",
|
|
62180
|
+
"type": {
|
|
62181
|
+
"text": "string | undefined"
|
|
62182
|
+
},
|
|
62183
|
+
"description": "The line shown while a surface with `gestures=\"activate\"` has the\ngestures. Absent is the family's own.",
|
|
62184
|
+
"attribute": "using-label",
|
|
62185
|
+
"inheritedFrom": {
|
|
62186
|
+
"name": "MixinViewport",
|
|
62187
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62188
|
+
}
|
|
62189
|
+
},
|
|
62190
|
+
{
|
|
62191
|
+
"kind": "field",
|
|
62192
|
+
"name": "wheelHintLabel",
|
|
62193
|
+
"type": {
|
|
62194
|
+
"text": "string | undefined"
|
|
62195
|
+
},
|
|
62196
|
+
"description": "The hint shown when the wheel scrolls past a surface with\n`gestures=\"cooperative\"`, with `{key}`, which is ⌘ on a Mac and Ctrl\nelsewhere. Absent is the family's own.",
|
|
62197
|
+
"attribute": "wheel-hint-label",
|
|
62198
|
+
"inheritedFrom": {
|
|
62199
|
+
"name": "MixinViewport",
|
|
62200
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62201
|
+
}
|
|
62202
|
+
},
|
|
61729
62203
|
{
|
|
61730
62204
|
"kind": "field",
|
|
61731
62205
|
"name": "zoomInLabel",
|
|
@@ -61768,6 +62242,73 @@
|
|
|
61768
62242
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
61769
62243
|
}
|
|
61770
62244
|
},
|
|
62245
|
+
{
|
|
62246
|
+
"kind": "field",
|
|
62247
|
+
"name": "gesturesTaken",
|
|
62248
|
+
"type": {
|
|
62249
|
+
"text": "boolean"
|
|
62250
|
+
},
|
|
62251
|
+
"privacy": "protected",
|
|
62252
|
+
"default": "false",
|
|
62253
|
+
"description": "Whether an `activate` surface has been pressed, and has the gestures.",
|
|
62254
|
+
"inheritedFrom": {
|
|
62255
|
+
"name": "MixinViewport",
|
|
62256
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62257
|
+
}
|
|
62258
|
+
},
|
|
62259
|
+
{
|
|
62260
|
+
"kind": "field",
|
|
62261
|
+
"name": "hint",
|
|
62262
|
+
"type": {
|
|
62263
|
+
"text": "string"
|
|
62264
|
+
},
|
|
62265
|
+
"privacy": "private",
|
|
62266
|
+
"default": "''",
|
|
62267
|
+
"description": "The hint over the surface while one shows, put there by a gesture it let pass.",
|
|
62268
|
+
"inheritedFrom": {
|
|
62269
|
+
"name": "MixinViewport",
|
|
62270
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62271
|
+
}
|
|
62272
|
+
},
|
|
62273
|
+
{
|
|
62274
|
+
"kind": "field",
|
|
62275
|
+
"name": "hinting",
|
|
62276
|
+
"type": {
|
|
62277
|
+
"text": "ReturnType<typeof setTimeout> | undefined"
|
|
62278
|
+
},
|
|
62279
|
+
"privacy": "private",
|
|
62280
|
+
"description": "When the hint goes.",
|
|
62281
|
+
"inheritedFrom": {
|
|
62282
|
+
"name": "MixinViewport",
|
|
62283
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62284
|
+
}
|
|
62285
|
+
},
|
|
62286
|
+
{
|
|
62287
|
+
"kind": "field",
|
|
62288
|
+
"name": "hintAt",
|
|
62289
|
+
"type": {
|
|
62290
|
+
"text": "{ x: number; y: number } | undefined"
|
|
62291
|
+
},
|
|
62292
|
+
"privacy": "private",
|
|
62293
|
+
"description": "Where the gesture was, in the viewport's box, which the hint is shown\nat: where the reader is looking, and on the surface wherever a page laid\nits own content over the rest of it.",
|
|
62294
|
+
"inheritedFrom": {
|
|
62295
|
+
"name": "MixinViewport",
|
|
62296
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62297
|
+
}
|
|
62298
|
+
},
|
|
62299
|
+
{
|
|
62300
|
+
"kind": "field",
|
|
62301
|
+
"name": "takenBy",
|
|
62302
|
+
"type": {
|
|
62303
|
+
"text": "Event | undefined"
|
|
62304
|
+
},
|
|
62305
|
+
"privacy": "private",
|
|
62306
|
+
"description": "The press that took the gestures, which is not also the first gesture.",
|
|
62307
|
+
"inheritedFrom": {
|
|
62308
|
+
"name": "MixinViewport",
|
|
62309
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62310
|
+
}
|
|
62311
|
+
},
|
|
61771
62312
|
{
|
|
61772
62313
|
"kind": "field",
|
|
61773
62314
|
"name": "fullscreen",
|
|
@@ -61818,6 +62359,180 @@
|
|
|
61818
62359
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
61819
62360
|
}
|
|
61820
62361
|
},
|
|
62362
|
+
{
|
|
62363
|
+
"kind": "field",
|
|
62364
|
+
"name": "restingGestureLabels",
|
|
62365
|
+
"type": {
|
|
62366
|
+
"text": "ViewportGestureLabels"
|
|
62367
|
+
},
|
|
62368
|
+
"privacy": "protected",
|
|
62369
|
+
"description": "What the surface says about its gestures where the page does not say\nit, which a family overrides to name what it is: \"Press the map to use\nit\" reads better than a word that fits every surface.",
|
|
62370
|
+
"readonly": true,
|
|
62371
|
+
"inheritedFrom": {
|
|
62372
|
+
"name": "MixinViewport",
|
|
62373
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62374
|
+
}
|
|
62375
|
+
},
|
|
62376
|
+
{
|
|
62377
|
+
"kind": "method",
|
|
62378
|
+
"name": "gestureAllowed",
|
|
62379
|
+
"privacy": "protected",
|
|
62380
|
+
"return": {
|
|
62381
|
+
"type": {
|
|
62382
|
+
"text": "boolean"
|
|
62383
|
+
}
|
|
62384
|
+
},
|
|
62385
|
+
"parameters": [
|
|
62386
|
+
{
|
|
62387
|
+
"name": "event",
|
|
62388
|
+
"type": {
|
|
62389
|
+
"text": "Event"
|
|
62390
|
+
}
|
|
62391
|
+
}
|
|
62392
|
+
],
|
|
62393
|
+
"description": "Whether a gesture that started with this event is the surface's to\nanswer, for a family that answers gestures itself. Never while an\n`activate` surface waits, and never on the press that ended the wait:\nthat press hands over the gestures and moves nothing.",
|
|
62394
|
+
"inheritedFrom": {
|
|
62395
|
+
"name": "MixinViewport",
|
|
62396
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62397
|
+
}
|
|
62398
|
+
},
|
|
62399
|
+
{
|
|
62400
|
+
"kind": "method",
|
|
62401
|
+
"name": "gesturesChanged",
|
|
62402
|
+
"privacy": "protected",
|
|
62403
|
+
"return": {
|
|
62404
|
+
"type": {
|
|
62405
|
+
"text": "void"
|
|
62406
|
+
}
|
|
62407
|
+
},
|
|
62408
|
+
"description": "Says that `gestureMode` changed. Nothing here; a family whose renderer\nis told through a connector says it with its own event.",
|
|
62409
|
+
"inheritedFrom": {
|
|
62410
|
+
"name": "MixinViewport",
|
|
62411
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62412
|
+
}
|
|
62413
|
+
},
|
|
62414
|
+
{
|
|
62415
|
+
"kind": "method",
|
|
62416
|
+
"name": "showHint",
|
|
62417
|
+
"privacy": "private",
|
|
62418
|
+
"return": {
|
|
62419
|
+
"type": {
|
|
62420
|
+
"text": "void"
|
|
62421
|
+
}
|
|
62422
|
+
},
|
|
62423
|
+
"parameters": [
|
|
62424
|
+
{
|
|
62425
|
+
"name": "words",
|
|
62426
|
+
"type": {
|
|
62427
|
+
"text": "string"
|
|
62428
|
+
}
|
|
62429
|
+
},
|
|
62430
|
+
{
|
|
62431
|
+
"name": "at",
|
|
62432
|
+
"optional": true,
|
|
62433
|
+
"type": {
|
|
62434
|
+
"text": "{ clientX: number; clientY: number }"
|
|
62435
|
+
}
|
|
62436
|
+
}
|
|
62437
|
+
],
|
|
62438
|
+
"description": "Shows a hint over the surface for a moment, where the gesture was.",
|
|
62439
|
+
"inheritedFrom": {
|
|
62440
|
+
"name": "MixinViewport",
|
|
62441
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62442
|
+
}
|
|
62443
|
+
},
|
|
62444
|
+
{
|
|
62445
|
+
"kind": "field",
|
|
62446
|
+
"name": "handleGestureWheel",
|
|
62447
|
+
"privacy": "private",
|
|
62448
|
+
"readonly": true,
|
|
62449
|
+
"description": "A wheel the surface let pass to the page, which is said: a reader\nscrolling the page past a surface that did not zoom is told why, and how\nto zoom it. **Ctrl or ⌘ with the wheel is the surface's**, and is what a\ntrackpad's pinch arrives as.",
|
|
62450
|
+
"inheritedFrom": {
|
|
62451
|
+
"name": "MixinViewport",
|
|
62452
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62453
|
+
}
|
|
62454
|
+
},
|
|
62455
|
+
{
|
|
62456
|
+
"kind": "field",
|
|
62457
|
+
"name": "handleGestureTouch",
|
|
62458
|
+
"privacy": "private",
|
|
62459
|
+
"readonly": true,
|
|
62460
|
+
"description": "One finger moving over the surface, which scrolls the page, and is said.",
|
|
62461
|
+
"inheritedFrom": {
|
|
62462
|
+
"name": "MixinViewport",
|
|
62463
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62464
|
+
}
|
|
62465
|
+
},
|
|
62466
|
+
{
|
|
62467
|
+
"kind": "field",
|
|
62468
|
+
"name": "handleTake",
|
|
62469
|
+
"privacy": "private",
|
|
62470
|
+
"readonly": true,
|
|
62471
|
+
"description": "A press on the surface itself, which hands a waiting surface the gestures.",
|
|
62472
|
+
"inheritedFrom": {
|
|
62473
|
+
"name": "MixinViewport",
|
|
62474
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62475
|
+
}
|
|
62476
|
+
},
|
|
62477
|
+
{
|
|
62478
|
+
"kind": "field",
|
|
62479
|
+
"name": "handleGiveBackKey",
|
|
62480
|
+
"privacy": "private",
|
|
62481
|
+
"readonly": true,
|
|
62482
|
+
"description": "Escape, which gives the page its scroll back.",
|
|
62483
|
+
"inheritedFrom": {
|
|
62484
|
+
"name": "MixinViewport",
|
|
62485
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62486
|
+
}
|
|
62487
|
+
},
|
|
62488
|
+
{
|
|
62489
|
+
"kind": "field",
|
|
62490
|
+
"name": "handleGiveBackOutside",
|
|
62491
|
+
"privacy": "private",
|
|
62492
|
+
"readonly": true,
|
|
62493
|
+
"description": "A press anywhere else on the page, which gives it its scroll back.",
|
|
62494
|
+
"inheritedFrom": {
|
|
62495
|
+
"name": "MixinViewport",
|
|
62496
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62497
|
+
}
|
|
62498
|
+
},
|
|
62499
|
+
{
|
|
62500
|
+
"kind": "field",
|
|
62501
|
+
"name": "handleGiveBackBlur",
|
|
62502
|
+
"privacy": "private",
|
|
62503
|
+
"readonly": true,
|
|
62504
|
+
"description": "The window losing focus, as a reader switching away does.",
|
|
62505
|
+
"inheritedFrom": {
|
|
62506
|
+
"name": "MixinViewport",
|
|
62507
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62508
|
+
}
|
|
62509
|
+
},
|
|
62510
|
+
{
|
|
62511
|
+
"kind": "field",
|
|
62512
|
+
"name": "handlePointerLeave",
|
|
62513
|
+
"privacy": "protected",
|
|
62514
|
+
"readonly": true,
|
|
62515
|
+
"description": "The pointer leaving the frame, which the family binds on its region.\n**Heard on the frame and not the drawing**, which a pointer resting on\nsomething raised over it has left. **A mouse or a pen and never a\nfinger**, whose `pointerleave` is the finger lifting: a tap took the\nsurface and gave it back in one.",
|
|
62516
|
+
"inheritedFrom": {
|
|
62517
|
+
"name": "MixinViewport",
|
|
62518
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62519
|
+
}
|
|
62520
|
+
},
|
|
62521
|
+
{
|
|
62522
|
+
"kind": "method",
|
|
62523
|
+
"name": "renderGestures",
|
|
62524
|
+
"privacy": "protected",
|
|
62525
|
+
"return": {
|
|
62526
|
+
"type": {
|
|
62527
|
+
"text": "TemplateResult"
|
|
62528
|
+
}
|
|
62529
|
+
},
|
|
62530
|
+
"description": "The hint over the surface and the line while it is in use, which the\nfamily draws inside its viewport, over what was slotted. The parts are\nwritten out, as the controls' are, so the manifest sees them.",
|
|
62531
|
+
"inheritedFrom": {
|
|
62532
|
+
"name": "MixinViewport",
|
|
62533
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62534
|
+
}
|
|
62535
|
+
},
|
|
61821
62536
|
{
|
|
61822
62537
|
"kind": "method",
|
|
61823
62538
|
"name": "panEvent",
|
|
@@ -62541,7 +63256,7 @@
|
|
|
62541
63256
|
"default": "true"
|
|
62542
63257
|
}
|
|
62543
63258
|
],
|
|
62544
|
-
"description": "Says the graph has been drawn whole, or with `false`, that it no longer\nis.
|
|
63259
|
+
"description": "Says the graph has been drawn whole, or with `false`, that it no longer\nis. Called by `connectGraph` once its layout has settled; a page drawing\nits own graph calls it when that graph is finished. The first call after\nthe graph was not drawn sends `helix-graph-ready` and turns on\n`:state(ready)`.",
|
|
62545
63260
|
"type": {
|
|
62546
63261
|
"text": "drawn(whole = true) => void"
|
|
62547
63262
|
},
|
|
@@ -62550,6 +63265,31 @@
|
|
|
62550
63265
|
"module": "src/graph/root/graph-root.ts"
|
|
62551
63266
|
}
|
|
62552
63267
|
},
|
|
63268
|
+
{
|
|
63269
|
+
"kind": "method",
|
|
63270
|
+
"name": "laidOut",
|
|
63271
|
+
"return": {
|
|
63272
|
+
"type": {
|
|
63273
|
+
"text": "void"
|
|
63274
|
+
}
|
|
63275
|
+
},
|
|
63276
|
+
"parameters": [
|
|
63277
|
+
{
|
|
63278
|
+
"name": "positions",
|
|
63279
|
+
"type": {
|
|
63280
|
+
"text": "Record<string, { x: number; y: number }>"
|
|
63281
|
+
}
|
|
63282
|
+
}
|
|
63283
|
+
],
|
|
63284
|
+
"description": "Says where a layout put each note, by its `id`: sends\n`helix-graph-layout` for the page to keep. Called by `connectGraph` once\nits layout has settled; a page laying out its own graph calls it the same\nway.",
|
|
63285
|
+
"type": {
|
|
63286
|
+
"text": "laidOut(positions: Record<string, { x: number; y: number }>) => void"
|
|
63287
|
+
},
|
|
63288
|
+
"inheritedFrom": {
|
|
63289
|
+
"name": "HelixHeadlessGraph",
|
|
63290
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63291
|
+
}
|
|
63292
|
+
},
|
|
62553
63293
|
{
|
|
62554
63294
|
"kind": "method",
|
|
62555
63295
|
"name": "countText",
|
|
@@ -63043,6 +63783,10 @@
|
|
|
63043
63783
|
{
|
|
63044
63784
|
"description": "A graph of linked notes, with the selected note's links and backlinks listed first.",
|
|
63045
63785
|
"slug": "preview"
|
|
63786
|
+
},
|
|
63787
|
+
{
|
|
63788
|
+
"description": "A graph of company notes drawn by Sigma.js and laid out by ForceAtlas2, with the list beside it.",
|
|
63789
|
+
"slug": "live"
|
|
63046
63790
|
}
|
|
63047
63791
|
],
|
|
63048
63792
|
"source": "helix/styled/src/graph"
|
|
@@ -63050,6 +63794,18 @@
|
|
|
63050
63794
|
"tagName": "helix-graph",
|
|
63051
63795
|
"customElement": true,
|
|
63052
63796
|
"attributes": [
|
|
63797
|
+
{
|
|
63798
|
+
"name": "activate-hint-label",
|
|
63799
|
+
"type": {
|
|
63800
|
+
"text": "string | undefined"
|
|
63801
|
+
},
|
|
63802
|
+
"description": "The hint shown when a surface waiting to be pressed is scrolled or\nswiped over, with `gestures=\"activate\"`. Absent is the family's own.",
|
|
63803
|
+
"fieldName": "activateHintLabel",
|
|
63804
|
+
"inheritedFrom": {
|
|
63805
|
+
"name": "MixinViewport",
|
|
63806
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
63807
|
+
}
|
|
63808
|
+
},
|
|
63053
63809
|
{
|
|
63054
63810
|
"name": "controls",
|
|
63055
63811
|
"type": {
|
|
@@ -63099,6 +63855,18 @@
|
|
|
63099
63855
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
63100
63856
|
}
|
|
63101
63857
|
},
|
|
63858
|
+
{
|
|
63859
|
+
"name": "gestures",
|
|
63860
|
+
"type": {
|
|
63861
|
+
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
63862
|
+
},
|
|
63863
|
+
"description": "Which gestures the surface takes from the page.\n\n- `always`: the surface takes the wheel and one finger, for a surface\n that is the page, such as a full-screen view. A map rests here.\n- Unset is the family's own: `always` for a map, and for a board, a\n drag and a pinch, with the plain wheel left to the page until the\n board fills the screen.\n- `cooperative`: the wheel and one finger scroll the page, and the\n surface takes Ctrl or ⌘ with the wheel, and two fingers. The frame\n says so when a gesture passes to the page. Best for a surface embedded\n in a page.\n- `activate`: the surface takes nothing until it is pressed, and gives it\n back on Escape, when the pointer leaves it, or on a press elsewhere.\n\nThe keyboard and the frame's buttons work in every mode.\n\n**Unreflected and without a default**, because a default that reflected\nwould write an attribute onto every host that no server sent, and the\nhydration that followed would disagree with it.",
|
|
63864
|
+
"fieldName": "gestures",
|
|
63865
|
+
"inheritedFrom": {
|
|
63866
|
+
"name": "MixinViewport",
|
|
63867
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
63868
|
+
}
|
|
63869
|
+
},
|
|
63102
63870
|
{
|
|
63103
63871
|
"name": "idle-delay",
|
|
63104
63872
|
"type": {
|
|
@@ -63177,6 +63945,42 @@
|
|
|
63177
63945
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
63178
63946
|
}
|
|
63179
63947
|
},
|
|
63948
|
+
{
|
|
63949
|
+
"name": "two-finger-hint-label",
|
|
63950
|
+
"type": {
|
|
63951
|
+
"text": "string | undefined"
|
|
63952
|
+
},
|
|
63953
|
+
"description": "The hint shown when one finger swipes over a surface with\n`gestures=\"cooperative\"`. Absent is the family's own.",
|
|
63954
|
+
"fieldName": "twoFingerHintLabel",
|
|
63955
|
+
"inheritedFrom": {
|
|
63956
|
+
"name": "MixinViewport",
|
|
63957
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
63958
|
+
}
|
|
63959
|
+
},
|
|
63960
|
+
{
|
|
63961
|
+
"name": "using-label",
|
|
63962
|
+
"type": {
|
|
63963
|
+
"text": "string | undefined"
|
|
63964
|
+
},
|
|
63965
|
+
"description": "The line shown while a surface with `gestures=\"activate\"` has the\ngestures. Absent is the family's own.",
|
|
63966
|
+
"fieldName": "usingLabel",
|
|
63967
|
+
"inheritedFrom": {
|
|
63968
|
+
"name": "MixinViewport",
|
|
63969
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
63970
|
+
}
|
|
63971
|
+
},
|
|
63972
|
+
{
|
|
63973
|
+
"name": "wheel-hint-label",
|
|
63974
|
+
"type": {
|
|
63975
|
+
"text": "string | undefined"
|
|
63976
|
+
},
|
|
63977
|
+
"description": "The hint shown when the wheel scrolls past a surface with\n`gestures=\"cooperative\"`, with `{key}`, which is ⌘ on a Mac and Ctrl\nelsewhere. Absent is the family's own.",
|
|
63978
|
+
"fieldName": "wheelHintLabel",
|
|
63979
|
+
"inheritedFrom": {
|
|
63980
|
+
"name": "MixinViewport",
|
|
63981
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
63982
|
+
}
|
|
63983
|
+
},
|
|
63180
63984
|
{
|
|
63181
63985
|
"name": "zoom-in-label",
|
|
63182
63986
|
"type": {
|
|
@@ -63370,11 +64174,23 @@
|
|
|
63370
64174
|
"module": "src/graph/root/graph-root.ts"
|
|
63371
64175
|
}
|
|
63372
64176
|
},
|
|
64177
|
+
{
|
|
64178
|
+
"type": {
|
|
64179
|
+
"text": "HelixGraphLayoutEvent"
|
|
64180
|
+
},
|
|
64181
|
+
"description": "A layout settled, with where it put each note, sent by `laidOut()`. Keep the positions and pass them back as each note's `x` and `y`.",
|
|
64182
|
+
"name": "helix-graph-layout",
|
|
64183
|
+
"reactProp": "onhelix-graph-layout",
|
|
64184
|
+
"inheritedFrom": {
|
|
64185
|
+
"name": "HelixHeadlessGraph",
|
|
64186
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64187
|
+
}
|
|
64188
|
+
},
|
|
63373
64189
|
{
|
|
63374
64190
|
"type": {
|
|
63375
64191
|
"text": "HelixGraphPanEvent"
|
|
63376
64192
|
},
|
|
63377
|
-
"description": "A pan button or arrow key was pressed.
|
|
64193
|
+
"description": "A pan button or arrow key was pressed. `connectGraph` moves the drawing.",
|
|
63378
64194
|
"name": "helix-graph-pan",
|
|
63379
64195
|
"reactProp": "onhelix-graph-pan",
|
|
63380
64196
|
"inheritedFrom": {
|
|
@@ -63382,6 +64198,18 @@
|
|
|
63382
64198
|
"module": "src/graph/root/graph-root.ts"
|
|
63383
64199
|
}
|
|
63384
64200
|
},
|
|
64201
|
+
{
|
|
64202
|
+
"type": {
|
|
64203
|
+
"text": "HelixGraphPartChangeEvent"
|
|
64204
|
+
},
|
|
64205
|
+
"description": "The notes, the links, the selection, the depth or the gestures changed. Used by `connectGraph`; pages do not need to listen for it.",
|
|
64206
|
+
"name": "helix-graph-part-change",
|
|
64207
|
+
"reactProp": "onhelix-graph-part-change",
|
|
64208
|
+
"inheritedFrom": {
|
|
64209
|
+
"name": "HelixHeadlessGraph",
|
|
64210
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64211
|
+
}
|
|
64212
|
+
},
|
|
63385
64213
|
{
|
|
63386
64214
|
"type": {
|
|
63387
64215
|
"text": "HelixGraphReadyEvent"
|
|
@@ -63398,7 +64226,7 @@
|
|
|
63398
64226
|
"type": {
|
|
63399
64227
|
"text": "HelixGraphZoomEvent"
|
|
63400
64228
|
},
|
|
63401
|
-
"description": "A zoom button or key was pressed.
|
|
64229
|
+
"description": "A zoom button or key was pressed. `connectGraph` zooms the drawing.",
|
|
63402
64230
|
"name": "helix-graph-zoom",
|
|
63403
64231
|
"reactProp": "onhelix-graph-zoom",
|
|
63404
64232
|
"inheritedFrom": {
|
|
@@ -63514,6 +64342,22 @@
|
|
|
63514
64342
|
"module": "src/graph/root/graph-root.ts"
|
|
63515
64343
|
}
|
|
63516
64344
|
},
|
|
64345
|
+
{
|
|
64346
|
+
"description": "Words over the graph for a moment when it lets a gesture pass to the page, such as how to zoom it.",
|
|
64347
|
+
"name": "gesture-hint",
|
|
64348
|
+
"inheritedFrom": {
|
|
64349
|
+
"name": "HelixHeadlessGraph",
|
|
64350
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64351
|
+
}
|
|
64352
|
+
},
|
|
64353
|
+
{
|
|
64354
|
+
"description": "The line shown while a graph with `gestures=\"activate\"` has the gestures.",
|
|
64355
|
+
"name": "gesture-status",
|
|
64356
|
+
"inheritedFrom": {
|
|
64357
|
+
"name": "HelixHeadlessGraph",
|
|
64358
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64359
|
+
}
|
|
64360
|
+
},
|
|
63517
64361
|
{
|
|
63518
64362
|
"description": "The strip above the graph.",
|
|
63519
64363
|
"name": "header",
|
|
@@ -63708,6 +64552,22 @@
|
|
|
63708
64552
|
"module": "src/graph/root/graph-root.ts"
|
|
63709
64553
|
}
|
|
63710
64554
|
},
|
|
64555
|
+
{
|
|
64556
|
+
"description": "The page keeps the plain wheel and one finger, with `gestures=\"cooperative\"` or while a graph with `gestures=\"activate\"` waits to be pressed.",
|
|
64557
|
+
"name": "sharing",
|
|
64558
|
+
"inheritedFrom": {
|
|
64559
|
+
"name": "HelixHeadlessGraph",
|
|
64560
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64561
|
+
}
|
|
64562
|
+
},
|
|
64563
|
+
{
|
|
64564
|
+
"description": "A graph with `gestures=\"activate\"` has been pressed and has the gestures.",
|
|
64565
|
+
"name": "using",
|
|
64566
|
+
"inheritedFrom": {
|
|
64567
|
+
"name": "HelixHeadlessGraph",
|
|
64568
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64569
|
+
}
|
|
64570
|
+
},
|
|
63711
64571
|
{
|
|
63712
64572
|
"description": "Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.",
|
|
63713
64573
|
"name": "settled",
|
|
@@ -85511,6 +86371,19 @@
|
|
|
85511
86371
|
"attribute": "material",
|
|
85512
86372
|
"reflects": true
|
|
85513
86373
|
},
|
|
86374
|
+
{
|
|
86375
|
+
"kind": "field",
|
|
86376
|
+
"name": "activateHintLabel",
|
|
86377
|
+
"type": {
|
|
86378
|
+
"text": "string | undefined"
|
|
86379
|
+
},
|
|
86380
|
+
"description": "The hint shown when a surface waiting to be pressed is scrolled or\nswiped over, with `gestures=\"activate\"`. Absent is the family's own.",
|
|
86381
|
+
"attribute": "activate-hint-label",
|
|
86382
|
+
"inheritedFrom": {
|
|
86383
|
+
"name": "MixinViewport",
|
|
86384
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86385
|
+
}
|
|
86386
|
+
},
|
|
85514
86387
|
{
|
|
85515
86388
|
"kind": "field",
|
|
85516
86389
|
"name": "controls",
|
|
@@ -85566,6 +86439,19 @@
|
|
|
85566
86439
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
85567
86440
|
}
|
|
85568
86441
|
},
|
|
86442
|
+
{
|
|
86443
|
+
"kind": "field",
|
|
86444
|
+
"name": "gestures",
|
|
86445
|
+
"type": {
|
|
86446
|
+
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
86447
|
+
},
|
|
86448
|
+
"description": "Which gestures the surface takes from the page.\n\n- `always`: the surface takes the wheel and one finger, for a surface\n that is the page, such as a full-screen view. A map rests here.\n- Unset is the family's own: `always` for a map, and for a board, a\n drag and a pinch, with the plain wheel left to the page until the\n board fills the screen.\n- `cooperative`: the wheel and one finger scroll the page, and the\n surface takes Ctrl or ⌘ with the wheel, and two fingers. The frame\n says so when a gesture passes to the page. Best for a surface embedded\n in a page.\n- `activate`: the surface takes nothing until it is pressed, and gives it\n back on Escape, when the pointer leaves it, or on a press elsewhere.\n\nThe keyboard and the frame's buttons work in every mode.\n\n**Unreflected and without a default**, because a default that reflected\nwould write an attribute onto every host that no server sent, and the\nhydration that followed would disagree with it.",
|
|
86449
|
+
"attribute": "gestures",
|
|
86450
|
+
"inheritedFrom": {
|
|
86451
|
+
"name": "MixinViewport",
|
|
86452
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86453
|
+
}
|
|
86454
|
+
},
|
|
85569
86455
|
{
|
|
85570
86456
|
"kind": "field",
|
|
85571
86457
|
"name": "idleDelay",
|
|
@@ -85650,6 +86536,45 @@
|
|
|
85650
86536
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
85651
86537
|
}
|
|
85652
86538
|
},
|
|
86539
|
+
{
|
|
86540
|
+
"kind": "field",
|
|
86541
|
+
"name": "twoFingerHintLabel",
|
|
86542
|
+
"type": {
|
|
86543
|
+
"text": "string | undefined"
|
|
86544
|
+
},
|
|
86545
|
+
"description": "The hint shown when one finger swipes over a surface with\n`gestures=\"cooperative\"`. Absent is the family's own.",
|
|
86546
|
+
"attribute": "two-finger-hint-label",
|
|
86547
|
+
"inheritedFrom": {
|
|
86548
|
+
"name": "MixinViewport",
|
|
86549
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86550
|
+
}
|
|
86551
|
+
},
|
|
86552
|
+
{
|
|
86553
|
+
"kind": "field",
|
|
86554
|
+
"name": "usingLabel",
|
|
86555
|
+
"type": {
|
|
86556
|
+
"text": "string | undefined"
|
|
86557
|
+
},
|
|
86558
|
+
"description": "The line shown while a surface with `gestures=\"activate\"` has the\ngestures. Absent is the family's own.",
|
|
86559
|
+
"attribute": "using-label",
|
|
86560
|
+
"inheritedFrom": {
|
|
86561
|
+
"name": "MixinViewport",
|
|
86562
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86563
|
+
}
|
|
86564
|
+
},
|
|
86565
|
+
{
|
|
86566
|
+
"kind": "field",
|
|
86567
|
+
"name": "wheelHintLabel",
|
|
86568
|
+
"type": {
|
|
86569
|
+
"text": "string | undefined"
|
|
86570
|
+
},
|
|
86571
|
+
"description": "The hint shown when the wheel scrolls past a surface with\n`gestures=\"cooperative\"`, with `{key}`, which is ⌘ on a Mac and Ctrl\nelsewhere. Absent is the family's own.",
|
|
86572
|
+
"attribute": "wheel-hint-label",
|
|
86573
|
+
"inheritedFrom": {
|
|
86574
|
+
"name": "MixinViewport",
|
|
86575
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86576
|
+
}
|
|
86577
|
+
},
|
|
85653
86578
|
{
|
|
85654
86579
|
"kind": "field",
|
|
85655
86580
|
"name": "zoomInLabel",
|
|
@@ -85692,6 +86617,73 @@
|
|
|
85692
86617
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
85693
86618
|
}
|
|
85694
86619
|
},
|
|
86620
|
+
{
|
|
86621
|
+
"kind": "field",
|
|
86622
|
+
"name": "gesturesTaken",
|
|
86623
|
+
"type": {
|
|
86624
|
+
"text": "boolean"
|
|
86625
|
+
},
|
|
86626
|
+
"privacy": "protected",
|
|
86627
|
+
"default": "false",
|
|
86628
|
+
"description": "Whether an `activate` surface has been pressed, and has the gestures.",
|
|
86629
|
+
"inheritedFrom": {
|
|
86630
|
+
"name": "MixinViewport",
|
|
86631
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86632
|
+
}
|
|
86633
|
+
},
|
|
86634
|
+
{
|
|
86635
|
+
"kind": "field",
|
|
86636
|
+
"name": "hint",
|
|
86637
|
+
"type": {
|
|
86638
|
+
"text": "string"
|
|
86639
|
+
},
|
|
86640
|
+
"privacy": "private",
|
|
86641
|
+
"default": "''",
|
|
86642
|
+
"description": "The hint over the surface while one shows, put there by a gesture it let pass.",
|
|
86643
|
+
"inheritedFrom": {
|
|
86644
|
+
"name": "MixinViewport",
|
|
86645
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86646
|
+
}
|
|
86647
|
+
},
|
|
86648
|
+
{
|
|
86649
|
+
"kind": "field",
|
|
86650
|
+
"name": "hinting",
|
|
86651
|
+
"type": {
|
|
86652
|
+
"text": "ReturnType<typeof setTimeout> | undefined"
|
|
86653
|
+
},
|
|
86654
|
+
"privacy": "private",
|
|
86655
|
+
"description": "When the hint goes.",
|
|
86656
|
+
"inheritedFrom": {
|
|
86657
|
+
"name": "MixinViewport",
|
|
86658
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86659
|
+
}
|
|
86660
|
+
},
|
|
86661
|
+
{
|
|
86662
|
+
"kind": "field",
|
|
86663
|
+
"name": "hintAt",
|
|
86664
|
+
"type": {
|
|
86665
|
+
"text": "{ x: number; y: number } | undefined"
|
|
86666
|
+
},
|
|
86667
|
+
"privacy": "private",
|
|
86668
|
+
"description": "Where the gesture was, in the viewport's box, which the hint is shown\nat: where the reader is looking, and on the surface wherever a page laid\nits own content over the rest of it.",
|
|
86669
|
+
"inheritedFrom": {
|
|
86670
|
+
"name": "MixinViewport",
|
|
86671
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86672
|
+
}
|
|
86673
|
+
},
|
|
86674
|
+
{
|
|
86675
|
+
"kind": "field",
|
|
86676
|
+
"name": "takenBy",
|
|
86677
|
+
"type": {
|
|
86678
|
+
"text": "Event | undefined"
|
|
86679
|
+
},
|
|
86680
|
+
"privacy": "private",
|
|
86681
|
+
"description": "The press that took the gestures, which is not also the first gesture.",
|
|
86682
|
+
"inheritedFrom": {
|
|
86683
|
+
"name": "MixinViewport",
|
|
86684
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86685
|
+
}
|
|
86686
|
+
},
|
|
85695
86687
|
{
|
|
85696
86688
|
"kind": "field",
|
|
85697
86689
|
"name": "fullscreen",
|
|
@@ -85742,6 +86734,180 @@
|
|
|
85742
86734
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
85743
86735
|
}
|
|
85744
86736
|
},
|
|
86737
|
+
{
|
|
86738
|
+
"kind": "field",
|
|
86739
|
+
"name": "restingGestureLabels",
|
|
86740
|
+
"type": {
|
|
86741
|
+
"text": "ViewportGestureLabels"
|
|
86742
|
+
},
|
|
86743
|
+
"privacy": "protected",
|
|
86744
|
+
"description": "What the surface says about its gestures where the page does not say\nit, which a family overrides to name what it is: \"Press the map to use\nit\" reads better than a word that fits every surface.",
|
|
86745
|
+
"readonly": true,
|
|
86746
|
+
"inheritedFrom": {
|
|
86747
|
+
"name": "MixinViewport",
|
|
86748
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86749
|
+
}
|
|
86750
|
+
},
|
|
86751
|
+
{
|
|
86752
|
+
"kind": "method",
|
|
86753
|
+
"name": "gestureAllowed",
|
|
86754
|
+
"privacy": "protected",
|
|
86755
|
+
"return": {
|
|
86756
|
+
"type": {
|
|
86757
|
+
"text": "boolean"
|
|
86758
|
+
}
|
|
86759
|
+
},
|
|
86760
|
+
"parameters": [
|
|
86761
|
+
{
|
|
86762
|
+
"name": "event",
|
|
86763
|
+
"type": {
|
|
86764
|
+
"text": "Event"
|
|
86765
|
+
}
|
|
86766
|
+
}
|
|
86767
|
+
],
|
|
86768
|
+
"description": "Whether a gesture that started with this event is the surface's to\nanswer, for a family that answers gestures itself. Never while an\n`activate` surface waits, and never on the press that ended the wait:\nthat press hands over the gestures and moves nothing.",
|
|
86769
|
+
"inheritedFrom": {
|
|
86770
|
+
"name": "MixinViewport",
|
|
86771
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86772
|
+
}
|
|
86773
|
+
},
|
|
86774
|
+
{
|
|
86775
|
+
"kind": "method",
|
|
86776
|
+
"name": "gesturesChanged",
|
|
86777
|
+
"privacy": "protected",
|
|
86778
|
+
"return": {
|
|
86779
|
+
"type": {
|
|
86780
|
+
"text": "void"
|
|
86781
|
+
}
|
|
86782
|
+
},
|
|
86783
|
+
"description": "Says that `gestureMode` changed. Nothing here; a family whose renderer\nis told through a connector says it with its own event.",
|
|
86784
|
+
"inheritedFrom": {
|
|
86785
|
+
"name": "MixinViewport",
|
|
86786
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86787
|
+
}
|
|
86788
|
+
},
|
|
86789
|
+
{
|
|
86790
|
+
"kind": "method",
|
|
86791
|
+
"name": "showHint",
|
|
86792
|
+
"privacy": "private",
|
|
86793
|
+
"return": {
|
|
86794
|
+
"type": {
|
|
86795
|
+
"text": "void"
|
|
86796
|
+
}
|
|
86797
|
+
},
|
|
86798
|
+
"parameters": [
|
|
86799
|
+
{
|
|
86800
|
+
"name": "words",
|
|
86801
|
+
"type": {
|
|
86802
|
+
"text": "string"
|
|
86803
|
+
}
|
|
86804
|
+
},
|
|
86805
|
+
{
|
|
86806
|
+
"name": "at",
|
|
86807
|
+
"optional": true,
|
|
86808
|
+
"type": {
|
|
86809
|
+
"text": "{ clientX: number; clientY: number }"
|
|
86810
|
+
}
|
|
86811
|
+
}
|
|
86812
|
+
],
|
|
86813
|
+
"description": "Shows a hint over the surface for a moment, where the gesture was.",
|
|
86814
|
+
"inheritedFrom": {
|
|
86815
|
+
"name": "MixinViewport",
|
|
86816
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86817
|
+
}
|
|
86818
|
+
},
|
|
86819
|
+
{
|
|
86820
|
+
"kind": "field",
|
|
86821
|
+
"name": "handleGestureWheel",
|
|
86822
|
+
"privacy": "private",
|
|
86823
|
+
"readonly": true,
|
|
86824
|
+
"description": "A wheel the surface let pass to the page, which is said: a reader\nscrolling the page past a surface that did not zoom is told why, and how\nto zoom it. **Ctrl or ⌘ with the wheel is the surface's**, and is what a\ntrackpad's pinch arrives as.",
|
|
86825
|
+
"inheritedFrom": {
|
|
86826
|
+
"name": "MixinViewport",
|
|
86827
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86828
|
+
}
|
|
86829
|
+
},
|
|
86830
|
+
{
|
|
86831
|
+
"kind": "field",
|
|
86832
|
+
"name": "handleGestureTouch",
|
|
86833
|
+
"privacy": "private",
|
|
86834
|
+
"readonly": true,
|
|
86835
|
+
"description": "One finger moving over the surface, which scrolls the page, and is said.",
|
|
86836
|
+
"inheritedFrom": {
|
|
86837
|
+
"name": "MixinViewport",
|
|
86838
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86839
|
+
}
|
|
86840
|
+
},
|
|
86841
|
+
{
|
|
86842
|
+
"kind": "field",
|
|
86843
|
+
"name": "handleTake",
|
|
86844
|
+
"privacy": "private",
|
|
86845
|
+
"readonly": true,
|
|
86846
|
+
"description": "A press on the surface itself, which hands a waiting surface the gestures.",
|
|
86847
|
+
"inheritedFrom": {
|
|
86848
|
+
"name": "MixinViewport",
|
|
86849
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86850
|
+
}
|
|
86851
|
+
},
|
|
86852
|
+
{
|
|
86853
|
+
"kind": "field",
|
|
86854
|
+
"name": "handleGiveBackKey",
|
|
86855
|
+
"privacy": "private",
|
|
86856
|
+
"readonly": true,
|
|
86857
|
+
"description": "Escape, which gives the page its scroll back.",
|
|
86858
|
+
"inheritedFrom": {
|
|
86859
|
+
"name": "MixinViewport",
|
|
86860
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86861
|
+
}
|
|
86862
|
+
},
|
|
86863
|
+
{
|
|
86864
|
+
"kind": "field",
|
|
86865
|
+
"name": "handleGiveBackOutside",
|
|
86866
|
+
"privacy": "private",
|
|
86867
|
+
"readonly": true,
|
|
86868
|
+
"description": "A press anywhere else on the page, which gives it its scroll back.",
|
|
86869
|
+
"inheritedFrom": {
|
|
86870
|
+
"name": "MixinViewport",
|
|
86871
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86872
|
+
}
|
|
86873
|
+
},
|
|
86874
|
+
{
|
|
86875
|
+
"kind": "field",
|
|
86876
|
+
"name": "handleGiveBackBlur",
|
|
86877
|
+
"privacy": "private",
|
|
86878
|
+
"readonly": true,
|
|
86879
|
+
"description": "The window losing focus, as a reader switching away does.",
|
|
86880
|
+
"inheritedFrom": {
|
|
86881
|
+
"name": "MixinViewport",
|
|
86882
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86883
|
+
}
|
|
86884
|
+
},
|
|
86885
|
+
{
|
|
86886
|
+
"kind": "field",
|
|
86887
|
+
"name": "handlePointerLeave",
|
|
86888
|
+
"privacy": "protected",
|
|
86889
|
+
"readonly": true,
|
|
86890
|
+
"description": "The pointer leaving the frame, which the family binds on its region.\n**Heard on the frame and not the drawing**, which a pointer resting on\nsomething raised over it has left. **A mouse or a pen and never a\nfinger**, whose `pointerleave` is the finger lifting: a tap took the\nsurface and gave it back in one.",
|
|
86891
|
+
"inheritedFrom": {
|
|
86892
|
+
"name": "MixinViewport",
|
|
86893
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86894
|
+
}
|
|
86895
|
+
},
|
|
86896
|
+
{
|
|
86897
|
+
"kind": "method",
|
|
86898
|
+
"name": "renderGestures",
|
|
86899
|
+
"privacy": "protected",
|
|
86900
|
+
"return": {
|
|
86901
|
+
"type": {
|
|
86902
|
+
"text": "TemplateResult"
|
|
86903
|
+
}
|
|
86904
|
+
},
|
|
86905
|
+
"description": "The hint over the surface and the line while it is in use, which the\nfamily draws inside its viewport, over what was slotted. The parts are\nwritten out, as the controls' are, so the manifest sees them.",
|
|
86906
|
+
"inheritedFrom": {
|
|
86907
|
+
"name": "MixinViewport",
|
|
86908
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86909
|
+
}
|
|
86910
|
+
},
|
|
85745
86911
|
{
|
|
85746
86912
|
"kind": "method",
|
|
85747
86913
|
"name": "panEvent",
|
|
@@ -86053,20 +87219,6 @@
|
|
|
86053
87219
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86054
87220
|
}
|
|
86055
87221
|
},
|
|
86056
|
-
{
|
|
86057
|
-
"kind": "field",
|
|
86058
|
-
"name": "activateHintLabel",
|
|
86059
|
-
"type": {
|
|
86060
|
-
"text": "string"
|
|
86061
|
-
},
|
|
86062
|
-
"default": "'Press the map to use it'",
|
|
86063
|
-
"description": "The hint shown when a map waiting to be pressed is scrolled or swiped\nover, with `gestures=\"activate\"`.",
|
|
86064
|
-
"attribute": "activate-hint-label",
|
|
86065
|
-
"inheritedFrom": {
|
|
86066
|
-
"name": "HelixHeadlessMap",
|
|
86067
|
-
"module": "src/map/root/map-root.ts"
|
|
86068
|
-
}
|
|
86069
|
-
},
|
|
86070
87222
|
{
|
|
86071
87223
|
"kind": "field",
|
|
86072
87224
|
"name": "bearing",
|
|
@@ -86123,19 +87275,6 @@
|
|
|
86123
87275
|
"module": "src/map/root/map-root.ts"
|
|
86124
87276
|
}
|
|
86125
87277
|
},
|
|
86126
|
-
{
|
|
86127
|
-
"kind": "field",
|
|
86128
|
-
"name": "gestures",
|
|
86129
|
-
"type": {
|
|
86130
|
-
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
86131
|
-
},
|
|
86132
|
-
"description": "Which gestures the map takes from the page.\n\n- `always`, which unset is: the wheel zooms the map and one finger pans\n it, for a map that is the page, such as a full-screen view.\n- `cooperative`: the wheel and one finger scroll the page, and the map\n takes Ctrl or ⌘ with the wheel, and two fingers. The frame says so\n when a gesture passes to the page. Best for a map embedded in a page.\n- `activate`: the map takes nothing until it is pressed, and gives it\n back on Escape, when the pointer leaves it, or on a press elsewhere.\n\nThe keyboard and the frame's buttons work in every mode. The renderer is\ntold through the connector, so MapLibre and Leaflet behave alike.",
|
|
86133
|
-
"attribute": "gestures",
|
|
86134
|
-
"inheritedFrom": {
|
|
86135
|
-
"name": "HelixHeadlessMap",
|
|
86136
|
-
"module": "src/map/root/map-root.ts"
|
|
86137
|
-
}
|
|
86138
|
-
},
|
|
86139
87278
|
{
|
|
86140
87279
|
"kind": "field",
|
|
86141
87280
|
"name": "hybridLabel",
|
|
@@ -86388,48 +87527,6 @@
|
|
|
86388
87527
|
"module": "src/map/root/map-root.ts"
|
|
86389
87528
|
}
|
|
86390
87529
|
},
|
|
86391
|
-
{
|
|
86392
|
-
"kind": "field",
|
|
86393
|
-
"name": "twoFingerHintLabel",
|
|
86394
|
-
"type": {
|
|
86395
|
-
"text": "string"
|
|
86396
|
-
},
|
|
86397
|
-
"default": "'Use two fingers to move the map'",
|
|
86398
|
-
"description": "The hint shown when one finger swipes over a map with `gestures=\"cooperative\"`.",
|
|
86399
|
-
"attribute": "two-finger-hint-label",
|
|
86400
|
-
"inheritedFrom": {
|
|
86401
|
-
"name": "HelixHeadlessMap",
|
|
86402
|
-
"module": "src/map/root/map-root.ts"
|
|
86403
|
-
}
|
|
86404
|
-
},
|
|
86405
|
-
{
|
|
86406
|
-
"kind": "field",
|
|
86407
|
-
"name": "usingLabel",
|
|
86408
|
-
"type": {
|
|
86409
|
-
"text": "string"
|
|
86410
|
-
},
|
|
86411
|
-
"default": "'Using the map. Press Escape to scroll the page again.'",
|
|
86412
|
-
"description": "The line shown while a map with `gestures=\"activate\"` has the gestures.",
|
|
86413
|
-
"attribute": "using-label",
|
|
86414
|
-
"inheritedFrom": {
|
|
86415
|
-
"name": "HelixHeadlessMap",
|
|
86416
|
-
"module": "src/map/root/map-root.ts"
|
|
86417
|
-
}
|
|
86418
|
-
},
|
|
86419
|
-
{
|
|
86420
|
-
"kind": "field",
|
|
86421
|
-
"name": "wheelHintLabel",
|
|
86422
|
-
"type": {
|
|
86423
|
-
"text": "string"
|
|
86424
|
-
},
|
|
86425
|
-
"default": "'Use {key} and scroll to zoom the map'",
|
|
86426
|
-
"description": "The hint shown when the wheel scrolls past a map with\n`gestures=\"cooperative\"`, with `{key}`, which is ⌘ on a Mac and Ctrl\nelsewhere, as the renderer reads it.",
|
|
86427
|
-
"attribute": "wheel-hint-label",
|
|
86428
|
-
"inheritedFrom": {
|
|
86429
|
-
"name": "HelixHeadlessMap",
|
|
86430
|
-
"module": "src/map/root/map-root.ts"
|
|
86431
|
-
}
|
|
86432
|
-
},
|
|
86433
87530
|
{
|
|
86434
87531
|
"kind": "field",
|
|
86435
87532
|
"name": "zoomedLabel",
|
|
@@ -86913,167 +88010,6 @@
|
|
|
86913
88010
|
"module": "src/map/root/map-root.ts"
|
|
86914
88011
|
}
|
|
86915
88012
|
},
|
|
86916
|
-
{
|
|
86917
|
-
"kind": "field",
|
|
86918
|
-
"name": "hint",
|
|
86919
|
-
"type": {
|
|
86920
|
-
"text": "string"
|
|
86921
|
-
},
|
|
86922
|
-
"privacy": "private",
|
|
86923
|
-
"default": "''",
|
|
86924
|
-
"description": "The hint on the map while one shows, put there by a gesture the map let pass.",
|
|
86925
|
-
"inheritedFrom": {
|
|
86926
|
-
"name": "HelixHeadlessMap",
|
|
86927
|
-
"module": "src/map/root/map-root.ts"
|
|
86928
|
-
}
|
|
86929
|
-
},
|
|
86930
|
-
{
|
|
86931
|
-
"kind": "field",
|
|
86932
|
-
"name": "hinting",
|
|
86933
|
-
"type": {
|
|
86934
|
-
"text": "ReturnType<typeof setTimeout> | undefined"
|
|
86935
|
-
},
|
|
86936
|
-
"privacy": "private",
|
|
86937
|
-
"description": "When the hint goes.",
|
|
86938
|
-
"inheritedFrom": {
|
|
86939
|
-
"name": "HelixHeadlessMap",
|
|
86940
|
-
"module": "src/map/root/map-root.ts"
|
|
86941
|
-
}
|
|
86942
|
-
},
|
|
86943
|
-
{
|
|
86944
|
-
"kind": "field",
|
|
86945
|
-
"name": "hintAt",
|
|
86946
|
-
"type": {
|
|
86947
|
-
"text": "{ x: number; y: number } | undefined"
|
|
86948
|
-
},
|
|
86949
|
-
"privacy": "private",
|
|
86950
|
-
"description": "Where the gesture was, in the map's box, which the hint is shown at:\nwhere the reader is looking, and on the map wherever a page laid its own\ncontent over the rest of it.",
|
|
86951
|
-
"inheritedFrom": {
|
|
86952
|
-
"name": "HelixHeadlessMap",
|
|
86953
|
-
"module": "src/map/root/map-root.ts"
|
|
86954
|
-
}
|
|
86955
|
-
},
|
|
86956
|
-
{
|
|
86957
|
-
"kind": "field",
|
|
86958
|
-
"name": "taken",
|
|
86959
|
-
"type": {
|
|
86960
|
-
"text": "boolean"
|
|
86961
|
-
},
|
|
86962
|
-
"privacy": "private",
|
|
86963
|
-
"default": "false",
|
|
86964
|
-
"description": "Whether a map with `gestures=\"activate\"` has been pressed, and has the gestures.",
|
|
86965
|
-
"inheritedFrom": {
|
|
86966
|
-
"name": "HelixHeadlessMap",
|
|
86967
|
-
"module": "src/map/root/map-root.ts"
|
|
86968
|
-
}
|
|
86969
|
-
},
|
|
86970
|
-
{
|
|
86971
|
-
"kind": "method",
|
|
86972
|
-
"name": "showHint",
|
|
86973
|
-
"privacy": "private",
|
|
86974
|
-
"return": {
|
|
86975
|
-
"type": {
|
|
86976
|
-
"text": "void"
|
|
86977
|
-
}
|
|
86978
|
-
},
|
|
86979
|
-
"parameters": [
|
|
86980
|
-
{
|
|
86981
|
-
"name": "words",
|
|
86982
|
-
"type": {
|
|
86983
|
-
"text": "string"
|
|
86984
|
-
}
|
|
86985
|
-
},
|
|
86986
|
-
{
|
|
86987
|
-
"name": "at",
|
|
86988
|
-
"optional": true,
|
|
86989
|
-
"type": {
|
|
86990
|
-
"text": "{ clientX: number; clientY: number }"
|
|
86991
|
-
}
|
|
86992
|
-
}
|
|
86993
|
-
],
|
|
86994
|
-
"description": "Shows a hint over the map for a moment, where the gesture was.",
|
|
86995
|
-
"inheritedFrom": {
|
|
86996
|
-
"name": "HelixHeadlessMap",
|
|
86997
|
-
"module": "src/map/root/map-root.ts"
|
|
86998
|
-
}
|
|
86999
|
-
},
|
|
87000
|
-
{
|
|
87001
|
-
"kind": "field",
|
|
87002
|
-
"name": "handleWheel",
|
|
87003
|
-
"privacy": "private",
|
|
87004
|
-
"readonly": true,
|
|
87005
|
-
"description": "A wheel the map let pass to the page, which is said: a reader scrolling\nthe page past a map that did not zoom is told why, and how to zoom it.\n**Ctrl or ⌘ with the wheel is the map's**, and is what a trackpad's pinch\narrives as.",
|
|
87006
|
-
"inheritedFrom": {
|
|
87007
|
-
"name": "HelixHeadlessMap",
|
|
87008
|
-
"module": "src/map/root/map-root.ts"
|
|
87009
|
-
}
|
|
87010
|
-
},
|
|
87011
|
-
{
|
|
87012
|
-
"kind": "field",
|
|
87013
|
-
"name": "handleTouchMove",
|
|
87014
|
-
"privacy": "private",
|
|
87015
|
-
"readonly": true,
|
|
87016
|
-
"description": "One finger moving over the map, which scrolls the page, and is said.",
|
|
87017
|
-
"inheritedFrom": {
|
|
87018
|
-
"name": "HelixHeadlessMap",
|
|
87019
|
-
"module": "src/map/root/map-root.ts"
|
|
87020
|
-
}
|
|
87021
|
-
},
|
|
87022
|
-
{
|
|
87023
|
-
"kind": "field",
|
|
87024
|
-
"name": "handleTake",
|
|
87025
|
-
"privacy": "private",
|
|
87026
|
-
"readonly": true,
|
|
87027
|
-
"description": "A press on the map itself, which hands a waiting map the gestures.",
|
|
87028
|
-
"inheritedFrom": {
|
|
87029
|
-
"name": "HelixHeadlessMap",
|
|
87030
|
-
"module": "src/map/root/map-root.ts"
|
|
87031
|
-
}
|
|
87032
|
-
},
|
|
87033
|
-
{
|
|
87034
|
-
"kind": "field",
|
|
87035
|
-
"name": "handleGiveBackKey",
|
|
87036
|
-
"privacy": "private",
|
|
87037
|
-
"readonly": true,
|
|
87038
|
-
"description": "Escape, which gives the page its scroll back.",
|
|
87039
|
-
"inheritedFrom": {
|
|
87040
|
-
"name": "HelixHeadlessMap",
|
|
87041
|
-
"module": "src/map/root/map-root.ts"
|
|
87042
|
-
}
|
|
87043
|
-
},
|
|
87044
|
-
{
|
|
87045
|
-
"kind": "field",
|
|
87046
|
-
"name": "handleGiveBackOutside",
|
|
87047
|
-
"privacy": "private",
|
|
87048
|
-
"readonly": true,
|
|
87049
|
-
"description": "A press anywhere else on the page, which gives it its scroll back.",
|
|
87050
|
-
"inheritedFrom": {
|
|
87051
|
-
"name": "HelixHeadlessMap",
|
|
87052
|
-
"module": "src/map/root/map-root.ts"
|
|
87053
|
-
}
|
|
87054
|
-
},
|
|
87055
|
-
{
|
|
87056
|
-
"kind": "field",
|
|
87057
|
-
"name": "handleGiveBackBlur",
|
|
87058
|
-
"privacy": "private",
|
|
87059
|
-
"readonly": true,
|
|
87060
|
-
"description": "The window losing focus, as a reader switching away does.",
|
|
87061
|
-
"inheritedFrom": {
|
|
87062
|
-
"name": "HelixHeadlessMap",
|
|
87063
|
-
"module": "src/map/root/map-root.ts"
|
|
87064
|
-
}
|
|
87065
|
-
},
|
|
87066
|
-
{
|
|
87067
|
-
"kind": "field",
|
|
87068
|
-
"name": "handleLeave",
|
|
87069
|
-
"privacy": "private",
|
|
87070
|
-
"readonly": true,
|
|
87071
|
-
"description": "The pointer leaving the frame. **Heard on the frame and not the map's\ncanvas**, which a pointer resting on a marker has left, since markers\nstand outside it. **A mouse or a pen and never a finger**, whose\n`pointerleave` is the finger lifting: a tap took the map and gave it back\nin one.",
|
|
87072
|
-
"inheritedFrom": {
|
|
87073
|
-
"name": "HelixHeadlessMap",
|
|
87074
|
-
"module": "src/map/root/map-root.ts"
|
|
87075
|
-
}
|
|
87076
|
-
},
|
|
87077
88013
|
{
|
|
87078
88014
|
"kind": "field",
|
|
87079
88015
|
"name": "handleSlotChange",
|
|
@@ -87630,6 +88566,18 @@
|
|
|
87630
88566
|
"description": "The background of the pan and zoom buttons. Leave unset for solid. `glass`\nshows the map through a blur, `frosted` blurs more, and `transparent` has\nno background. Your theme sets how see-through each one is.",
|
|
87631
88567
|
"fieldName": "material"
|
|
87632
88568
|
},
|
|
88569
|
+
{
|
|
88570
|
+
"name": "activate-hint-label",
|
|
88571
|
+
"type": {
|
|
88572
|
+
"text": "string | undefined"
|
|
88573
|
+
},
|
|
88574
|
+
"description": "The hint shown when a surface waiting to be pressed is scrolled or\nswiped over, with `gestures=\"activate\"`. Absent is the family's own.",
|
|
88575
|
+
"fieldName": "activateHintLabel",
|
|
88576
|
+
"inheritedFrom": {
|
|
88577
|
+
"name": "MixinViewport",
|
|
88578
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
88579
|
+
}
|
|
88580
|
+
},
|
|
87633
88581
|
{
|
|
87634
88582
|
"name": "controls",
|
|
87635
88583
|
"type": {
|
|
@@ -87679,6 +88627,18 @@
|
|
|
87679
88627
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
87680
88628
|
}
|
|
87681
88629
|
},
|
|
88630
|
+
{
|
|
88631
|
+
"name": "gestures",
|
|
88632
|
+
"type": {
|
|
88633
|
+
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
88634
|
+
},
|
|
88635
|
+
"description": "Which gestures the surface takes from the page.\n\n- `always`: the surface takes the wheel and one finger, for a surface\n that is the page, such as a full-screen view. A map rests here.\n- Unset is the family's own: `always` for a map, and for a board, a\n drag and a pinch, with the plain wheel left to the page until the\n board fills the screen.\n- `cooperative`: the wheel and one finger scroll the page, and the\n surface takes Ctrl or ⌘ with the wheel, and two fingers. The frame\n says so when a gesture passes to the page. Best for a surface embedded\n in a page.\n- `activate`: the surface takes nothing until it is pressed, and gives it\n back on Escape, when the pointer leaves it, or on a press elsewhere.\n\nThe keyboard and the frame's buttons work in every mode.\n\n**Unreflected and without a default**, because a default that reflected\nwould write an attribute onto every host that no server sent, and the\nhydration that followed would disagree with it.",
|
|
88636
|
+
"fieldName": "gestures",
|
|
88637
|
+
"inheritedFrom": {
|
|
88638
|
+
"name": "MixinViewport",
|
|
88639
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
88640
|
+
}
|
|
88641
|
+
},
|
|
87682
88642
|
{
|
|
87683
88643
|
"name": "idle-delay",
|
|
87684
88644
|
"type": {
|
|
@@ -87757,6 +88717,42 @@
|
|
|
87757
88717
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
87758
88718
|
}
|
|
87759
88719
|
},
|
|
88720
|
+
{
|
|
88721
|
+
"name": "two-finger-hint-label",
|
|
88722
|
+
"type": {
|
|
88723
|
+
"text": "string | undefined"
|
|
88724
|
+
},
|
|
88725
|
+
"description": "The hint shown when one finger swipes over a surface with\n`gestures=\"cooperative\"`. Absent is the family's own.",
|
|
88726
|
+
"fieldName": "twoFingerHintLabel",
|
|
88727
|
+
"inheritedFrom": {
|
|
88728
|
+
"name": "MixinViewport",
|
|
88729
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
88730
|
+
}
|
|
88731
|
+
},
|
|
88732
|
+
{
|
|
88733
|
+
"name": "using-label",
|
|
88734
|
+
"type": {
|
|
88735
|
+
"text": "string | undefined"
|
|
88736
|
+
},
|
|
88737
|
+
"description": "The line shown while a surface with `gestures=\"activate\"` has the\ngestures. Absent is the family's own.",
|
|
88738
|
+
"fieldName": "usingLabel",
|
|
88739
|
+
"inheritedFrom": {
|
|
88740
|
+
"name": "MixinViewport",
|
|
88741
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
88742
|
+
}
|
|
88743
|
+
},
|
|
88744
|
+
{
|
|
88745
|
+
"name": "wheel-hint-label",
|
|
88746
|
+
"type": {
|
|
88747
|
+
"text": "string | undefined"
|
|
88748
|
+
},
|
|
88749
|
+
"description": "The hint shown when the wheel scrolls past a surface with\n`gestures=\"cooperative\"`, with `{key}`, which is ⌘ on a Mac and Ctrl\nelsewhere. Absent is the family's own.",
|
|
88750
|
+
"fieldName": "wheelHintLabel",
|
|
88751
|
+
"inheritedFrom": {
|
|
88752
|
+
"name": "MixinViewport",
|
|
88753
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
88754
|
+
}
|
|
88755
|
+
},
|
|
87760
88756
|
{
|
|
87761
88757
|
"name": "zoom-in-label",
|
|
87762
88758
|
"type": {
|
|
@@ -87783,19 +88779,6 @@
|
|
|
87783
88779
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
87784
88780
|
}
|
|
87785
88781
|
},
|
|
87786
|
-
{
|
|
87787
|
-
"name": "activate-hint-label",
|
|
87788
|
-
"type": {
|
|
87789
|
-
"text": "string"
|
|
87790
|
-
},
|
|
87791
|
-
"default": "'Press the map to use it'",
|
|
87792
|
-
"description": "The hint shown when a map waiting to be pressed is scrolled or swiped\nover, with `gestures=\"activate\"`.",
|
|
87793
|
-
"fieldName": "activateHintLabel",
|
|
87794
|
-
"inheritedFrom": {
|
|
87795
|
-
"name": "HelixHeadlessMap",
|
|
87796
|
-
"module": "src/map/root/map-root.ts"
|
|
87797
|
-
}
|
|
87798
|
-
},
|
|
87799
88782
|
{
|
|
87800
88783
|
"name": "bearing",
|
|
87801
88784
|
"type": {
|
|
@@ -87848,18 +88831,6 @@
|
|
|
87848
88831
|
"module": "src/map/root/map-root.ts"
|
|
87849
88832
|
}
|
|
87850
88833
|
},
|
|
87851
|
-
{
|
|
87852
|
-
"name": "gestures",
|
|
87853
|
-
"type": {
|
|
87854
|
-
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
87855
|
-
},
|
|
87856
|
-
"description": "Which gestures the map takes from the page.\n\n- `always`, which unset is: the wheel zooms the map and one finger pans\n it, for a map that is the page, such as a full-screen view.\n- `cooperative`: the wheel and one finger scroll the page, and the map\n takes Ctrl or ⌘ with the wheel, and two fingers. The frame says so\n when a gesture passes to the page. Best for a map embedded in a page.\n- `activate`: the map takes nothing until it is pressed, and gives it\n back on Escape, when the pointer leaves it, or on a press elsewhere.\n\nThe keyboard and the frame's buttons work in every mode. The renderer is\ntold through the connector, so MapLibre and Leaflet behave alike.",
|
|
87857
|
-
"fieldName": "gestures",
|
|
87858
|
-
"inheritedFrom": {
|
|
87859
|
-
"name": "HelixHeadlessMap",
|
|
87860
|
-
"module": "src/map/root/map-root.ts"
|
|
87861
|
-
}
|
|
87862
|
-
},
|
|
87863
88834
|
{
|
|
87864
88835
|
"name": "hybrid-label",
|
|
87865
88836
|
"type": {
|
|
@@ -88093,45 +89064,6 @@
|
|
|
88093
89064
|
"module": "src/map/root/map-root.ts"
|
|
88094
89065
|
}
|
|
88095
89066
|
},
|
|
88096
|
-
{
|
|
88097
|
-
"name": "two-finger-hint-label",
|
|
88098
|
-
"type": {
|
|
88099
|
-
"text": "string"
|
|
88100
|
-
},
|
|
88101
|
-
"default": "'Use two fingers to move the map'",
|
|
88102
|
-
"description": "The hint shown when one finger swipes over a map with `gestures=\"cooperative\"`.",
|
|
88103
|
-
"fieldName": "twoFingerHintLabel",
|
|
88104
|
-
"inheritedFrom": {
|
|
88105
|
-
"name": "HelixHeadlessMap",
|
|
88106
|
-
"module": "src/map/root/map-root.ts"
|
|
88107
|
-
}
|
|
88108
|
-
},
|
|
88109
|
-
{
|
|
88110
|
-
"name": "using-label",
|
|
88111
|
-
"type": {
|
|
88112
|
-
"text": "string"
|
|
88113
|
-
},
|
|
88114
|
-
"default": "'Using the map. Press Escape to scroll the page again.'",
|
|
88115
|
-
"description": "The line shown while a map with `gestures=\"activate\"` has the gestures.",
|
|
88116
|
-
"fieldName": "usingLabel",
|
|
88117
|
-
"inheritedFrom": {
|
|
88118
|
-
"name": "HelixHeadlessMap",
|
|
88119
|
-
"module": "src/map/root/map-root.ts"
|
|
88120
|
-
}
|
|
88121
|
-
},
|
|
88122
|
-
{
|
|
88123
|
-
"name": "wheel-hint-label",
|
|
88124
|
-
"type": {
|
|
88125
|
-
"text": "string"
|
|
88126
|
-
},
|
|
88127
|
-
"default": "'Use {key} and scroll to zoom the map'",
|
|
88128
|
-
"description": "The hint shown when the wheel scrolls past a map with\n`gestures=\"cooperative\"`, with `{key}`, which is ⌘ on a Mac and Ctrl\nelsewhere, as the renderer reads it.",
|
|
88129
|
-
"fieldName": "wheelHintLabel",
|
|
88130
|
-
"inheritedFrom": {
|
|
88131
|
-
"name": "HelixHeadlessMap",
|
|
88132
|
-
"module": "src/map/root/map-root.ts"
|
|
88133
|
-
}
|
|
88134
|
-
},
|
|
88135
89067
|
{
|
|
88136
89068
|
"name": "zoomed-label",
|
|
88137
89069
|
"type": {
|
|
@@ -88673,6 +89605,14 @@
|
|
|
88673
89605
|
"module": "src/map/root/map-root.ts"
|
|
88674
89606
|
}
|
|
88675
89607
|
},
|
|
89608
|
+
{
|
|
89609
|
+
"description": "The page keeps the plain wheel and one finger, with `gestures=\"cooperative\"` or while a map with `gestures=\"activate\"` waits to be pressed.",
|
|
89610
|
+
"name": "sharing",
|
|
89611
|
+
"inheritedFrom": {
|
|
89612
|
+
"name": "HelixHeadlessMap",
|
|
89613
|
+
"module": "src/map/root/map-root.ts"
|
|
89614
|
+
}
|
|
89615
|
+
},
|
|
88676
89616
|
{
|
|
88677
89617
|
"description": "A map with `gestures=\"activate\"` has been pressed and has the gestures.",
|
|
88678
89618
|
"name": "using",
|