laipeng/reflex
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

default props comment for GraphinTooltip (#4101)

Browse Source 
* default props comment for GraphinTooltip

* update
This commit is contained in:
Carlos 2024-11-05 23:03:07 +01:00 committed by GitHub
parent 4a6c16e9dc
commit 01e3844ac4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 30 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
reflex/components/recharts/general.py
View File

@ -135,16 +135,16 @@ class GraphingTooltip(Recharts):
alias = "RechartsTooltip" alias = "RechartsTooltip"
# The separator between name and value. # The separator between name and value. Default: ":"
separator: Var[str] separator: Var[str]
# The offset size of tooltip. Number # The offset size of tooltip. Number. Default: 10
offset: Var[int] offset: Var[int]
# When an item of the payload has value null or undefined, this item won't be displayed. # When an item of the payload has value null or undefined, this item won't be displayed. Default: True
filter_null: Var[bool] filter_null: Var[bool]
# If set false, no cursor will be drawn when tooltip is active. # If set false, no cursor will be drawn when tooltip is active. Default: {"strokeWidth": 1, "fill": rx.color("gray", 3)}
cursor: Var[Union[Dict[str, Any], bool]] = LiteralVar.create( cursor: Var[Union[Dict[str, Any], bool]] = LiteralVar.create(
{ {
"strokeWidth": 1, "strokeWidth": 1,
@ -155,16 +155,17 @@ class GraphingTooltip(Recharts):
# The box of viewing area, which has the shape of {x: someVal, y: someVal, width: someVal, height: someVal}, usually calculated internally. # The box of viewing area, which has the shape of {x: someVal, y: someVal, width: someVal, height: someVal}, usually calculated internally.
view_box: Var[Dict[str, Any]] view_box: Var[Dict[str, Any]]
# The style of default tooltip content item which is a li element. DEFAULT: {} # The style of default tooltip content item which is a li element. Default: {"color": rx.color("gray", 12)}
item_style: Var[Dict[str, Any]] = LiteralVar.create( item_style: Var[Dict[str, Any]] = LiteralVar.create(
{ {
"color": Color("gray", 12), "color": Color("gray", 12),
} }
) )
# The style of tooltip wrapper which is a dom element. DEFAULT: {} # The style of tooltip wrapper which is a dom element. Default: {}
wrapper_style: Var[Dict[str, Any]] wrapper_style: Var[Dict[str, Any]]
# The style of tooltip content which is a dom element. DEFAULT: {}
# The style of tooltip content which is a dom element. Default: {"background": rx.color("gray", 1), "borderColor": rx.color("gray", 4), "borderRadius": "8px"}
content_style: Var[Dict[str, Any]] = LiteralVar.create( content_style: Var[Dict[str, Any]] = LiteralVar.create(
{ {
"background": Color("gray", 1), "background": Color("gray", 1),
@ -173,30 +174,28 @@ class GraphingTooltip(Recharts):
} }
) )
# The style of default tooltip label which is a p element. DEFAULT: {} # The style of default tooltip label which is a p element. Default: {"color": rx.color("gray", 11)}
label_style: Var[Dict[str, Any]] = LiteralVar.create({"color": Color("gray", 11)}) label_style: Var[Dict[str, Any]] = LiteralVar.create({"color": Color("gray", 11)})
# This option allows the tooltip to extend beyond the viewBox of the chart itself. DEFAULT: { x: false, y: false } # This option allows the tooltip to extend beyond the viewBox of the chart itself. Default: {"x": False, "y": False}
allow_escape_view_box: Var[Dict[str, bool]] = LiteralVar.create( allow_escape_view_box: Var[Dict[str, bool]]
{"x": False, "y": False}
)
# If set true, the tooltip is displayed. If set false, the tooltip is hidden, usually calculated internally. # If set true, the tooltip is displayed. If set false, the tooltip is hidden, usually calculated internally. Default: False
active: Var[bool] active: Var[bool]
# If this field is set, the tooltip position will be fixed and will not move anymore. # If this field is set, the tooltip position will be fixed and will not move anymore.
position: Var[Dict[str, Any]] position: Var[Dict[str, Any]]
# The coordinate of tooltip which is usually calculated internally. # The coordinate of tooltip which is usually calculated internally. Default: {"x": 0, "y": 0}
coordinate: Var[Dict[str, Any]] coordinate: Var[Dict[str, Any]]
# If set false, animation of tooltip will be disabled. DEFAULT: true in CSR, and false in SSR # If set false, animation of tooltip will be disabled. Default: True
is_animation_active: Var[bool] is_animation_active: Var[bool]
# Specifies the duration of animation, the unit of this option is ms. DEFAULT: 1500 # Specifies the duration of animation, the unit of this option is ms. Default: 1500
animation_duration: Var[int] animation_duration: Var[int]
# The type of easing function. DEFAULT: 'ease' # The type of easing function. Default: "ease"
animation_easing: Var[LiteralAnimationEasing] animation_easing: Var[LiteralAnimationEasing]

28
reflex/components/recharts/general.pyi
View File

@ -255,22 +255,22 @@ class GraphingTooltip(Recharts):
Args: Args:
*children: The children of the component. *children: The children of the component.
separator: The separator between name and value. separator: The separator between name and value. Default: ":"
offset: The offset size of tooltip. Number offset: The offset size of tooltip. Number. Default: 10
filter_null: When an item of the payload has value null or undefined, this item won't be displayed. filter_null: When an item of the payload has value null or undefined, this item won't be displayed. Default: True
cursor: If set false, no cursor will be drawn when tooltip is active. cursor: If set false, no cursor will be drawn when tooltip is active. Default: {"strokeWidth": 1, "fill": rx.color("gray", 3)}
view_box: The box of viewing area, which has the shape of {x: someVal, y: someVal, width: someVal, height: someVal}, usually calculated internally. view_box: The box of viewing area, which has the shape of {x: someVal, y: someVal, width: someVal, height: someVal}, usually calculated internally.
item_style: The style of default tooltip content item which is a li element. DEFAULT: {} item_style: The style of default tooltip content item which is a li element. Default: {"color": rx.color("gray", 12)}
wrapper_style: The style of tooltip wrapper which is a dom element. DEFAULT: {} wrapper_style: The style of tooltip wrapper which is a dom element. Default: {}
content_style: The style of tooltip content which is a dom element. DEFAULT: {} content_style: The style of tooltip content which is a dom element. Default: {"background": rx.color("gray", 1), "borderColor": rx.color("gray", 4), "borderRadius": "8px"}
label_style: The style of default tooltip label which is a p element. DEFAULT: {} label_style: The style of default tooltip label which is a p element. Default: {"color": rx.color("gray", 11)}
allow_escape_view_box: This option allows the tooltip to extend beyond the viewBox of the chart itself. DEFAULT: { x: false, y: false } allow_escape_view_box: This option allows the tooltip to extend beyond the viewBox of the chart itself. Default: {"x": False, "y": False}
active: If set true, the tooltip is displayed. If set false, the tooltip is hidden, usually calculated internally. active: If set true, the tooltip is displayed. If set false, the tooltip is hidden, usually calculated internally. Default: False
position: If this field is set, the tooltip position will be fixed and will not move anymore. position: If this field is set, the tooltip position will be fixed and will not move anymore.
coordinate: The coordinate of tooltip which is usually calculated internally. coordinate: The coordinate of tooltip which is usually calculated internally. Default: {"x": 0, "y": 0}
is_animation_active: If set false, animation of tooltip will be disabled. DEFAULT: true in CSR, and false in SSR is_animation_active: If set false, animation of tooltip will be disabled. Default: True
animation_duration: Specifies the duration of animation, the unit of this option is ms. DEFAULT: 1500 animation_duration: Specifies the duration of animation, the unit of this option is ms. Default: 1500
animation_easing: The type of easing function. DEFAULT: 'ease' animation_easing: The type of easing function. Default: "ease"
style: The style of the component. style: The style of the component.
key: A unique key for the component. key: A unique key for the component.
id: The id for the component. id: The id for the component.