Search is not available for this dataset
identifier stringlengths 1 155 | parameters stringlengths 2 6.09k | docstring stringlengths 11 63.4k | docstring_summary stringlengths 0 63.4k | function stringlengths 29 99.8k | function_tokens list | start_point list | end_point list | language stringclasses 1
value | docstring_language stringlengths 2 7 | docstring_language_predictions stringlengths 18 23 | is_langid_reliable stringclasses 2
values |
|---|---|---|---|---|---|---|---|---|---|---|---|
dividercolor | (self) |
Sets the color of the dividers Only has an effect on
"multicategory" axes.
The 'dividercolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
... |
Sets the color of the dividers Only has an effect on
"multicategory" axes.
The 'dividercolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
... | def dividercolor(self):
"""
Sets the color of the dividers Only has an effect on
"multicategory" axes.
The 'dividercolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hs... | [
"def",
"dividercolor",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"dividercolor\"",
"]"
] | [
381,
4
] | [
432,
35
] | python | en | ['en', 'error', 'th'] | False |
dividerwidth | (self) |
Sets the width (in px) of the dividers Only has an effect on
"multicategory" axes.
The 'dividerwidth' property is a number and may be specified as:
- An int or float
Returns
-------
int|float
|
Sets the width (in px) of the dividers Only has an effect on
"multicategory" axes.
The 'dividerwidth' property is a number and may be specified as:
- An int or float | def dividerwidth(self):
"""
Sets the width (in px) of the dividers Only has an effect on
"multicategory" axes.
The 'dividerwidth' property is a number and may be specified as:
- An int or float
Returns
-------
int|float
"""
return s... | [
"def",
"dividerwidth",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"dividerwidth\"",
"]"
] | [
441,
4
] | [
453,
35
] | python | en | ['en', 'error', 'th'] | False |
domain | (self) |
Sets the domain of this axis (in plot fraction).
The 'domain' property is an info array that may be specified as:
* a list or tuple of 2 elements where:
(0) The 'domain[0]' property is a number and may be specified as:
- An int or float in the interval [0, 1]
(1) The... |
Sets the domain of this axis (in plot fraction).
The 'domain' property is an info array that may be specified as:
* a list or tuple of 2 elements where:
(0) The 'domain[0]' property is a number and may be specified as:
- An int or float in the interval [0, 1]
(1) The... | def domain(self):
"""
Sets the domain of this axis (in plot fraction).
The 'domain' property is an info array that may be specified as:
* a list or tuple of 2 elements where:
(0) The 'domain[0]' property is a number and may be specified as:
- An int or float in th... | [
"def",
"domain",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"domain\"",
"]"
] | [
462,
4
] | [
478,
29
] | python | en | ['en', 'error', 'th'] | False |
dtick | (self) |
Sets the step in-between ticks on this axis. Use with `tick0`.
Must be a positive number, or special strings available to
"log" and "date" axes. If the axis `type` is "log", then ticks
are set every 10^(n*dtick) where n is the tick number. For
example, to set a tick mark at 1, 1... |
Sets the step in-between ticks on this axis. Use with `tick0`.
Must be a positive number, or special strings available to
"log" and "date" axes. If the axis `type` is "log", then ticks
are set every 10^(n*dtick) where n is the tick number. For
example, to set a tick mark at 1, 1... | def dtick(self):
"""
Sets the step in-between ticks on this axis. Use with `tick0`.
Must be a positive number, or special strings available to
"log" and "date" axes. If the axis `type` is "log", then ticks
are set every 10^(n*dtick) where n is the tick number. For
example... | [
"def",
"dtick",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"dtick\"",
"]"
] | [
487,
4
] | [
516,
28
] | python | en | ['en', 'error', 'th'] | False |
exponentformat | (self) |
Determines a formatting rule for the tick exponents. For
example, consider the number 1,000,000,000. If "none", it
appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
"power", 1x10^9 (with 9 in a super script). If "SI", 1G. If
"B", 1B.
The 'exponentformat' prop... |
Determines a formatting rule for the tick exponents. For
example, consider the number 1,000,000,000. If "none", it
appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
"power", 1x10^9 (with 9 in a super script). If "SI", 1G. If
"B", 1B.
The 'exponentformat' prop... | def exponentformat(self):
"""
Determines a formatting rule for the tick exponents. For
example, consider the number 1,000,000,000. If "none", it
appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
"power", 1x10^9 (with 9 in a super script). If "SI", 1G. If
"B", 1B.
... | [
"def",
"exponentformat",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"exponentformat\"",
"]"
] | [
525,
4
] | [
541,
37
] | python | en | ['en', 'error', 'th'] | False |
fixedrange | (self) |
Determines whether or not this axis is zoom-able. If true, then
zoom is disabled.
The 'fixedrange' property must be specified as a bool
(either True, or False)
Returns
-------
bool
|
Determines whether or not this axis is zoom-able. If true, then
zoom is disabled.
The 'fixedrange' property must be specified as a bool
(either True, or False) | def fixedrange(self):
"""
Determines whether or not this axis is zoom-able. If true, then
zoom is disabled.
The 'fixedrange' property must be specified as a bool
(either True, or False)
Returns
-------
bool
"""
return self["fixedrange... | [
"def",
"fixedrange",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"fixedrange\"",
"]"
] | [
550,
4
] | [
562,
33
] | python | en | ['en', 'error', 'th'] | False |
gridcolor | (self) |
Sets the color of the grid lines.
The 'gridcolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
- An hsv/hsva string (e.g. 'hsv(0,100%,100... |
Sets the color of the grid lines.
The 'gridcolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
- An hsv/hsva string (e.g. 'hsv(0,100%,100... | def gridcolor(self):
"""
Sets the color of the grid lines.
The 'gridcolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
- An hsv/h... | [
"def",
"gridcolor",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"gridcolor\"",
"]"
] | [
571,
4
] | [
621,
32
] | python | en | ['en', 'error', 'th'] | False |
gridwidth | (self) |
Sets the width (in px) of the grid lines.
The 'gridwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
int|float
|
Sets the width (in px) of the grid lines.
The 'gridwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf] | def gridwidth(self):
"""
Sets the width (in px) of the grid lines.
The 'gridwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
int|float
"""
return self["gridwidth"] | [
"def",
"gridwidth",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"gridwidth\"",
"]"
] | [
630,
4
] | [
641,
32
] | python | en | ['en', 'error', 'th'] | False |
hoverformat | (self) |
Sets the hover text formatting rule using d3 formatting mini-
languages which are very similar to those in Python. For
numbers, see: https://github.com/d3/d3-3.x-api-
reference/blob/master/Formatting.md#d3_format And for dates
see: https://github.com/d3/d3-3.x-api-
refer... |
Sets the hover text formatting rule using d3 formatting mini-
languages which are very similar to those in Python. For
numbers, see: https://github.com/d3/d3-3.x-api-
reference/blob/master/Formatting.md#d3_format And for dates
see: https://github.com/d3/d3-3.x-api-
refer... | def hoverformat(self):
"""
Sets the hover text formatting rule using d3 formatting mini-
languages which are very similar to those in Python. For
numbers, see: https://github.com/d3/d3-3.x-api-
reference/blob/master/Formatting.md#d3_format And for dates
see: https://githu... | [
"def",
"hoverformat",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"hoverformat\"",
"]"
] | [
650,
4
] | [
670,
34
] | python | en | ['en', 'error', 'th'] | False |
layer | (self) |
Sets the layer on which this axis is displayed. If *above
traces*, this axis is displayed above all the subplot's traces
If *below traces*, this axis is displayed below all the
subplot's traces, but above the grid lines. Useful when used
together with scatter-like traces with `c... |
Sets the layer on which this axis is displayed. If *above
traces*, this axis is displayed above all the subplot's traces
If *below traces*, this axis is displayed below all the
subplot's traces, but above the grid lines. Useful when used
together with scatter-like traces with `c... | def layer(self):
"""
Sets the layer on which this axis is displayed. If *above
traces*, this axis is displayed above all the subplot's traces
If *below traces*, this axis is displayed below all the
subplot's traces, but above the grid lines. Useful when used
together with... | [
"def",
"layer",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"layer\"",
"]"
] | [
679,
4
] | [
696,
28
] | python | en | ['en', 'error', 'th'] | False |
linecolor | (self) |
Sets the axis line color.
The 'linecolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
... |
Sets the axis line color.
The 'linecolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
... | def linecolor(self):
"""
Sets the axis line color.
The 'linecolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
- An hsv/hsva stri... | [
"def",
"linecolor",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"linecolor\"",
"]"
] | [
705,
4
] | [
755,
32
] | python | en | ['en', 'error', 'th'] | False |
linewidth | (self) |
Sets the width (in px) of the axis line.
The 'linewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
int|float
|
Sets the width (in px) of the axis line.
The 'linewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf] | def linewidth(self):
"""
Sets the width (in px) of the axis line.
The 'linewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
int|float
"""
return self["linewidth"] | [
"def",
"linewidth",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"linewidth\"",
"]"
] | [
764,
4
] | [
775,
32
] | python | en | ['en', 'error', 'th'] | False |
matches | (self) |
If set to another axis id (e.g. `x2`, `y`), the range of this
axis will match the range of the corresponding axis in data-
coordinates space. Moreover, matching axes share auto-range
values, category lists and histogram auto-bins. Note that
setting axes simultaneously in both a ... |
If set to another axis id (e.g. `x2`, `y`), the range of this
axis will match the range of the corresponding axis in data-
coordinates space. Moreover, matching axes share auto-range
values, category lists and histogram auto-bins. Note that
setting axes simultaneously in both a ... | def matches(self):
"""
If set to another axis id (e.g. `x2`, `y`), the range of this
axis will match the range of the corresponding axis in data-
coordinates space. Moreover, matching axes share auto-range
values, category lists and histogram auto-bins. Note that
setting ... | [
"def",
"matches",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"matches\"",
"]"
] | [
784,
4
] | [
802,
30
] | python | en | ['en', 'error', 'th'] | False |
mirror | (self) |
Determines if the axis lines or/and ticks are mirrored to the
opposite side of the plotting area. If True, the axis lines are
mirrored. If "ticks", the axis lines and ticks are mirrored. If
False, mirroring is disable. If "all", axis lines are mirrored
on all shared-axes subplot... |
Determines if the axis lines or/and ticks are mirrored to the
opposite side of the plotting area. If True, the axis lines are
mirrored. If "ticks", the axis lines and ticks are mirrored. If
False, mirroring is disable. If "all", axis lines are mirrored
on all shared-axes subplot... | def mirror(self):
"""
Determines if the axis lines or/and ticks are mirrored to the
opposite side of the plotting area. If True, the axis lines are
mirrored. If "ticks", the axis lines and ticks are mirrored. If
False, mirroring is disable. If "all", axis lines are mirrored
... | [
"def",
"mirror",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"mirror\"",
"]"
] | [
811,
4
] | [
828,
29
] | python | en | ['en', 'error', 'th'] | False |
nticks | (self) |
Specifies the maximum number of ticks for the particular axis.
The actual number of ticks will be chosen automatically to be
less than or equal to `nticks`. Has an effect only if
`tickmode` is set to "auto".
The 'nticks' property is a integer and may be specified as:
... |
Specifies the maximum number of ticks for the particular axis.
The actual number of ticks will be chosen automatically to be
less than or equal to `nticks`. Has an effect only if
`tickmode` is set to "auto".
The 'nticks' property is a integer and may be specified as:
... | def nticks(self):
"""
Specifies the maximum number of ticks for the particular axis.
The actual number of ticks will be chosen automatically to be
less than or equal to `nticks`. Has an effect only if
`tickmode` is set to "auto".
The 'nticks' property is a integer an... | [
"def",
"nticks",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"nticks\"",
"]"
] | [
837,
4
] | [
852,
29
] | python | en | ['en', 'error', 'th'] | False |
overlaying | (self) |
If set a same-letter axis id, this axis is overlaid on top of
the corresponding same-letter axis, with traces and axes
visible for both axes. If False, this axis does not overlay any
same-letter axes. In this case, for axes with overlapping
domains only the highest-numbered axis... |
If set a same-letter axis id, this axis is overlaid on top of
the corresponding same-letter axis, with traces and axes
visible for both axes. If False, this axis does not overlay any
same-letter axes. In this case, for axes with overlapping
domains only the highest-numbered axis... | def overlaying(self):
"""
If set a same-letter axis id, this axis is overlaid on top of
the corresponding same-letter axis, with traces and axes
visible for both axes. If False, this axis does not overlay any
same-letter axes. In this case, for axes with overlapping
domai... | [
"def",
"overlaying",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"overlaying\"",
"]"
] | [
861,
4
] | [
879,
33
] | python | en | ['en', 'error', 'th'] | False |
position | (self) |
Sets the position of this axis in the plotting space (in
normalized coordinates). Only has an effect if `anchor` is set
to "free".
The 'position' property is a number and may be specified as:
- An int or float in the interval [0, 1]
Returns
-------
... |
Sets the position of this axis in the plotting space (in
normalized coordinates). Only has an effect if `anchor` is set
to "free".
The 'position' property is a number and may be specified as:
- An int or float in the interval [0, 1] | def position(self):
"""
Sets the position of this axis in the plotting space (in
normalized coordinates). Only has an effect if `anchor` is set
to "free".
The 'position' property is a number and may be specified as:
- An int or float in the interval [0, 1]
... | [
"def",
"position",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"position\"",
"]"
] | [
888,
4
] | [
901,
31
] | python | en | ['en', 'error', 'th'] | False |
range | (self) |
Sets the range of this axis. If the axis `type` is "log", then
you must take the log of your desired range (e.g. to set the
range from 1 to 100, set the range from 0 to 2). If the axis
`type` is "date", it should be date strings, like date data,
though Date objects and unix mill... |
Sets the range of this axis. If the axis `type` is "log", then
you must take the log of your desired range (e.g. to set the
range from 1 to 100, set the range from 0 to 2). If the axis
`type` is "date", it should be date strings, like date data,
though Date objects and unix mill... | def range(self):
"""
Sets the range of this axis. If the axis `type` is "log", then
you must take the log of your desired range (e.g. to set the
range from 1 to 100, set the range from 0 to 2). If the axis
`type` is "date", it should be date strings, like date data,
thoug... | [
"def",
"range",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"range\"",
"]"
] | [
910,
4
] | [
931,
28
] | python | en | ['en', 'error', 'th'] | False |
rangebreaks | (self) |
The 'rangebreaks' property is a tuple of instances of
Rangebreak that may be specified as:
- A list or tuple of instances of plotly.graph_objs.layout.yaxis.Rangebreak
- A list or tuple of dicts of string/value properties that
will be passed to the Rangebreak constructor
... |
The 'rangebreaks' property is a tuple of instances of
Rangebreak that may be specified as:
- A list or tuple of instances of plotly.graph_objs.layout.yaxis.Rangebreak
- A list or tuple of dicts of string/value properties that
will be passed to the Rangebreak constructor
... | def rangebreaks(self):
"""
The 'rangebreaks' property is a tuple of instances of
Rangebreak that may be specified as:
- A list or tuple of instances of plotly.graph_objs.layout.yaxis.Rangebreak
- A list or tuple of dicts of string/value properties that
will be pas... | [
"def",
"rangebreaks",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"rangebreaks\"",
"]"
] | [
940,
4
] | [
1006,
34
] | python | en | ['en', 'error', 'th'] | False |
rangebreakdefaults | (self) |
When used in a template (as
layout.template.layout.yaxis.rangebreakdefaults), sets the
default property values to use for elements of
layout.yaxis.rangebreaks
The 'rangebreakdefaults' property is an instance of Rangebreak
that may be specified as:
- An ins... |
When used in a template (as
layout.template.layout.yaxis.rangebreakdefaults), sets the
default property values to use for elements of
layout.yaxis.rangebreaks
The 'rangebreakdefaults' property is an instance of Rangebreak
that may be specified as:
- An ins... | def rangebreakdefaults(self):
"""
When used in a template (as
layout.template.layout.yaxis.rangebreakdefaults), sets the
default property values to use for elements of
layout.yaxis.rangebreaks
The 'rangebreakdefaults' property is an instance of Rangebreak
tha... | [
"def",
"rangebreakdefaults",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"rangebreakdefaults\"",
"]"
] | [
1015,
4
] | [
1034,
41
] | python | en | ['en', 'error', 'th'] | False |
rangemode | (self) |
If "normal", the range is computed in relation to the extrema
of the input data. If *tozero*`, the range extends to 0,
regardless of the input data If "nonnegative", the range is
non-negative, regardless of the input data. Applies only to
linear axes.
The 'rangemode... |
If "normal", the range is computed in relation to the extrema
of the input data. If *tozero*`, the range extends to 0,
regardless of the input data If "nonnegative", the range is
non-negative, regardless of the input data. Applies only to
linear axes.
The 'rangemode... | def rangemode(self):
"""
If "normal", the range is computed in relation to the extrema
of the input data. If *tozero*`, the range extends to 0,
regardless of the input data If "nonnegative", the range is
non-negative, regardless of the input data. Applies only to
linear a... | [
"def",
"rangemode",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"rangemode\"",
"]"
] | [
1043,
4
] | [
1059,
32
] | python | en | ['en', 'error', 'th'] | False |
scaleanchor | (self) |
If set to another axis id (e.g. `x2`, `y`), the range of this
axis changes together with the range of the corresponding axis
such that the scale of pixels per unit is in a constant ratio.
Both axes are still zoomable, but when you zoom one, the other
will zoom the same amount, k... |
If set to another axis id (e.g. `x2`, `y`), the range of this
axis changes together with the range of the corresponding axis
such that the scale of pixels per unit is in a constant ratio.
Both axes are still zoomable, but when you zoom one, the other
will zoom the same amount, k... | def scaleanchor(self):
"""
If set to another axis id (e.g. `x2`, `y`), the range of this
axis changes together with the range of the corresponding axis
such that the scale of pixels per unit is in a constant ratio.
Both axes are still zoomable, but when you zoom one, the other
... | [
"def",
"scaleanchor",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"scaleanchor\"",
"]"
] | [
1068,
4
] | [
1095,
34
] | python | en | ['en', 'error', 'th'] | False |
scaleratio | (self) |
If this axis is linked to another by `scaleanchor`, this
determines the pixel to unit scale ratio. For example, if this
value is 10, then every unit on this axis spans 10 times the
number of pixels as a unit on the linked axis. Use this for
example to create an elevation profile... |
If this axis is linked to another by `scaleanchor`, this
determines the pixel to unit scale ratio. For example, if this
value is 10, then every unit on this axis spans 10 times the
number of pixels as a unit on the linked axis. Use this for
example to create an elevation profile... | def scaleratio(self):
"""
If this axis is linked to another by `scaleanchor`, this
determines the pixel to unit scale ratio. For example, if this
value is 10, then every unit on this axis spans 10 times the
number of pixels as a unit on the linked axis. Use this for
examp... | [
"def",
"scaleratio",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"scaleratio\"",
"]"
] | [
1104,
4
] | [
1120,
33
] | python | en | ['en', 'error', 'th'] | False |
separatethousands | (self) |
If "true", even 4-digit integers are separated
The 'separatethousands' property must be specified as a bool
(either True, or False)
Returns
-------
bool
|
If "true", even 4-digit integers are separated
The 'separatethousands' property must be specified as a bool
(either True, or False) | def separatethousands(self):
"""
If "true", even 4-digit integers are separated
The 'separatethousands' property must be specified as a bool
(either True, or False)
Returns
-------
bool
"""
return self["separatethousands"] | [
"def",
"separatethousands",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"separatethousands\"",
"]"
] | [
1129,
4
] | [
1140,
40
] | python | en | ['en', 'error', 'th'] | False |
showdividers | (self) |
Determines whether or not a dividers are drawn between the
category levels of this axis. Only has an effect on
"multicategory" axes.
The 'showdividers' property must be specified as a bool
(either True, or False)
Returns
-------
bool
|
Determines whether or not a dividers are drawn between the
category levels of this axis. Only has an effect on
"multicategory" axes.
The 'showdividers' property must be specified as a bool
(either True, or False) | def showdividers(self):
"""
Determines whether or not a dividers are drawn between the
category levels of this axis. Only has an effect on
"multicategory" axes.
The 'showdividers' property must be specified as a bool
(either True, or False)
Returns
-... | [
"def",
"showdividers",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"showdividers\"",
"]"
] | [
1149,
4
] | [
1162,
35
] | python | en | ['en', 'error', 'th'] | False |
showexponent | (self) |
If "all", all exponents are shown besides their significands.
If "first", only the exponent of the first tick is shown. If
"last", only the exponent of the last tick is shown. If "none",
no exponents appear.
The 'showexponent' property is an enumeration that may be specifie... |
If "all", all exponents are shown besides their significands.
If "first", only the exponent of the first tick is shown. If
"last", only the exponent of the last tick is shown. If "none",
no exponents appear.
The 'showexponent' property is an enumeration that may be specifie... | def showexponent(self):
"""
If "all", all exponents are shown besides their significands.
If "first", only the exponent of the first tick is shown. If
"last", only the exponent of the last tick is shown. If "none",
no exponents appear.
The 'showexponent' property is ... | [
"def",
"showexponent",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"showexponent\"",
"]"
] | [
1171,
4
] | [
1186,
35
] | python | en | ['en', 'error', 'th'] | False |
showgrid | (self) |
Determines whether or not grid lines are drawn. If True, the
grid lines are drawn at every tick mark.
The 'showgrid' property must be specified as a bool
(either True, or False)
Returns
-------
bool
|
Determines whether or not grid lines are drawn. If True, the
grid lines are drawn at every tick mark.
The 'showgrid' property must be specified as a bool
(either True, or False) | def showgrid(self):
"""
Determines whether or not grid lines are drawn. If True, the
grid lines are drawn at every tick mark.
The 'showgrid' property must be specified as a bool
(either True, or False)
Returns
-------
bool
"""
return ... | [
"def",
"showgrid",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"showgrid\"",
"]"
] | [
1195,
4
] | [
1207,
31
] | python | en | ['en', 'error', 'th'] | False |
showline | (self) |
Determines whether or not a line bounding this axis is drawn.
The 'showline' property must be specified as a bool
(either True, or False)
Returns
-------
bool
|
Determines whether or not a line bounding this axis is drawn.
The 'showline' property must be specified as a bool
(either True, or False) | def showline(self):
"""
Determines whether or not a line bounding this axis is drawn.
The 'showline' property must be specified as a bool
(either True, or False)
Returns
-------
bool
"""
return self["showline"] | [
"def",
"showline",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"showline\"",
"]"
] | [
1216,
4
] | [
1227,
31
] | python | en | ['en', 'error', 'th'] | False |
showspikes | (self) |
Determines whether or not spikes (aka droplines) are drawn for
this axis. Note: This only takes affect when hovermode =
closest
The 'showspikes' property must be specified as a bool
(either True, or False)
Returns
-------
bool
|
Determines whether or not spikes (aka droplines) are drawn for
this axis. Note: This only takes affect when hovermode =
closest
The 'showspikes' property must be specified as a bool
(either True, or False) | def showspikes(self):
"""
Determines whether or not spikes (aka droplines) are drawn for
this axis. Note: This only takes affect when hovermode =
closest
The 'showspikes' property must be specified as a bool
(either True, or False)
Returns
-------
... | [
"def",
"showspikes",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"showspikes\"",
"]"
] | [
1236,
4
] | [
1249,
33
] | python | en | ['en', 'error', 'th'] | False |
showticklabels | (self) |
Determines whether or not the tick labels are drawn.
The 'showticklabels' property must be specified as a bool
(either True, or False)
Returns
-------
bool
|
Determines whether or not the tick labels are drawn.
The 'showticklabels' property must be specified as a bool
(either True, or False) | def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
The 'showticklabels' property must be specified as a bool
(either True, or False)
Returns
-------
bool
"""
return self["showticklabels"] | [
"def",
"showticklabels",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"showticklabels\"",
"]"
] | [
1258,
4
] | [
1269,
37
] | python | en | ['en', 'error', 'th'] | False |
showtickprefix | (self) |
If "all", all tick labels are displayed with a prefix. If
"first", only the first tick is displayed with a prefix. If
"last", only the last tick is displayed with a suffix. If
"none", tick prefixes are hidden.
The 'showtickprefix' property is an enumeration that may be spec... |
If "all", all tick labels are displayed with a prefix. If
"first", only the first tick is displayed with a prefix. If
"last", only the last tick is displayed with a suffix. If
"none", tick prefixes are hidden.
The 'showtickprefix' property is an enumeration that may be spec... | def showtickprefix(self):
"""
If "all", all tick labels are displayed with a prefix. If
"first", only the first tick is displayed with a prefix. If
"last", only the last tick is displayed with a suffix. If
"none", tick prefixes are hidden.
The 'showtickprefix' proper... | [
"def",
"showtickprefix",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"showtickprefix\"",
"]"
] | [
1278,
4
] | [
1293,
37
] | python | en | ['en', 'error', 'th'] | False |
showticksuffix | (self) |
Same as `showtickprefix` but for tick suffixes.
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
Returns
-------
Any
|
Same as `showtickprefix` but for tick suffixes.
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none'] | def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
Returns
-------
... | [
"def",
"showticksuffix",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"showticksuffix\"",
"]"
] | [
1302,
4
] | [
1314,
37
] | python | en | ['en', 'error', 'th'] | False |
side | (self) |
Determines whether a x (y) axis is positioned at the "bottom"
("left") or "top" ("right") of the plotting area.
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'bottom', 'left', 'right']
R... |
Determines whether a x (y) axis is positioned at the "bottom"
("left") or "top" ("right") of the plotting area.
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'bottom', 'left', 'right'] | def side(self):
"""
Determines whether a x (y) axis is positioned at the "bottom"
("left") or "top" ("right") of the plotting area.
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'bottom', ... | [
"def",
"side",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"side\"",
"]"
] | [
1323,
4
] | [
1336,
27
] | python | en | ['en', 'error', 'th'] | False |
spikecolor | (self) |
Sets the spike color. If undefined, will use the series color
The 'spikecolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
- An hsv/hsva... |
Sets the spike color. If undefined, will use the series color
The 'spikecolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
- An hsv/hsva... | def spikecolor(self):
"""
Sets the spike color. If undefined, will use the series color
The 'spikecolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,10... | [
"def",
"spikecolor",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"spikecolor\"",
"]"
] | [
1345,
4
] | [
1395,
33
] | python | en | ['en', 'error', 'th'] | False |
spikedash | (self) |
Sets the dash style of lines. Set to a dash type string
("solid", "dot", "dash", "longdash", "dashdot", or
"longdashdot") or a dash length list in px (eg
"5px,10px,2px,2px").
The 'spikedash' property is a string and must be specified as:
- One of the following str... |
Sets the dash style of lines. Set to a dash type string
("solid", "dot", "dash", "longdash", "dashdot", or
"longdashdot") or a dash length list in px (eg
"5px,10px,2px,2px").
The 'spikedash' property is a string and must be specified as:
- One of the following str... | def spikedash(self):
"""
Sets the dash style of lines. Set to a dash type string
("solid", "dot", "dash", "longdash", "dashdot", or
"longdashdot") or a dash length list in px (eg
"5px,10px,2px,2px").
The 'spikedash' property is a string and must be specified as:
... | [
"def",
"spikedash",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"spikedash\"",
"]"
] | [
1404,
4
] | [
1421,
32
] | python | en | ['en', 'error', 'th'] | False |
spikemode | (self) |
Determines the drawing mode for the spike line If "toaxis", the
line is drawn from the data point to the axis the series is
plotted on. If "across", the line is drawn across the entire
plot area, and supercedes "toaxis". If "marker", then a marker
dot is drawn on the axis the s... |
Determines the drawing mode for the spike line If "toaxis", the
line is drawn from the data point to the axis the series is
plotted on. If "across", the line is drawn across the entire
plot area, and supercedes "toaxis". If "marker", then a marker
dot is drawn on the axis the s... | def spikemode(self):
"""
Determines the drawing mode for the spike line If "toaxis", the
line is drawn from the data point to the axis the series is
plotted on. If "across", the line is drawn across the entire
plot area, and supercedes "toaxis". If "marker", then a marker
... | [
"def",
"spikemode",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"spikemode\"",
"]"
] | [
1430,
4
] | [
1447,
32
] | python | en | ['en', 'error', 'th'] | False |
spikesnap | (self) |
Determines whether spikelines are stuck to the cursor or to the
closest datapoints.
The 'spikesnap' property is an enumeration that may be specified as:
- One of the following enumeration values:
['data', 'cursor', 'hovered data']
Returns
-------
... |
Determines whether spikelines are stuck to the cursor or to the
closest datapoints.
The 'spikesnap' property is an enumeration that may be specified as:
- One of the following enumeration values:
['data', 'cursor', 'hovered data'] | def spikesnap(self):
"""
Determines whether spikelines are stuck to the cursor or to the
closest datapoints.
The 'spikesnap' property is an enumeration that may be specified as:
- One of the following enumeration values:
['data', 'cursor', 'hovered data']
... | [
"def",
"spikesnap",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"spikesnap\"",
"]"
] | [
1456,
4
] | [
1469,
32
] | python | en | ['en', 'error', 'th'] | False |
spikethickness | (self) |
Sets the width (in px) of the zero line.
The 'spikethickness' property is a number and may be specified as:
- An int or float
Returns
-------
int|float
|
Sets the width (in px) of the zero line.
The 'spikethickness' property is a number and may be specified as:
- An int or float | def spikethickness(self):
"""
Sets the width (in px) of the zero line.
The 'spikethickness' property is a number and may be specified as:
- An int or float
Returns
-------
int|float
"""
return self["spikethickness"] | [
"def",
"spikethickness",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"spikethickness\"",
"]"
] | [
1478,
4
] | [
1489,
37
] | python | en | ['en', 'error', 'th'] | False |
tick0 | (self) |
Sets the placement of the first tick on this axis. Use with
`dtick`. If the axis `type` is "log", then you must take the
log of your starting tick (e.g. to set the starting tick to
100, set the `tick0` to 2) except when `dtick`=*L<f>* (see
`dtick` for more info). If the axis `ty... |
Sets the placement of the first tick on this axis. Use with
`dtick`. If the axis `type` is "log", then you must take the
log of your starting tick (e.g. to set the starting tick to
100, set the `tick0` to 2) except when `dtick`=*L<f>* (see
`dtick` for more info). If the axis `ty... | def tick0(self):
"""
Sets the placement of the first tick on this axis. Use with
`dtick`. If the axis `type` is "log", then you must take the
log of your starting tick (e.g. to set the starting tick to
100, set the `tick0` to 2) except when `dtick`=*L<f>* (see
`dtick` for... | [
"def",
"tick0",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"tick0\"",
"]"
] | [
1498,
4
] | [
1516,
28
] | python | en | ['en', 'error', 'th'] | False |
tickangle | (self) |
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
The 'tickangle' property is a angle (in degrees) that may be
specified as a number between -180 and 180. Numeric values outside this
... |
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
The 'tickangle' property is a angle (in degrees) that may be
specified as a number between -180 and 180. Numeric values outside this
... | def tickangle(self):
"""
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
The 'tickangle' property is a angle (in degrees) that may be
specified as a number between -180 and 180. Num... | [
"def",
"tickangle",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"tickangle\"",
"]"
] | [
1525,
4
] | [
1540,
32
] | python | en | ['en', 'error', 'th'] | False |
tickcolor | (self) |
Sets the tick color.
The 'tickcolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
... |
Sets the tick color.
The 'tickcolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
... | def tickcolor(self):
"""
Sets the tick color.
The 'tickcolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
- An hsv/hsva string (e... | [
"def",
"tickcolor",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"tickcolor\"",
"]"
] | [
1549,
4
] | [
1599,
32
] | python | en | ['en', 'error', 'th'] | False |
tickfont | (self) |
Sets the tick font.
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.yaxis.Tickfont`
- A dict of string/value properties that will be passed
to the Tickfont constructor
... |
Sets the tick font.
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.yaxis.Tickfont`
- A dict of string/value properties that will be passed
to the Tickfont constructor
... | def tickfont(self):
"""
Sets the tick font.
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.yaxis.Tickfont`
- A dict of string/value properties that will be passed
to the T... | [
"def",
"tickfont",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"tickfont\"",
"]"
] | [
1608,
4
] | [
1645,
31
] | python | en | ['en', 'error', 'th'] | False |
tickformat | (self) |
Sets the tick label formatting rule using d3 formatting mini-
languages which are very similar to those in Python. For
numbers, see: https://github.com/d3/d3-3.x-api-
reference/blob/master/Formatting.md#d3_format And for dates
see: https://github.com/d3/d3-3.x-api-
refer... |
Sets the tick label formatting rule using d3 formatting mini-
languages which are very similar to those in Python. For
numbers, see: https://github.com/d3/d3-3.x-api-
reference/blob/master/Formatting.md#d3_format And for dates
see: https://github.com/d3/d3-3.x-api-
refer... | def tickformat(self):
"""
Sets the tick label formatting rule using d3 formatting mini-
languages which are very similar to those in Python. For
numbers, see: https://github.com/d3/d3-3.x-api-
reference/blob/master/Formatting.md#d3_format And for dates
see: https://github... | [
"def",
"tickformat",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"tickformat\"",
"]"
] | [
1654,
4
] | [
1674,
33
] | python | en | ['en', 'error', 'th'] | False |
tickformatstops | (self) |
The 'tickformatstops' property is a tuple of instances of
Tickformatstop that may be specified as:
- A list or tuple of instances of plotly.graph_objs.layout.yaxis.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformats... |
The 'tickformatstops' property is a tuple of instances of
Tickformatstop that may be specified as:
- A list or tuple of instances of plotly.graph_objs.layout.yaxis.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformats... | def tickformatstops(self):
"""
The 'tickformatstops' property is a tuple of instances of
Tickformatstop that may be specified as:
- A list or tuple of instances of plotly.graph_objs.layout.yaxis.Tickformatstop
- A list or tuple of dicts of string/value properties that
... | [
"def",
"tickformatstops",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"tickformatstops\"",
"]"
] | [
1683,
4
] | [
1731,
38
] | python | en | ['en', 'error', 'th'] | False |
tickformatstopdefaults | (self) |
When used in a template (as
layout.template.layout.yaxis.tickformatstopdefaults), sets the
default property values to use for elements of
layout.yaxis.tickformatstops
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
... |
When used in a template (as
layout.template.layout.yaxis.tickformatstopdefaults), sets the
default property values to use for elements of
layout.yaxis.tickformatstops
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
... | def tickformatstopdefaults(self):
"""
When used in a template (as
layout.template.layout.yaxis.tickformatstopdefaults), sets the
default property values to use for elements of
layout.yaxis.tickformatstops
The 'tickformatstopdefaults' property is an instance of Tickfo... | [
"def",
"tickformatstopdefaults",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"tickformatstopdefaults\"",
"]"
] | [
1740,
4
] | [
1759,
45
] | python | en | ['en', 'error', 'th'] | False |
ticklen | (self) |
Sets the tick length (in px).
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
int|float
|
Sets the tick length (in px).
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf] | def ticklen(self):
"""
Sets the tick length (in px).
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
int|float
"""
return self["ticklen"] | [
"def",
"ticklen",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"ticklen\"",
"]"
] | [
1768,
4
] | [
1779,
30
] | python | en | ['en', 'error', 'th'] | False |
tickmode | (self) |
Sets the tick mode for this axis. If "auto", the number of
ticks is set via `nticks`. If "linear", the placement of the
ticks is determined by a starting position `tick0` and a tick
step `dtick` ("linear" is the default value if `tick0` and
`dtick` are provided). If "array", the... |
Sets the tick mode for this axis. If "auto", the number of
ticks is set via `nticks`. If "linear", the placement of the
ticks is determined by a starting position `tick0` and a tick
step `dtick` ("linear" is the default value if `tick0` and
`dtick` are provided). If "array", the... | def tickmode(self):
"""
Sets the tick mode for this axis. If "auto", the number of
ticks is set via `nticks`. If "linear", the placement of the
ticks is determined by a starting position `tick0` and a tick
step `dtick` ("linear" is the default value if `tick0` and
`dtick`... | [
"def",
"tickmode",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"tickmode\"",
"]"
] | [
1788,
4
] | [
1806,
31
] | python | en | ['en', 'error', 'th'] | False |
tickprefix | (self) |
Sets a tick label prefix.
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
Returns
-------
str
|
Sets a tick label prefix.
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string | def tickprefix(self):
"""
Sets a tick label prefix.
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
Returns
-------
str
"""
return self["tickprefix"] | [
"def",
"tickprefix",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"tickprefix\"",
"]"
] | [
1815,
4
] | [
1827,
33
] | python | en | ['en', 'error', 'th'] | False |
ticks | (self) |
Determines whether ticks are drawn or not. If "", this axis'
ticks are not drawn. If "outside" ("inside"), this axis' are
drawn outside (inside) the axis lines.
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
... |
Determines whether ticks are drawn or not. If "", this axis'
ticks are not drawn. If "outside" ("inside"), this axis' are
drawn outside (inside) the axis lines.
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
... | def ticks(self):
"""
Determines whether ticks are drawn or not. If "", this axis'
ticks are not drawn. If "outside" ("inside"), this axis' are
drawn outside (inside) the axis lines.
The 'ticks' property is an enumeration that may be specified as:
- One of the follo... | [
"def",
"ticks",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"ticks\"",
"]"
] | [
1836,
4
] | [
1850,
28
] | python | en | ['en', 'error', 'th'] | False |
tickson | (self) |
Determines where ticks and grid lines are drawn with respect to
their corresponding tick labels. Only has an effect for axes of
`type` "category" or "multicategory". When set to "boundaries",
ticks and grid lines are drawn half a category to the
left/bottom of labels.
... |
Determines where ticks and grid lines are drawn with respect to
their corresponding tick labels. Only has an effect for axes of
`type` "category" or "multicategory". When set to "boundaries",
ticks and grid lines are drawn half a category to the
left/bottom of labels.
... | def tickson(self):
"""
Determines where ticks and grid lines are drawn with respect to
their corresponding tick labels. Only has an effect for axes of
`type` "category" or "multicategory". When set to "boundaries",
ticks and grid lines are drawn half a category to the
lef... | [
"def",
"tickson",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"tickson\"",
"]"
] | [
1859,
4
] | [
1875,
30
] | python | en | ['en', 'error', 'th'] | False |
ticksuffix | (self) |
Sets a tick label suffix.
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
Returns
-------
str
|
Sets a tick label suffix.
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string | def ticksuffix(self):
"""
Sets a tick label suffix.
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
Returns
-------
str
"""
return self["ticksuffix"] | [
"def",
"ticksuffix",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"ticksuffix\"",
"]"
] | [
1884,
4
] | [
1896,
33
] | python | en | ['en', 'error', 'th'] | False |
ticktext | (self) |
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
Returns
-------... |
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series | def ticktext(self):
"""
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
... | [
"def",
"ticktext",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"ticktext\"",
"]"
] | [
1905,
4
] | [
1918,
31
] | python | en | ['en', 'error', 'th'] | False |
ticktextsrc | (self) |
Sets the source reference on Chart Studio Cloud for ticktext .
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
|
Sets the source reference on Chart Studio Cloud for ticktext .
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object | def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["ticktextsrc"] | [
"def",
"ticktextsrc",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"ticktextsrc\"",
"]"
] | [
1927,
4
] | [
1938,
34
] | python | en | ['en', 'error', 'th'] | False |
tickvals | (self) |
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
Returns
-------
numpy.nda... |
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series | def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
Returns
... | [
"def",
"tickvals",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"tickvals\"",
"]"
] | [
1947,
4
] | [
1959,
31
] | python | en | ['en', 'error', 'th'] | False |
tickvalssrc | (self) |
Sets the source reference on Chart Studio Cloud for tickvals .
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
|
Sets the source reference on Chart Studio Cloud for tickvals .
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object | def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["tickvalssrc"] | [
"def",
"tickvalssrc",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"tickvalssrc\"",
"]"
] | [
1968,
4
] | [
1979,
34
] | python | en | ['en', 'error', 'th'] | False |
tickwidth | (self) |
Sets the tick width (in px).
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
int|float
|
Sets the tick width (in px).
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf] | def tickwidth(self):
"""
Sets the tick width (in px).
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
int|float
"""
return self["tickwidth"] | [
"def",
"tickwidth",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"tickwidth\"",
"]"
] | [
1988,
4
] | [
1999,
32
] | python | en | ['en', 'error', 'th'] | False |
title | (self) |
The 'title' property is an instance of Title
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.yaxis.Title`
- A dict of string/value properties that will be passed
to the Title constructor
Supported dict properties:
... |
The 'title' property is an instance of Title
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.yaxis.Title`
- A dict of string/value properties that will be passed
to the Title constructor
Supported dict properties:
... | def title(self):
"""
The 'title' property is an instance of Title
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.yaxis.Title`
- A dict of string/value properties that will be passed
to the Title constructor
Supported d... | [
"def",
"title",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"title\"",
"]"
] | [
2008,
4
] | [
2045,
28
] | python | en | ['en', 'error', 'th'] | False |
titlefont | (self) |
Deprecated: Please use layout.yaxis.title.font instead. Sets
this axis' title font. Note that the title's font used to be
customized by the now deprecated `titlefont` attribute.
The 'font' property is an instance of Font
that may be specified as:
- An instance of ... |
Deprecated: Please use layout.yaxis.title.font instead. Sets
this axis' title font. Note that the title's font used to be
customized by the now deprecated `titlefont` attribute.
The 'font' property is an instance of Font
that may be specified as:
- An instance of ... | def titlefont(self):
"""
Deprecated: Please use layout.yaxis.title.font instead. Sets
this axis' title font. Note that the title's font used to be
customized by the now deprecated `titlefont` attribute.
The 'font' property is an instance of Font
that may be specified... | [
"def",
"titlefont",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"titlefont\"",
"]"
] | [
2054,
4
] | [
2093,
32
] | python | en | ['en', 'error', 'th'] | False |
type | (self) |
Sets the axis type. By default, plotly attempts to determined
the axis type by looking into the data of the traces that
referenced the axis in question.
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
... |
Sets the axis type. By default, plotly attempts to determined
the axis type by looking into the data of the traces that
referenced the axis in question.
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
... | def type(self):
"""
Sets the axis type. By default, plotly attempts to determined
the axis type by looking into the data of the traces that
referenced the axis in question.
The 'type' property is an enumeration that may be specified as:
- One of the following enume... | [
"def",
"type",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"type\"",
"]"
] | [
2102,
4
] | [
2117,
27
] | python | en | ['en', 'error', 'th'] | False |
uirevision | (self) |
Controls persistence of user-driven changes in axis `range`,
`autorange`, and `title` if in `editable: true` configuration.
Defaults to `layout.uirevision`.
The 'uirevision' property accepts values of any type
Returns
-------
Any
|
Controls persistence of user-driven changes in axis `range`,
`autorange`, and `title` if in `editable: true` configuration.
Defaults to `layout.uirevision`.
The 'uirevision' property accepts values of any type | def uirevision(self):
"""
Controls persistence of user-driven changes in axis `range`,
`autorange`, and `title` if in `editable: true` configuration.
Defaults to `layout.uirevision`.
The 'uirevision' property accepts values of any type
Returns
-------
... | [
"def",
"uirevision",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"uirevision\"",
"]"
] | [
2126,
4
] | [
2138,
33
] | python | en | ['en', 'error', 'th'] | False |
visible | (self) |
A single toggle to hide the axis while preserving interaction
like dragging. Default is true when a cheater plot is present
on the axis, otherwise false
The 'visible' property must be specified as a bool
(either True, or False)
Returns
-------
bool
... |
A single toggle to hide the axis while preserving interaction
like dragging. Default is true when a cheater plot is present
on the axis, otherwise false
The 'visible' property must be specified as a bool
(either True, or False) | def visible(self):
"""
A single toggle to hide the axis while preserving interaction
like dragging. Default is true when a cheater plot is present
on the axis, otherwise false
The 'visible' property must be specified as a bool
(either True, or False)
Returns... | [
"def",
"visible",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"visible\"",
"]"
] | [
2147,
4
] | [
2160,
30
] | python | en | ['en', 'error', 'th'] | False |
zeroline | (self) |
Determines whether or not a line is drawn at along the 0 value
of this axis. If True, the zero line is drawn on top of the
grid lines.
The 'zeroline' property must be specified as a bool
(either True, or False)
Returns
-------
bool
|
Determines whether or not a line is drawn at along the 0 value
of this axis. If True, the zero line is drawn on top of the
grid lines.
The 'zeroline' property must be specified as a bool
(either True, or False) | def zeroline(self):
"""
Determines whether or not a line is drawn at along the 0 value
of this axis. If True, the zero line is drawn on top of the
grid lines.
The 'zeroline' property must be specified as a bool
(either True, or False)
Returns
-------... | [
"def",
"zeroline",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"zeroline\"",
"]"
] | [
2169,
4
] | [
2182,
31
] | python | en | ['en', 'error', 'th'] | False |
zerolinecolor | (self) |
Sets the line color of the zero line.
The 'zerolinecolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
- An hsv/hsva string (e.g. 'hsv(0,... |
Sets the line color of the zero line.
The 'zerolinecolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
- An hsv/hsva string (e.g. 'hsv(0,... | def zerolinecolor(self):
"""
Sets the line color of the zero line.
The 'zerolinecolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
... | [
"def",
"zerolinecolor",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"zerolinecolor\"",
"]"
] | [
2191,
4
] | [
2241,
36
] | python | en | ['en', 'error', 'th'] | False |
zerolinewidth | (self) |
Sets the width (in px) of the zero line.
The 'zerolinewidth' property is a number and may be specified as:
- An int or float
Returns
-------
int|float
|
Sets the width (in px) of the zero line.
The 'zerolinewidth' property is a number and may be specified as:
- An int or float | def zerolinewidth(self):
"""
Sets the width (in px) of the zero line.
The 'zerolinewidth' property is a number and may be specified as:
- An int or float
Returns
-------
int|float
"""
return self["zerolinewidth"] | [
"def",
"zerolinewidth",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"zerolinewidth\"",
"]"
] | [
2250,
4
] | [
2261,
36
] | python | en | ['en', 'error', 'th'] | False |
delayed_import | () |
Helper method for delayed import of all needed entities.
|
Helper method for delayed import of all needed entities. | def delayed_import():
"""
Helper method for delayed import of all needed entities.
"""
global _ServerSession, _AccountDB, _ServerConfig, _ScriptDB
if not _ServerSession:
# we allow optional arbitrary serversession class for overloading
modulename, classname = settings.SERVER_SESSION... | [
"def",
"delayed_import",
"(",
")",
":",
"global",
"_ServerSession",
",",
"_AccountDB",
",",
"_ServerConfig",
",",
"_ScriptDB",
"if",
"not",
"_ServerSession",
":",
"# we allow optional arbitrary serversession class for overloading",
"modulename",
",",
"classname",
"=",
"se... | [
85,
0
] | [
105,
21
] | python | en | ['en', 'error', 'th'] | False |
SessionHandler.__getitem__ | (self, key) | Clean out None-sessions automatically. | Clean out None-sessions automatically. | def __getitem__(self, key):
"Clean out None-sessions automatically."
if None in self:
del self[None]
return super(SessionHandler, self).__getitem__(key) | [
"def",
"__getitem__",
"(",
"self",
",",
"key",
")",
":",
"if",
"None",
"in",
"self",
":",
"del",
"self",
"[",
"None",
"]",
"return",
"super",
"(",
"SessionHandler",
",",
"self",
")",
".",
"__getitem__",
"(",
"key",
")"
] | [
118,
4
] | [
122,
59
] | python | en | ['en', 'en', 'en'] | True |
SessionHandler.get | (self, key, default=None) | Clean out None-sessions automatically. | Clean out None-sessions automatically. | def get(self, key, default=None):
"Clean out None-sessions automatically."
if None in self:
del self[None]
return super(SessionHandler, self).get(key, default) | [
"def",
"get",
"(",
"self",
",",
"key",
",",
"default",
"=",
"None",
")",
":",
"if",
"None",
"in",
"self",
":",
"del",
"self",
"[",
"None",
"]",
"return",
"super",
"(",
"SessionHandler",
",",
"self",
")",
".",
"get",
"(",
"key",
",",
"default",
")... | [
124,
4
] | [
128,
60
] | python | en | ['en', 'en', 'en'] | True |
SessionHandler.__setitem__ | (self, key, value) | Don't assign None sessions | Don't assign None sessions | def __setitem__(self, key, value):
"Don't assign None sessions"
if key is not None:
super(SessionHandler, self).__setitem__(key, value) | [
"def",
"__setitem__",
"(",
"self",
",",
"key",
",",
"value",
")",
":",
"if",
"key",
"is",
"not",
"None",
":",
"super",
"(",
"SessionHandler",
",",
"self",
")",
".",
"__setitem__",
"(",
"key",
",",
"value",
")"
] | [
130,
4
] | [
133,
63
] | python | en | ['en', 'en', 'en'] | True |
SessionHandler.__contains__ | (self, key) | None-keys are not accepted. | None-keys are not accepted. | def __contains__(self, key):
"None-keys are not accepted."
return False if key is None else super(SessionHandler, self).__contains__(key) | [
"def",
"__contains__",
"(",
"self",
",",
"key",
")",
":",
"return",
"False",
"if",
"key",
"is",
"None",
"else",
"super",
"(",
"SessionHandler",
",",
"self",
")",
".",
"__contains__",
"(",
"key",
")"
] | [
135,
4
] | [
137,
86
] | python | en | ['en', 'en', 'en'] | True |
SessionHandler.get_sessions | (self, include_unloggedin=False) |
Returns the connected session objects.
Args:
include_unloggedin (bool, optional): Also list Sessions
that have not yet authenticated.
Returns:
sessions (list): A list of `Session` objects.
|
Returns the connected session objects. | def get_sessions(self, include_unloggedin=False):
"""
Returns the connected session objects.
Args:
include_unloggedin (bool, optional): Also list Sessions
that have not yet authenticated.
Returns:
sessions (list): A list of `Session` objects.
... | [
"def",
"get_sessions",
"(",
"self",
",",
"include_unloggedin",
"=",
"False",
")",
":",
"if",
"include_unloggedin",
":",
"return",
"listvalues",
"(",
"self",
")",
"else",
":",
"return",
"[",
"session",
"for",
"session",
"in",
"self",
".",
"values",
"(",
")"... | [
139,
4
] | [
154,
78
] | python | en | ['en', 'error', 'th'] | False |
SessionHandler.get_all_sync_data | (self) |
Create a dictionary of sessdata dicts representing all
sessions in store.
Returns:
syncdata (dict): A dict of sync data.
|
Create a dictionary of sessdata dicts representing all
sessions in store. | def get_all_sync_data(self):
"""
Create a dictionary of sessdata dicts representing all
sessions in store.
Returns:
syncdata (dict): A dict of sync data.
"""
return dict((sessid, sess.get_sync_data()) for sessid, sess in self.items()) | [
"def",
"get_all_sync_data",
"(",
"self",
")",
":",
"return",
"dict",
"(",
"(",
"sessid",
",",
"sess",
".",
"get_sync_data",
"(",
")",
")",
"for",
"sessid",
",",
"sess",
"in",
"self",
".",
"items",
"(",
")",
")"
] | [
156,
4
] | [
165,
84
] | python | en | ['en', 'error', 'th'] | False |
SessionHandler.clean_senddata | (self, session, kwargs) |
Clean up data for sending across the AMP wire. Also apply INLINEFUNCS.
Args:
session (Session): The relevant session instance.
kwargs (dict) Each keyword represents a
send-instruction, with the keyword itself being the name
of the instruction (li... |
Clean up data for sending across the AMP wire. Also apply INLINEFUNCS. | def clean_senddata(self, session, kwargs):
"""
Clean up data for sending across the AMP wire. Also apply INLINEFUNCS.
Args:
session (Session): The relevant session instance.
kwargs (dict) Each keyword represents a
send-instruction, with the keyword itself... | [
"def",
"clean_senddata",
"(",
"self",
",",
"session",
",",
"kwargs",
")",
":",
"options",
"=",
"kwargs",
".",
"pop",
"(",
"\"options\"",
",",
"None",
")",
"or",
"{",
"}",
"raw",
"=",
"options",
".",
"get",
"(",
"\"raw\"",
",",
"False",
")",
"strip_in... | [
167,
4
] | [
252,
22
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.__init__ | (self, *args, **kwargs) |
Init the handler.
|
Init the handler. | def __init__(self, *args, **kwargs):
"""
Init the handler.
"""
super(ServerSessionHandler, self).__init__(*args, **kwargs)
self.server = None # set at server initialization
self.server_data = {"servername": _SERVERNAME} | [
"def",
"__init__",
"(",
"self",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"super",
"(",
"ServerSessionHandler",
",",
"self",
")",
".",
"__init__",
"(",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
"self",
".",
"server",
"=",
"None",
"# set... | [
274,
4
] | [
281,
54
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler._run_cmd_login | (self, session) |
Launch the CMD_LOGINSTART command. This is wrapped
for delays.
|
Launch the CMD_LOGINSTART command. This is wrapped
for delays. | def _run_cmd_login(self, session):
"""
Launch the CMD_LOGINSTART command. This is wrapped
for delays.
"""
if not session.logged_in:
self.data_in(session, text=[[CMD_LOGINSTART], {}]) | [
"def",
"_run_cmd_login",
"(",
"self",
",",
"session",
")",
":",
"if",
"not",
"session",
".",
"logged_in",
":",
"self",
".",
"data_in",
"(",
"session",
",",
"text",
"=",
"[",
"[",
"CMD_LOGINSTART",
"]",
",",
"{",
"}",
"]",
")"
] | [
283,
4
] | [
290,
62
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.portal_connect | (self, portalsessiondata) |
Called by Portal when a new session has connected.
Creates a new, unlogged-in game session.
Args:
portalsessiondata (dict): a dictionary of all property:value
keys defining the session and which is marked to be
synced.
|
Called by Portal when a new session has connected.
Creates a new, unlogged-in game session. | def portal_connect(self, portalsessiondata):
"""
Called by Portal when a new session has connected.
Creates a new, unlogged-in game session.
Args:
portalsessiondata (dict): a dictionary of all property:value
keys defining the session and which is marked to be... | [
"def",
"portal_connect",
"(",
"self",
",",
"portalsessiondata",
")",
":",
"delayed_import",
"(",
")",
"global",
"_ServerSession",
",",
"_AccountDB",
",",
"_ScriptDB",
"sess",
"=",
"_ServerSession",
"(",
")",
"sess",
".",
"sessionhandler",
"=",
"self",
"sess",
... | [
292,
4
] | [
329,
63
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.portal_session_sync | (self, portalsessiondata) |
Called by Portal when it wants to update a single session (e.g.
because of all negotiation protocols have finally replied)
Args:
portalsessiondata (dict): a dictionary of all property:value
keys defining the session and which is marked to be
synced.
... |
Called by Portal when it wants to update a single session (e.g.
because of all negotiation protocols have finally replied) | def portal_session_sync(self, portalsessiondata):
"""
Called by Portal when it wants to update a single session (e.g.
because of all negotiation protocols have finally replied)
Args:
portalsessiondata (dict): a dictionary of all property:value
keys defining t... | [
"def",
"portal_session_sync",
"(",
"self",
",",
"portalsessiondata",
")",
":",
"sessid",
"=",
"portalsessiondata",
".",
"get",
"(",
"\"sessid\"",
")",
"session",
"=",
"self",
".",
"get",
"(",
"sessid",
")",
"if",
"session",
":",
"# since some of the session prop... | [
331,
4
] | [
350,
53
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.portal_sessions_sync | (self, portalsessionsdata) |
Syncing all session ids of the portal with the ones of the
server. This is instantiated by the portal when reconnecting.
Args:
portalsessionsdata (dict): A dictionary
`{sessid: {property:value},...}` defining each session and
the properties in it which s... |
Syncing all session ids of the portal with the ones of the
server. This is instantiated by the portal when reconnecting. | def portal_sessions_sync(self, portalsessionsdata):
"""
Syncing all session ids of the portal with the ones of the
server. This is instantiated by the portal when reconnecting.
Args:
portalsessionsdata (dict): A dictionary
`{sessid: {property:value},...}` defin... | [
"def",
"portal_sessions_sync",
"(",
"self",
",",
"portalsessionsdata",
")",
":",
"delayed_import",
"(",
")",
"global",
"_ServerSession",
",",
"_AccountDB",
",",
"_ServerConfig",
",",
"_ScriptDB",
"for",
"sess",
"in",
"self",
".",
"values",
"(",
")",
":",
"# we... | [
352,
4
] | [
385,
54
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.portal_disconnect | (self, session) |
Called from Portal when Portal session closed from the portal
side. There is no message to report in this case.
Args:
session (Session): The Session to disconnect
|
Called from Portal when Portal session closed from the portal
side. There is no message to report in this case. | def portal_disconnect(self, session):
"""
Called from Portal when Portal session closed from the portal
side. There is no message to report in this case.
Args:
session (Session): The Session to disconnect
"""
# disconnect us without calling Portal since
... | [
"def",
"portal_disconnect",
"(",
"self",
",",
"session",
")",
":",
"# disconnect us without calling Portal since",
"# Portal already knows.",
"self",
".",
"disconnect",
"(",
"session",
",",
"reason",
"=",
"\"\"",
",",
"sync_portal",
"=",
"False",
")"
] | [
387,
4
] | [
398,
62
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.portal_disconnect_all | (self) |
Called from Portal when Portal is closing down. All
Sessions should die. The Portal should not be informed.
|
Called from Portal when Portal is closing down. All
Sessions should die. The Portal should not be informed. | def portal_disconnect_all(self):
"""
Called from Portal when Portal is closing down. All
Sessions should die. The Portal should not be informed.
"""
# set a watchdog to avoid self.disconnect from deleting
# the session while we are looping over them
self._disconn... | [
"def",
"portal_disconnect_all",
"(",
"self",
")",
":",
"# set a watchdog to avoid self.disconnect from deleting",
"# the session while we are looping over them",
"self",
".",
"_disconnect_all",
"=",
"True",
"for",
"session",
"in",
"self",
".",
"values",
":",
"session",
".",... | [
400,
4
] | [
411,
32
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.start_bot_session | (self, protocol_path, configdict) |
This method allows the server-side to force the Portal to
create a new bot session.
Args:
protocol_path (str): The full python path to the bot's
class.
configdict (dict): This dict will be used to configure
the bot (this depends on the b... |
This method allows the server-side to force the Portal to
create a new bot session. | def start_bot_session(self, protocol_path, configdict):
"""
This method allows the server-side to force the Portal to
create a new bot session.
Args:
protocol_path (str): The full python path to the bot's
class.
configdict (dict): This dict will ... | [
"def",
"start_bot_session",
"(",
"self",
",",
"protocol_path",
",",
"configdict",
")",
":",
"self",
".",
"server",
".",
"amp_protocol",
".",
"send_AdminServer2Portal",
"(",
"DUMMYSESSION",
",",
"operation",
"=",
"SCONN",
",",
"protocol_path",
"=",
"protocol_path",... | [
415,
4
] | [
439,
104
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.portal_restart_server | (self) |
Called by server when reloading. We tell the portal to start a new server instance.
|
Called by server when reloading. We tell the portal to start a new server instance. | def portal_restart_server(self):
"""
Called by server when reloading. We tell the portal to start a new server instance.
"""
self.server.amp_protocol.send_AdminServer2Portal(DUMMYSESSION, operation=SRELOAD) | [
"def",
"portal_restart_server",
"(",
"self",
")",
":",
"self",
".",
"server",
".",
"amp_protocol",
".",
"send_AdminServer2Portal",
"(",
"DUMMYSESSION",
",",
"operation",
"=",
"SRELOAD",
")"
] | [
441,
4
] | [
446,
89
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.portal_reset_server | (self) |
Called by server when reloading. We tell the portal to start a new server instance.
|
Called by server when reloading. We tell the portal to start a new server instance. | def portal_reset_server(self):
"""
Called by server when reloading. We tell the portal to start a new server instance.
"""
self.server.amp_protocol.send_AdminServer2Portal(DUMMYSESSION, operation=SRESET) | [
"def",
"portal_reset_server",
"(",
"self",
")",
":",
"self",
".",
"server",
".",
"amp_protocol",
".",
"send_AdminServer2Portal",
"(",
"DUMMYSESSION",
",",
"operation",
"=",
"SRESET",
")"
] | [
448,
4
] | [
453,
88
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.portal_shutdown | (self) |
Called by server when it's time to shut down (the portal will shut us down and then shut
itself down)
|
Called by server when it's time to shut down (the portal will shut us down and then shut
itself down) | def portal_shutdown(self):
"""
Called by server when it's time to shut down (the portal will shut us down and then shut
itself down)
"""
self.server.amp_protocol.send_AdminServer2Portal(DUMMYSESSION,
operation=PSHUTD) | [
"def",
"portal_shutdown",
"(",
"self",
")",
":",
"self",
".",
"server",
".",
"amp_protocol",
".",
"send_AdminServer2Portal",
"(",
"DUMMYSESSION",
",",
"operation",
"=",
"PSHUTD",
")"
] | [
455,
4
] | [
462,
74
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.login | (self, session, account, force=False, testmode=False) |
Log in the previously unloggedin session and the account we by
now should know is connected to it. After this point we assume
the session to be logged in one way or another.
Args:
session (Session): The Session to authenticate.
account (Account): The Account ide... |
Log in the previously unloggedin session and the account we by
now should know is connected to it. After this point we assume
the session to be logged in one way or another. | def login(self, session, account, force=False, testmode=False):
"""
Log in the previously unloggedin session and the account we by
now should know is connected to it. After this point we assume
the session to be logged in one way or another.
Args:
session (Session): ... | [
"def",
"login",
"(",
"self",
",",
"session",
",",
"account",
",",
"force",
"=",
"False",
",",
"testmode",
"=",
"False",
")",
":",
"if",
"session",
".",
"logged_in",
"and",
"not",
"force",
":",
"# don't log in a session that is already logged in.",
"return",
"a... | [
464,
4
] | [
514,
46
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.disconnect | (self, session, reason="", sync_portal=True) |
Called from server side to remove session and inform portal
of this fact.
Args:
session (Session): The Session to disconnect.
reason (str, optional): A motivation for the disconnect.
sync_portal (bool, optional): Sync the disconnect to
Portal... |
Called from server side to remove session and inform portal
of this fact. | def disconnect(self, session, reason="", sync_portal=True):
"""
Called from server side to remove session and inform portal
of this fact.
Args:
session (Session): The Session to disconnect.
reason (str, optional): A motivation for the disconnect.
sync... | [
"def",
"disconnect",
"(",
"self",
",",
"session",
",",
"reason",
"=",
"\"\"",
",",
"sync_portal",
"=",
"True",
")",
":",
"session",
"=",
"self",
".",
"get",
"(",
"session",
".",
"sessid",
")",
"if",
"not",
"session",
":",
"return",
"if",
"hasattr",
"... | [
516,
4
] | [
549,
75
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.all_sessions_portal_sync | (self) |
This is called by the server when it reboots. It syncs all session data
to the portal. Returns a deferred!
|
This is called by the server when it reboots. It syncs all session data
to the portal. Returns a deferred! | def all_sessions_portal_sync(self):
"""
This is called by the server when it reboots. It syncs all session data
to the portal. Returns a deferred!
"""
sessdata = self.get_all_sync_data()
return self.server.amp_protocol.send_AdminServer2Portal(DUMMYSESSION,
... | [
"def",
"all_sessions_portal_sync",
"(",
"self",
")",
":",
"sessdata",
"=",
"self",
".",
"get_all_sync_data",
"(",
")",
"return",
"self",
".",
"server",
".",
"amp_protocol",
".",
"send_AdminServer2Portal",
"(",
"DUMMYSESSION",
",",
"operation",
"=",
"SSYNC",
",",... | [
551,
4
] | [
560,
85
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.session_portal_sync | (self, session) |
This is called by the server when it wants to sync a single session
with the Portal for whatever reason. Returns a deferred!
|
This is called by the server when it wants to sync a single session
with the Portal for whatever reason. Returns a deferred! | def session_portal_sync(self, session):
"""
This is called by the server when it wants to sync a single session
with the Portal for whatever reason. Returns a deferred!
"""
sessdata = {session.sessid: session.get_sync_data()}
return self.server.amp_protocol.send_AdminSer... | [
"def",
"session_portal_sync",
"(",
"self",
",",
"session",
")",
":",
"sessdata",
"=",
"{",
"session",
".",
"sessid",
":",
"session",
".",
"get_sync_data",
"(",
")",
"}",
"return",
"self",
".",
"server",
".",
"amp_protocol",
".",
"send_AdminServer2Portal",
"(... | [
562,
4
] | [
572,
76
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.session_portal_partial_sync | (self, session_data) |
Call to make a partial update of the session, such as only a particular property.
Args:
session_data (dict): Store `{sessid: {property:value}, ...}` defining one or
more sessions in detail.
|
Call to make a partial update of the session, such as only a particular property. | def session_portal_partial_sync(self, session_data):
"""
Call to make a partial update of the session, such as only a particular property.
Args:
session_data (dict): Store `{sessid: {property:value}, ...}` defining one or
more sessions in detail.
"""
... | [
"def",
"session_portal_partial_sync",
"(",
"self",
",",
"session_data",
")",
":",
"return",
"self",
".",
"server",
".",
"amp_protocol",
".",
"send_AdminServer2Portal",
"(",
"DUMMYSESSION",
",",
"operation",
"=",
"SSYNC",
",",
"sessiondata",
"=",
"session_data",
",... | [
574,
4
] | [
586,
76
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.disconnect_all_sessions | (self, reason="You have been disconnected.") |
Cleanly disconnect all of the connected sessions.
Args:
reason (str, optional): The reason for the disconnection.
|
Cleanly disconnect all of the connected sessions. | def disconnect_all_sessions(self, reason="You have been disconnected."):
"""
Cleanly disconnect all of the connected sessions.
Args:
reason (str, optional): The reason for the disconnection.
"""
for session in self:
del session
# tell portal to ... | [
"def",
"disconnect_all_sessions",
"(",
"self",
",",
"reason",
"=",
"\"You have been disconnected.\"",
")",
":",
"for",
"session",
"in",
"self",
":",
"del",
"session",
"# tell portal to disconnect all sessions",
"self",
".",
"server",
".",
"amp_protocol",
".",
"send_Ad... | [
588,
4
] | [
602,
71
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.disconnect_duplicate_sessions | (self, curr_session,
reason=_("Logged in from elsewhere. Disconnecting.")) |
Disconnects any existing sessions with the same user.
args:
curr_session (Session): Disconnect all Sessions matching this one.
reason (str, optional): A motivation for disconnecting.
|
Disconnects any existing sessions with the same user. | def disconnect_duplicate_sessions(self, curr_session,
reason=_("Logged in from elsewhere. Disconnecting.")):
"""
Disconnects any existing sessions with the same user.
args:
curr_session (Session): Disconnect all Sessions matching this one.
... | [
"def",
"disconnect_duplicate_sessions",
"(",
"self",
",",
"curr_session",
",",
"reason",
"=",
"_",
"(",
"\"Logged in from elsewhere. Disconnecting.\"",
")",
")",
":",
"uid",
"=",
"curr_session",
".",
"uid",
"# we can't compare sessions directly since this will compare address... | [
604,
4
] | [
624,
44
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.validate_sessions | (self) |
Check all currently connected sessions (logged in and not) and
see if any are dead or idle.
|
Check all currently connected sessions (logged in and not) and
see if any are dead or idle. | def validate_sessions(self):
"""
Check all currently connected sessions (logged in and not) and
see if any are dead or idle.
"""
tcurr = time.time()
reason = _("Idle timeout exceeded, disconnecting.")
for session in (session for session in self.values()
... | [
"def",
"validate_sessions",
"(",
"self",
")",
":",
"tcurr",
"=",
"time",
".",
"time",
"(",
")",
"reason",
"=",
"_",
"(",
"\"Idle timeout exceeded, disconnecting.\"",
")",
"for",
"session",
"in",
"(",
"session",
"for",
"session",
"in",
"self",
".",
"values",
... | [
626,
4
] | [
637,
51
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.account_count | (self) |
Get the number of connected accounts (not sessions since a
account may have more than one session depending on settings).
Only logged-in accounts are counted here.
Returns:
naccount (int): Number of connected accounts
|
Get the number of connected accounts (not sessions since a
account may have more than one session depending on settings).
Only logged-in accounts are counted here. | def account_count(self):
"""
Get the number of connected accounts (not sessions since a
account may have more than one session depending on settings).
Only logged-in accounts are counted here.
Returns:
naccount (int): Number of connected accounts
"""
... | [
"def",
"account_count",
"(",
"self",
")",
":",
"return",
"len",
"(",
"set",
"(",
"session",
".",
"uid",
"for",
"session",
"in",
"self",
".",
"values",
"(",
")",
"if",
"session",
".",
"logged_in",
")",
")"
] | [
639,
4
] | [
649,
86
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.all_connected_accounts | (self) |
Get a unique list of connected and logged-in Accounts.
Returns:
accounts (list): All conected Accounts (which may be fewer than the
amount of Sessions due to multi-playing).
|
Get a unique list of connected and logged-in Accounts. | def all_connected_accounts(self):
"""
Get a unique list of connected and logged-in Accounts.
Returns:
accounts (list): All conected Accounts (which may be fewer than the
amount of Sessions due to multi-playing).
"""
return list(set(session.account fo... | [
"def",
"all_connected_accounts",
"(",
"self",
")",
":",
"return",
"list",
"(",
"set",
"(",
"session",
".",
"account",
"for",
"session",
"in",
"self",
".",
"values",
"(",
")",
"if",
"session",
".",
"logged_in",
"and",
"session",
".",
"account",
")",
")"
] | [
651,
4
] | [
660,
111
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.session_from_sessid | (self, sessid) |
Get session based on sessid, or None if not found
Args:
sessid (int or list): Session id(s).
Return:
sessions (Session or list): Session(s) found. This
is a list if input was a list.
|
Get session based on sessid, or None if not found | def session_from_sessid(self, sessid):
"""
Get session based on sessid, or None if not found
Args:
sessid (int or list): Session id(s).
Return:
sessions (Session or list): Session(s) found. This
is a list if input was a list.
"""
... | [
"def",
"session_from_sessid",
"(",
"self",
",",
"sessid",
")",
":",
"if",
"is_iter",
"(",
"sessid",
")",
":",
"return",
"[",
"self",
".",
"get",
"(",
"sid",
")",
"for",
"sid",
"in",
"sessid",
"if",
"sid",
"in",
"self",
"]",
"return",
"self",
".",
"... | [
662,
4
] | [
676,
31
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.session_from_account | (self, account, sessid) |
Given an account and a session id, return the actual session
object.
Args:
account (Account): The Account to get the Session from.
sessid (int or list): Session id(s).
Returns:
sessions (Session or list): Session(s) found.
|
Given an account and a session id, return the actual session
object. | def session_from_account(self, account, sessid):
"""
Given an account and a session id, return the actual session
object.
Args:
account (Account): The Account to get the Session from.
sessid (int or list): Session id(s).
Returns:
sessions (Se... | [
"def",
"session_from_account",
"(",
"self",
",",
"account",
",",
"sessid",
")",
":",
"sessions",
"=",
"[",
"self",
"[",
"sid",
"]",
"for",
"sid",
"in",
"make_iter",
"(",
"sessid",
")",
"if",
"sid",
"in",
"self",
"and",
"self",
"[",
"sid",
"]",
".",
... | [
678,
4
] | [
693,
62
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.sessions_from_account | (self, account) |
Given an account, return all matching sessions.
Args:
account (Account): Account to get sessions from.
Returns:
sessions (list): All Sessions associated with this account.
|
Given an account, return all matching sessions. | def sessions_from_account(self, account):
"""
Given an account, return all matching sessions.
Args:
account (Account): Account to get sessions from.
Returns:
sessions (list): All Sessions associated with this account.
"""
uid = account.uid
... | [
"def",
"sessions_from_account",
"(",
"self",
",",
"account",
")",
":",
"uid",
"=",
"account",
".",
"uid",
"return",
"[",
"session",
"for",
"session",
"in",
"self",
".",
"values",
"(",
")",
"if",
"session",
".",
"logged_in",
"and",
"session",
".",
"uid",
... | [
695,
4
] | [
707,
97
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.sessions_from_puppet | (self, puppet) |
Given a puppeted object, return all controlling sessions.
Args:
puppet (Object): Object puppeted
Returns.
sessions (Session or list): Can be more than one of Object is controlled by
more than one Session (MULTISESSION_MODE > 1).
|
Given a puppeted object, return all controlling sessions. | def sessions_from_puppet(self, puppet):
"""
Given a puppeted object, return all controlling sessions.
Args:
puppet (Object): Object puppeted
Returns.
sessions (Session or list): Can be more than one of Object is controlled by
more than one Sessio... | [
"def",
"sessions_from_puppet",
"(",
"self",
",",
"puppet",
")",
":",
"sessions",
"=",
"puppet",
".",
"sessid",
".",
"get",
"(",
")",
"return",
"sessions",
"[",
"0",
"]",
"if",
"len",
"(",
"sessions",
")",
"==",
"1",
"else",
"sessions"
] | [
709,
4
] | [
722,
62
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.sessions_from_csessid | (self, csessid) |
Given a cliend identification hash (for session types that offer them) return all sessions with
a matching hash.
Args
csessid (str): The session hash
|
Given a cliend identification hash (for session types that offer them) return all sessions with
a matching hash. | def sessions_from_csessid(self, csessid):
"""
Given a cliend identification hash (for session types that offer them) return all sessions with
a matching hash.
Args
csessid (str): The session hash
"""
return [session for session in self.values()
... | [
"def",
"sessions_from_csessid",
"(",
"self",
",",
"csessid",
")",
":",
"return",
"[",
"session",
"for",
"session",
"in",
"self",
".",
"values",
"(",
")",
"if",
"session",
".",
"csessid",
"and",
"session",
".",
"csessid",
"==",
"csessid",
"]"
] | [
725,
4
] | [
735,
66
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.announce_all | (self, message) |
Send message to all connected sessions
Args:
message (str): Message to send.
|
Send message to all connected sessions | def announce_all(self, message):
"""
Send message to all connected sessions
Args:
message (str): Message to send.
"""
for session in self.values():
self.data_out(session, text=message) | [
"def",
"announce_all",
"(",
"self",
",",
"message",
")",
":",
"for",
"session",
"in",
"self",
".",
"values",
"(",
")",
":",
"self",
".",
"data_out",
"(",
"session",
",",
"text",
"=",
"message",
")"
] | [
737,
4
] | [
746,
48
] | python | en | ['en', 'error', 'th'] | False |
ServerSessionHandler.data_out | (self, session, **kwargs) |
Sending data Server -> Portal
Args:
session (Session): Session to relay to.
text (str, optional): text data to return
Notes:
The outdata will be scrubbed for sending across
the wire here.
|
Sending data Server -> Portal | def data_out(self, session, **kwargs):
"""
Sending data Server -> Portal
Args:
session (Session): Session to relay to.
text (str, optional): text data to return
Notes:
The outdata will be scrubbed for sending across
the wire here.
... | [
"def",
"data_out",
"(",
"self",
",",
"session",
",",
"*",
"*",
"kwargs",
")",
":",
"# clean output for sending",
"kwargs",
"=",
"self",
".",
"clean_senddata",
"(",
"session",
",",
"kwargs",
")",
"# send across AMP",
"self",
".",
"server",
".",
"amp_protocol",
... | [
748,
4
] | [
765,
64
] | python | en | ['en', 'error', 'th'] | False |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.