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
Data.scattercarpet
(self)
The 'scattercarpet' property is a tuple of instances of Scattercarpet that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scattercarpet - A list or tuple of dicts of string/value properties that will be passed to the Scatter...
The 'scattercarpet' property is a tuple of instances of Scattercarpet that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scattercarpet - A list or tuple of dicts of string/value properties that will be passed to the Scatter...
def scattercarpet(self): """ The 'scattercarpet' property is a tuple of instances of Scattercarpet that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scattercarpet - A list or tuple of dicts of string/value properties that ...
[ "def", "scattercarpet", "(", "self", ")", ":", "return", "self", "[", "\"scattercarpet\"", "]" ]
[ 753, 4 ]
[ 767, 36 ]
python
en
['en', 'error', 'th']
False
Data.scattergeo
(self)
The 'scattergeo' property is a tuple of instances of Scattergeo that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scattergeo - A list or tuple of dicts of string/value properties that will be passed to the Scattergeo const...
The 'scattergeo' property is a tuple of instances of Scattergeo that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scattergeo - A list or tuple of dicts of string/value properties that will be passed to the Scattergeo const...
def scattergeo(self): """ The 'scattergeo' property is a tuple of instances of Scattergeo that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scattergeo - A list or tuple of dicts of string/value properties that will ...
[ "def", "scattergeo", "(", "self", ")", ":", "return", "self", "[", "\"scattergeo\"", "]" ]
[ 776, 4 ]
[ 790, 33 ]
python
en
['en', 'error', 'th']
False
Data.scattergl
(self)
The 'scattergl' property is a tuple of instances of Scattergl that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scattergl - A list or tuple of dicts of string/value properties that will be passed to the Scattergl construct...
The 'scattergl' property is a tuple of instances of Scattergl that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scattergl - A list or tuple of dicts of string/value properties that will be passed to the Scattergl construct...
def scattergl(self): """ The 'scattergl' property is a tuple of instances of Scattergl that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scattergl - A list or tuple of dicts of string/value properties that will be p...
[ "def", "scattergl", "(", "self", ")", ":", "return", "self", "[", "\"scattergl\"", "]" ]
[ 799, 4 ]
[ 813, 32 ]
python
en
['en', 'error', 'th']
False
Data.scattermapbox
(self)
The 'scattermapbox' property is a tuple of instances of Scattermapbox that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scattermapbox - A list or tuple of dicts of string/value properties that will be passed to the Scatter...
The 'scattermapbox' property is a tuple of instances of Scattermapbox that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scattermapbox - A list or tuple of dicts of string/value properties that will be passed to the Scatter...
def scattermapbox(self): """ The 'scattermapbox' property is a tuple of instances of Scattermapbox that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scattermapbox - A list or tuple of dicts of string/value properties that ...
[ "def", "scattermapbox", "(", "self", ")", ":", "return", "self", "[", "\"scattermapbox\"", "]" ]
[ 822, 4 ]
[ 836, 36 ]
python
en
['en', 'error', 'th']
False
Data.scatterpolargl
(self)
The 'scatterpolargl' property is a tuple of instances of Scatterpolargl that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scatterpolargl - A list or tuple of dicts of string/value properties that will be passed to the Scat...
The 'scatterpolargl' property is a tuple of instances of Scatterpolargl that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scatterpolargl - A list or tuple of dicts of string/value properties that will be passed to the Scat...
def scatterpolargl(self): """ The 'scatterpolargl' property is a tuple of instances of Scatterpolargl that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scatterpolargl - A list or tuple of dicts of string/value properties that ...
[ "def", "scatterpolargl", "(", "self", ")", ":", "return", "self", "[", "\"scatterpolargl\"", "]" ]
[ 845, 4 ]
[ 859, 37 ]
python
en
['en', 'error', 'th']
False
Data.scatterpolar
(self)
The 'scatterpolar' property is a tuple of instances of Scatterpolar that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scatterpolar - A list or tuple of dicts of string/value properties that will be passed to the Scatterpol...
The 'scatterpolar' property is a tuple of instances of Scatterpolar that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scatterpolar - A list or tuple of dicts of string/value properties that will be passed to the Scatterpol...
def scatterpolar(self): """ The 'scatterpolar' property is a tuple of instances of Scatterpolar that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scatterpolar - A list or tuple of dicts of string/value properties that ...
[ "def", "scatterpolar", "(", "self", ")", ":", "return", "self", "[", "\"scatterpolar\"", "]" ]
[ 868, 4 ]
[ 882, 35 ]
python
en
['en', 'error', 'th']
False
Data.scatter
(self)
The 'scatter' property is a tuple of instances of Scatter that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scatter - A list or tuple of dicts of string/value properties that will be passed to the Scatter constructor ...
The 'scatter' property is a tuple of instances of Scatter that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scatter - A list or tuple of dicts of string/value properties that will be passed to the Scatter constructor ...
def scatter(self): """ The 'scatter' property is a tuple of instances of Scatter that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scatter - A list or tuple of dicts of string/value properties that will be passed to...
[ "def", "scatter", "(", "self", ")", ":", "return", "self", "[", "\"scatter\"", "]" ]
[ 891, 4 ]
[ 905, 30 ]
python
en
['en', 'error', 'th']
False
Data.scatterternary
(self)
The 'scatterternary' property is a tuple of instances of Scatterternary that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scatterternary - A list or tuple of dicts of string/value properties that will be passed to the Scat...
The 'scatterternary' property is a tuple of instances of Scatterternary that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scatterternary - A list or tuple of dicts of string/value properties that will be passed to the Scat...
def scatterternary(self): """ The 'scatterternary' property is a tuple of instances of Scatterternary that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scatterternary - A list or tuple of dicts of string/value properties that ...
[ "def", "scatterternary", "(", "self", ")", ":", "return", "self", "[", "\"scatterternary\"", "]" ]
[ 914, 4 ]
[ 928, 37 ]
python
en
['en', 'error', 'th']
False
Data.splom
(self)
The 'splom' property is a tuple of instances of Splom that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Splom - A list or tuple of dicts of string/value properties that will be passed to the Splom constructor ...
The 'splom' property is a tuple of instances of Splom that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Splom - A list or tuple of dicts of string/value properties that will be passed to the Splom constructor ...
def splom(self): """ The 'splom' property is a tuple of instances of Splom that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Splom - A list or tuple of dicts of string/value properties that will be passed to the Spl...
[ "def", "splom", "(", "self", ")", ":", "return", "self", "[", "\"splom\"", "]" ]
[ 937, 4 ]
[ 951, 28 ]
python
en
['en', 'error', 'th']
False
Data.streamtube
(self)
The 'streamtube' property is a tuple of instances of Streamtube that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Streamtube - A list or tuple of dicts of string/value properties that will be passed to the Streamtube const...
The 'streamtube' property is a tuple of instances of Streamtube that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Streamtube - A list or tuple of dicts of string/value properties that will be passed to the Streamtube const...
def streamtube(self): """ The 'streamtube' property is a tuple of instances of Streamtube that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Streamtube - A list or tuple of dicts of string/value properties that will ...
[ "def", "streamtube", "(", "self", ")", ":", "return", "self", "[", "\"streamtube\"", "]" ]
[ 960, 4 ]
[ 974, 33 ]
python
en
['en', 'error', 'th']
False
Data.sunburst
(self)
The 'sunburst' property is a tuple of instances of Sunburst that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Sunburst - A list or tuple of dicts of string/value properties that will be passed to the Sunburst constructor ...
The 'sunburst' property is a tuple of instances of Sunburst that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Sunburst - A list or tuple of dicts of string/value properties that will be passed to the Sunburst constructor ...
def sunburst(self): """ The 'sunburst' property is a tuple of instances of Sunburst that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Sunburst - A list or tuple of dicts of string/value properties that will be passe...
[ "def", "sunburst", "(", "self", ")", ":", "return", "self", "[", "\"sunburst\"", "]" ]
[ 983, 4 ]
[ 997, 31 ]
python
en
['en', 'error', 'th']
False
Data.surface
(self)
The 'surface' property is a tuple of instances of Surface that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Surface - A list or tuple of dicts of string/value properties that will be passed to the Surface constructor ...
The 'surface' property is a tuple of instances of Surface that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Surface - A list or tuple of dicts of string/value properties that will be passed to the Surface constructor ...
def surface(self): """ The 'surface' property is a tuple of instances of Surface that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Surface - A list or tuple of dicts of string/value properties that will be passed to...
[ "def", "surface", "(", "self", ")", ":", "return", "self", "[", "\"surface\"", "]" ]
[ 1006, 4 ]
[ 1020, 30 ]
python
en
['en', 'error', 'th']
False
Data.table
(self)
The 'table' property is a tuple of instances of Table that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Table - A list or tuple of dicts of string/value properties that will be passed to the Table constructor ...
The 'table' property is a tuple of instances of Table that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Table - A list or tuple of dicts of string/value properties that will be passed to the Table constructor ...
def table(self): """ The 'table' property is a tuple of instances of Table that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Table - A list or tuple of dicts of string/value properties that will be passed to the Tab...
[ "def", "table", "(", "self", ")", ":", "return", "self", "[", "\"table\"", "]" ]
[ 1029, 4 ]
[ 1043, 28 ]
python
en
['en', 'error', 'th']
False
Data.treemap
(self)
The 'treemap' property is a tuple of instances of Treemap that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Treemap - A list or tuple of dicts of string/value properties that will be passed to the Treemap constructor ...
The 'treemap' property is a tuple of instances of Treemap that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Treemap - A list or tuple of dicts of string/value properties that will be passed to the Treemap constructor ...
def treemap(self): """ The 'treemap' property is a tuple of instances of Treemap that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Treemap - A list or tuple of dicts of string/value properties that will be passed to...
[ "def", "treemap", "(", "self", ")", ":", "return", "self", "[", "\"treemap\"", "]" ]
[ 1052, 4 ]
[ 1066, 30 ]
python
en
['en', 'error', 'th']
False
Data.violin
(self)
The 'violin' property is a tuple of instances of Violin that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Violin - A list or tuple of dicts of string/value properties that will be passed to the Violin constructor ...
The 'violin' property is a tuple of instances of Violin that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Violin - A list or tuple of dicts of string/value properties that will be passed to the Violin constructor ...
def violin(self): """ The 'violin' property is a tuple of instances of Violin that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Violin - A list or tuple of dicts of string/value properties that will be passed to the...
[ "def", "violin", "(", "self", ")", ":", "return", "self", "[", "\"violin\"", "]" ]
[ 1075, 4 ]
[ 1089, 29 ]
python
en
['en', 'error', 'th']
False
Data.volume
(self)
The 'volume' property is a tuple of instances of Volume that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Volume - A list or tuple of dicts of string/value properties that will be passed to the Volume constructor ...
The 'volume' property is a tuple of instances of Volume that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Volume - A list or tuple of dicts of string/value properties that will be passed to the Volume constructor ...
def volume(self): """ The 'volume' property is a tuple of instances of Volume that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Volume - A list or tuple of dicts of string/value properties that will be passed to the...
[ "def", "volume", "(", "self", ")", ":", "return", "self", "[", "\"volume\"", "]" ]
[ 1098, 4 ]
[ 1112, 29 ]
python
en
['en', 'error', 'th']
False
Data.waterfall
(self)
The 'waterfall' property is a tuple of instances of Waterfall that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Waterfall - A list or tuple of dicts of string/value properties that will be passed to the Waterfall construct...
The 'waterfall' property is a tuple of instances of Waterfall that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Waterfall - A list or tuple of dicts of string/value properties that will be passed to the Waterfall construct...
def waterfall(self): """ The 'waterfall' property is a tuple of instances of Waterfall that may be specified as: - A list or tuple of instances of plotly.graph_objs.layout.template.data.Waterfall - A list or tuple of dicts of string/value properties that will be p...
[ "def", "waterfall", "(", "self", ")", ":", "return", "self", "[", "\"waterfall\"", "]" ]
[ 1121, 4 ]
[ 1135, 32 ]
python
en
['en', 'error', 'th']
False
Data.__init__
( self, arg=None, area=None, barpolar=None, bar=None, box=None, candlestick=None, carpet=None, choroplethmapbox=None, choropleth=None, cone=None, contourcarpet=None, contour=None, densitymapbox=None, ...
Construct a new Data object Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.layout.template.Data` area A tuple of :class:`plotly.graph_objects.Area`...
Construct a new Data object Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.layout.template.Data` area A tuple of :class:`plotly.graph_objects.Area`...
def __init__( self, arg=None, area=None, barpolar=None, bar=None, box=None, candlestick=None, carpet=None, choroplethmapbox=None, choropleth=None, cone=None, contourcarpet=None, contour=None, densitymapbox=No...
[ "def", "__init__", "(", "self", ",", "arg", "=", "None", ",", "area", "=", "None", ",", "barpolar", "=", "None", ",", "bar", "=", "None", ",", "box", "=", "None", ",", "candlestick", "=", "None", ",", "carpet", "=", "None", ",", "choroplethmapbox", ...
[ 1291, 4 ]
[ 1724, 34 ]
python
en
['en', 'error', 'th']
False
ChannelAdmin.subscriptions
(self, obj)
Helper method to get subs from a channel. Args: obj (Channel): The channel to get subs from.
Helper method to get subs from a channel.
def subscriptions(self, obj): """ Helper method to get subs from a channel. Args: obj (Channel): The channel to get subs from. """ return ", ".join([str(sub) for sub in obj.subscriptions.all()])
[ "def", "subscriptions", "(", "self", ",", "obj", ")", ":", "return", "\", \"", ".", "join", "(", "[", "str", "(", "sub", ")", "for", "sub", "in", "obj", ".", "subscriptions", ".", "all", "(", ")", "]", ")" ]
[ 64, 4 ]
[ 72, 71 ]
python
en
['en', 'error', 'th']
False
ChannelAdmin.save_model
(self, request, obj, form, change)
Model-save hook. Args: request (Request): Incoming request. obj (Object): Database object. form (Form): Form instance. change (bool): If this is a change or a new object.
Model-save hook.
def save_model(self, request, obj, form, change): """ Model-save hook. Args: request (Request): Incoming request. obj (Object): Database object. form (Form): Form instance. change (bool): If this is a change or a new object. """ o...
[ "def", "save_model", "(", "self", ",", "request", ",", "obj", ",", "form", ",", "change", ")", ":", "obj", ".", "save", "(", ")", "if", "not", "change", ":", "# adding a new object", "# have to call init with typeclass passed to it", "obj", ".", "set_class_from_...
[ 74, 4 ]
[ 90, 21 ]
python
en
['en', 'error', 'th']
False
PingHandler.handle
(self, context: RequestContext, responder: BaseResponder)
Handle ping message. Args: context: Request context responder: Responder used to reply
Handle ping message.
async def handle(self, context: RequestContext, responder: BaseResponder): """ Handle ping message. Args: context: Request context responder: Responder used to reply """ self._logger.debug(f"PingHandler called with context {context}") assert isin...
[ "async", "def", "handle", "(", "self", ",", "context", ":", "RequestContext", ",", "responder", ":", "BaseResponder", ")", ":", "self", ".", "_logger", ".", "debug", "(", "f\"PingHandler called with context {context}\"", ")", "assert", "isinstance", "(", "context"...
[ 11, 4 ]
[ 49, 13 ]
python
en
['en', 'error', 'th']
False
Beam.__init__
(self, batch_size, beam_size, EOS_ID=3)
Beam class for beam search
Beam class for beam search
def __init__(self, batch_size, beam_size, EOS_ID=3): """Beam class for beam search""" self.batch_size = batch_size self.beam_size = beam_size self.EOS_ID = EOS_ID self.back_pointers = [] # [(B, K)] * sequence_length self.token_ids = [] # [(B, K)] * sequence_length ...
[ "def", "__init__", "(", "self", ",", "batch_size", ",", "beam_size", ",", "EOS_ID", "=", "3", ")", ":", "self", ".", "batch_size", "=", "batch_size", "self", ".", "beam_size", "=", "beam_size", "self", ".", "EOS_ID", "=", "EOS_ID", "self", ".", "back_poi...
[ 9, 4 ]
[ 18, 24 ]
python
en
['en', 'en', 'en']
True
Beam.backtrack
(self)
Backtracks over batch to generate optimal k-sequences back_pointer [B, K] token_id [B, K] attention [B, K, source_L] Returns: prediction ([B, K, max_unroll]) A list of Tensors containing predicted sequence
Backtracks over batch to generate optimal k-sequences
def backtrack(self): """Backtracks over batch to generate optimal k-sequences back_pointer [B, K] token_id [B, K] attention [B, K, source_L] Returns: prediction ([B, K, max_unroll]) A list of Tensors containing predicted sequence """ ...
[ "def", "backtrack", "(", "self", ")", ":", "B", "=", "self", ".", "batch_size", "K", "=", "self", ".", "beam_size", "device", "=", "self", ".", "token_ids", "[", "0", "]", ".", "device", "max_unroll", "=", "len", "(", "self", ".", "back_pointers", ")...
[ 20, 4 ]
[ 86, 32 ]
python
en
['en', 'en', 'en']
True
Histogram2d.autobinx
(self)
Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobinx` is not needed. However, we accept `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace. The 'autobinx' property must be specified as a ...
Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobinx` is not needed. However, we accept `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace. The 'autobinx' property must be specified as a ...
def autobinx(self): """ Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobinx` is not needed. However, we accept `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace. The 'autobinx' p...
[ "def", "autobinx", "(", "self", ")", ":", "return", "self", "[", "\"autobinx\"", "]" ]
[ 72, 4 ]
[ 86, 31 ]
python
en
['en', 'error', 'th']
False
Histogram2d.autobiny
(self)
Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobiny` is not needed. However, we accept `autobiny: true` or `false` and will update `ybins` accordingly before deleting `autobiny` from the trace. The 'autobiny' property must be specified as a ...
Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobiny` is not needed. However, we accept `autobiny: true` or `false` and will update `ybins` accordingly before deleting `autobiny` from the trace. The 'autobiny' property must be specified as a ...
def autobiny(self): """ Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobiny` is not needed. However, we accept `autobiny: true` or `false` and will update `ybins` accordingly before deleting `autobiny` from the trace. The 'autobiny' p...
[ "def", "autobiny", "(", "self", ")", ":", "return", "self", "[", "\"autobiny\"", "]" ]
[ 95, 4 ]
[ 109, 31 ]
python
en
['en', 'error', 'th']
False
Histogram2d.autocolorscale
(self)
Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are a...
Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are a...
def autocolorscale(self): """ Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to wheth...
[ "def", "autocolorscale", "(", "self", ")", ":", "return", "self", "[", "\"autocolorscale\"", "]" ]
[ 118, 4 ]
[ 134, 37 ]
python
en
['en', 'error', 'th']
False
Histogram2d.bingroup
(self)
Set the `xbingroup` and `ybingroup` default prefix For example, setting a `bingroup` of 1 on two histogram2d traces will make them their x-bins and y-bins match separately. The 'bingroup' property is a string and must be specified as: - A string - A number that ...
Set the `xbingroup` and `ybingroup` default prefix For example, setting a `bingroup` of 1 on two histogram2d traces will make them their x-bins and y-bins match separately. The 'bingroup' property is a string and must be specified as: - A string - A number that ...
def bingroup(self): """ Set the `xbingroup` and `ybingroup` default prefix For example, setting a `bingroup` of 1 on two histogram2d traces will make them their x-bins and y-bins match separately. The 'bingroup' property is a string and must be specified as: - A st...
[ "def", "bingroup", "(", "self", ")", ":", "return", "self", "[", "\"bingroup\"", "]" ]
[ 143, 4 ]
[ 157, 31 ]
python
en
['en', 'error', 'th']
False
Histogram2d.coloraxis
(self)
Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be...
Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be...
def coloraxis(self): """ Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note t...
[ "def", "coloraxis", "(", "self", ")", ":", "return", "self", "[", "\"coloraxis\"", "]" ]
[ 166, 4 ]
[ 184, 32 ]
python
en
['en', 'error', 'th']
False
Histogram2d.colorbar
(self)
The 'colorbar' property is an instance of ColorBar that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor Supported dict properties: ...
The 'colorbar' property is an instance of ColorBar that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor Supported dict properties: ...
def colorbar(self): """ The 'colorbar' property is an instance of ColorBar that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.ColorBar` - A dict of string/value properties that will be passed to the ColorBar constructor ...
[ "def", "colorbar", "(", "self", ")", ":", "return", "self", "[", "\"colorbar\"", "]" ]
[ 193, 4 ]
[ 420, 31 ]
python
en
['en', 'error', 'th']
False
Histogram2d.colorscale
(self)
Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255...
Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255...
def colorscale(self): """ Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[...
[ "def", "colorscale", "(", "self", ")", ":", "return", "self", "[", "\"colorscale\"", "]" ]
[ 429, 4 ]
[ 472, 33 ]
python
en
['en', 'error', 'th']
False
Histogram2d.customdata
(self)
Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list,...
Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be specified as a tuple, list,...
def customdata(self): """ Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements The 'customdata' property is an array that may be sp...
[ "def", "customdata", "(", "self", ")", ":", "return", "self", "[", "\"customdata\"", "]" ]
[ 481, 4 ]
[ 495, 33 ]
python
en
['en', 'error', 'th']
False
Histogram2d.customdatasrc
(self)
Sets the source reference on Chart Studio Cloud for customdata . The 'customdatasrc' 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 customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object
def customdatasrc(self): """ Sets the source reference on Chart Studio Cloud for customdata . The 'customdatasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str """ return self["cust...
[ "def", "customdatasrc", "(", "self", ")", ":", "return", "self", "[", "\"customdatasrc\"", "]" ]
[ 504, 4 ]
[ 516, 36 ]
python
en
['en', 'error', 'th']
False
Histogram2d.histfunc
(self)
Specifies the binning function used for this histogram trace. If "count", the histogram values are computed by counting the number of values lying inside each bin. If "sum", "avg", "min", "max", the histogram values are computed using the sum, the average, the minimum or the max...
Specifies the binning function used for this histogram trace. If "count", the histogram values are computed by counting the number of values lying inside each bin. If "sum", "avg", "min", "max", the histogram values are computed using the sum, the average, the minimum or the max...
def histfunc(self): """ Specifies the binning function used for this histogram trace. If "count", the histogram values are computed by counting the number of values lying inside each bin. If "sum", "avg", "min", "max", the histogram values are computed using the sum, the ...
[ "def", "histfunc", "(", "self", ")", ":", "return", "self", "[", "\"histfunc\"", "]" ]
[ 525, 4 ]
[ 542, 31 ]
python
en
['en', 'error', 'th']
False
Histogram2d.histnorm
(self)
Specifies the type of normalization used for this histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar corresponds to the percentage / frac...
Specifies the type of normalization used for this histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar corresponds to the percentage / frac...
def histnorm(self): """ Specifies the type of normalization used for this histogram trace. If "", the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If "percent" / "probability", the span of each bar corre...
[ "def", "histnorm", "(", "self", ")", ":", "return", "self", "[", "\"histnorm\"", "]" ]
[ 551, 4 ]
[ 576, 31 ]
python
en
['en', 'error', 'th']
False
Histogram2d.hoverinfo
(self)
Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: ...
Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified as a string containing: ...
def hoverinfo(self): """ Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. The 'hoverinfo' property is a flaglist and may be specified ...
[ "def", "hoverinfo", "(", "self", ")", ":", "return", "self", "[", "\"hoverinfo\"", "]" ]
[ 585, 4 ]
[ 602, 32 ]
python
en
['en', 'error', 'th']
False
Histogram2d.hoverinfosrc
(self)
Sets the source reference on Chart Studio Cloud for hoverinfo . The 'hoverinfosrc' 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 hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object
def hoverinfosrc(self): """ Sets the source reference on Chart Studio Cloud for hoverinfo . The 'hoverinfosrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str """ return self["hoverin...
[ "def", "hoverinfosrc", "(", "self", ")", ":", "return", "self", "[", "\"hoverinfosrc\"", "]" ]
[ 611, 4 ]
[ 623, 35 ]
python
en
['en', 'error', 'th']
False
Histogram2d.hoverlabel
(self)
The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict prope...
The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict prope...
def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.Hoverlabel` - A dict of string/value properties that will be passed to the Hoverlabel constructor ...
[ "def", "hoverlabel", "(", "self", ")", ":", "return", "self", "[", "\"hoverlabel\"", "]" ]
[ 632, 4 ]
[ 682, 33 ]
python
en
['en', 'error', 'th']
False
Histogram2d.hovertemplate
(self)
Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$...
Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$...
def hovertemplate(self): """ Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d...
[ "def", "hovertemplate", "(", "self", ")", ":", "return", "self", "[", "\"hovertemplate\"", "]" ]
[ 691, 4 ]
[ 723, 36 ]
python
en
['en', 'error', 'th']
False
Histogram2d.hovertemplatesrc
(self)
Sets the source reference on Chart Studio Cloud for hovertemplate . The 'hovertemplatesrc' 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 hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object
def hovertemplatesrc(self): """ Sets the source reference on Chart Studio Cloud for hovertemplate . The 'hovertemplatesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str """ return se...
[ "def", "hovertemplatesrc", "(", "self", ")", ":", "return", "self", "[", "\"hovertemplatesrc\"", "]" ]
[ 732, 4 ]
[ 744, 39 ]
python
en
['en', 'error', 'th']
False
Histogram2d.ids
(self)
Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Retur...
Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pandas Series
def ids(self): """ Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type. The 'ids' property is an array that may be specified as a tuple, list, numpy array, or pa...
[ "def", "ids", "(", "self", ")", ":", "return", "self", "[", "\"ids\"", "]" ]
[ 753, 4 ]
[ 766, 26 ]
python
en
['en', 'error', 'th']
False
Histogram2d.idssrc
(self)
Sets the source reference on Chart Studio Cloud for ids . The 'idssrc' 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 ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object
def idssrc(self): """ Sets the source reference on Chart Studio Cloud for ids . The 'idssrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str """ return self["idssrc"]
[ "def", "idssrc", "(", "self", ")", ":", "return", "self", "[", "\"idssrc\"", "]" ]
[ 775, 4 ]
[ 786, 29 ]
python
en
['en', 'error', 'th']
False
Histogram2d.legendgroup
(self)
Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string R...
Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will be converted to a string
def legendgroup(self): """ Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. The 'legendgroup' property is a string and must be specified as: - A string - A number that will b...
[ "def", "legendgroup", "(", "self", ")", ":", "return", "self", "[", "\"legendgroup\"", "]" ]
[ 795, 4 ]
[ 809, 34 ]
python
en
['en', 'error', 'th']
False
Histogram2d.marker
(self)
The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: ...
The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.Marker` - A dict of string/value properties that will be passed to the Marker constructor Supported dict properties: ...
def marker(self): """ The 'marker' property is an instance of Marker that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.Marker` - A dict of string/value properties that will be passed to the Marker constructor Support...
[ "def", "marker", "(", "self", ")", ":", "return", "self", "[", "\"marker\"", "]" ]
[ 818, 4 ]
[ 838, 29 ]
python
en
['en', 'error', 'th']
False
Histogram2d.meta
(self)
Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To acce...
Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To acce...
def meta(self): """ Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text ...
[ "def", "meta", "(", "self", ")", ":", "return", "self", "[", "\"meta\"", "]" ]
[ 847, 4 ]
[ 866, 27 ]
python
en
['en', 'error', 'th']
False
Histogram2d.metasrc
(self)
Sets the source reference on Chart Studio Cloud for meta . The 'metasrc' 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 meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object
def metasrc(self): """ Sets the source reference on Chart Studio Cloud for meta . The 'metasrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str """ return self["metasrc"]
[ "def", "metasrc", "(", "self", ")", ":", "return", "self", "[", "\"metasrc\"", "]" ]
[ 875, 4 ]
[ 886, 30 ]
python
en
['en', 'error', 'th']
False
Histogram2d.name
(self)
Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str
Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string
def name(self): """ Sets the trace name. The trace name appear as the legend item and on hover. The 'name' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- str ...
[ "def", "name", "(", "self", ")", ":", "return", "self", "[", "\"name\"", "]" ]
[ 895, 4 ]
[ 908, 27 ]
python
en
['en', 'error', 'th']
False
Histogram2d.nbinsx
(self)
Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided. The 'nbinsx' property is a integer and may ...
Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided. The 'nbinsx' property is a integer and may ...
def nbinsx(self): """ Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided. The 'nbinsx' p...
[ "def", "nbinsx", "(", "self", ")", ":", "return", "self", "[", "\"nbinsx\"", "]" ]
[ 917, 4 ]
[ 932, 29 ]
python
en
['en', 'error', 'th']
False
Histogram2d.nbinsy
(self)
Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided. The 'nbinsy' property is a integer and may ...
Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided. The 'nbinsy' property is a integer and may ...
def nbinsy(self): """ Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided. The 'nbinsy' p...
[ "def", "nbinsy", "(", "self", ")", ":", "return", "self", "[", "\"nbinsy\"", "]" ]
[ 941, 4 ]
[ 956, 29 ]
python
en
['en', 'error', 'th']
False
Histogram2d.opacity
(self)
Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float
Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1]
def opacity(self): """ Sets the opacity of the trace. The 'opacity' property is a number and may be specified as: - An int or float in the interval [0, 1] Returns ------- int|float """ return self["opacity"]
[ "def", "opacity", "(", "self", ")", ":", "return", "self", "[", "\"opacity\"", "]" ]
[ 965, 4 ]
[ 976, 30 ]
python
en
['en', 'error', 'th']
False
Histogram2d.reversescale
(self)
Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. The 'reversescale' property must be specified as a bool (either True, or False) Returns ------- bool ...
Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. The 'reversescale' property must be specified as a bool (either True, or False)
def reversescale(self): """ Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color. The 'reversescale' property must be specified as a bool (either True, or False) Retu...
[ "def", "reversescale", "(", "self", ")", ":", "return", "self", "[", "\"reversescale\"", "]" ]
[ 985, 4 ]
[ 998, 35 ]
python
en
['en', 'error', 'th']
False
Histogram2d.showlegend
(self)
Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool
Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False)
def showlegend(self): """ Determines whether or not an item corresponding to this trace is shown in the legend. The 'showlegend' property must be specified as a bool (either True, or False) Returns ------- bool """ return self["showle...
[ "def", "showlegend", "(", "self", ")", ":", "return", "self", "[", "\"showlegend\"", "]" ]
[ 1007, 4 ]
[ 1019, 33 ]
python
en
['en', 'error', 'th']
False
Histogram2d.showscale
(self)
Determines whether or not a colorbar is displayed for this trace. The 'showscale' property must be specified as a bool (either True, or False) Returns ------- bool
Determines whether or not a colorbar is displayed for this trace. The 'showscale' property must be specified as a bool (either True, or False)
def showscale(self): """ Determines whether or not a colorbar is displayed for this trace. The 'showscale' property must be specified as a bool (either True, or False) Returns ------- bool """ return self["showscale"]
[ "def", "showscale", "(", "self", ")", ":", "return", "self", "[", "\"showscale\"", "]" ]
[ 1028, 4 ]
[ 1040, 32 ]
python
en
['en', 'error', 'th']
False
Histogram2d.stream
(self)
The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: ...
The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.Stream` - A dict of string/value properties that will be passed to the Stream constructor Supported dict properties: ...
def stream(self): """ The 'stream' property is an instance of Stream that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.Stream` - A dict of string/value properties that will be passed to the Stream constructor Support...
[ "def", "stream", "(", "self", ")", ":", "return", "self", "[", "\"stream\"", "]" ]
[ 1049, 4 ]
[ 1073, 29 ]
python
en
['en', 'error', 'th']
False
Histogram2d.uid
(self)
Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Returns ------- ...
Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string
def uid(self): """ Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions. The 'uid' property is a string and must be specified as: - A string - A number that will be converted to a string Return...
[ "def", "uid", "(", "self", ")", ":", "return", "self", "[", "\"uid\"", "]" ]
[ 1082, 4 ]
[ 1095, 26 ]
python
en
['en', 'error', 'th']
False
Histogram2d.uirevision
(self)
Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are co...
Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are co...
def uirevision(self): """ Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driv...
[ "def", "uirevision", "(", "self", ")", ":", "return", "self", "[", "\"uirevision\"", "]" ]
[ 1104, 4 ]
[ 1128, 33 ]
python
en
['en', 'error', 'th']
False
Histogram2d.visible
(self)
Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration va...
Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One of the following enumeration va...
def visible(self): """ Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). The 'visible' property is an enumeration that may be specified as: - One o...
[ "def", "visible", "(", "self", ")", ":", "return", "self", "[", "\"visible\"", "]" ]
[ 1137, 4 ]
[ 1151, 30 ]
python
en
['en', 'error', 'th']
False
Histogram2d.x
(self)
Sets the sample data to be binned on the x axis. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray
Sets the sample data to be binned on the x axis. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series
def x(self): """ Sets the sample data to be binned on the x axis. The 'x' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray """ return self["x"]
[ "def", "x", "(", "self", ")", ":", "return", "self", "[", "\"x\"", "]" ]
[ 1160, 4 ]
[ 1171, 24 ]
python
en
['en', 'error', 'th']
False
Histogram2d.xaxis
(self)
Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular ...
Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. The 'xaxis' property is an identifier of a particular ...
def xaxis(self): """ Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on. The 'xaxis' property is an ident...
[ "def", "xaxis", "(", "self", ")", ":", "return", "self", "[", "\"xaxis\"", "]" ]
[ 1180, 4 ]
[ 1196, 28 ]
python
en
['en', 'error', 'th']
False
Histogram2d.xbingroup
(self)
Set a group of histogram traces which will have compatible x-bin settings. Using `xbingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same `xbingroup` value can be used to set (1D) histogram `bi...
Set a group of histogram traces which will have compatible x-bin settings. Using `xbingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same `xbingroup` value can be used to set (1D) histogram `bi...
def xbingroup(self): """ Set a group of histogram traces which will have compatible x-bin settings. Using `xbingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same `xbingroup` value can b...
[ "def", "xbingroup", "(", "self", ")", ":", "return", "self", "[", "\"xbingroup\"", "]" ]
[ 1205, 4 ]
[ 1221, 32 ]
python
en
['en', 'error', 'th']
False
Histogram2d.xbins
(self)
The 'xbins' property is an instance of XBins that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.XBins` - A dict of string/value properties that will be passed to the XBins constructor Supported dict properties: ...
The 'xbins' property is an instance of XBins that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.XBins` - A dict of string/value properties that will be passed to the XBins constructor Supported dict properties: ...
def xbins(self): """ The 'xbins' property is an instance of XBins that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.XBins` - A dict of string/value properties that will be passed to the XBins constructor Supported di...
[ "def", "xbins", "(", "self", ")", ":", "return", "self", "[", "\"xbins\"", "]" ]
[ 1230, 4 ]
[ 1279, 28 ]
python
en
['en', 'error', 'th']
False
Histogram2d.xcalendar
(self)
Sets the calendar system to use with `x` date data. The 'xcalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', ...
Sets the calendar system to use with `x` date data. The 'xcalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', ...
def xcalendar(self): """ Sets the calendar system to use with `x` date data. The 'xcalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian',...
[ "def", "xcalendar", "(", "self", ")", ":", "return", "self", "[", "\"xcalendar\"", "]" ]
[ 1288, 4 ]
[ 1303, 32 ]
python
en
['en', 'error', 'th']
False
Histogram2d.xgap
(self)
Sets the horizontal gap (in pixels) between bricks. The 'xgap' property is a number and may be specified as: - An int or float in the interval [0, inf] Returns ------- int|float
Sets the horizontal gap (in pixels) between bricks. The 'xgap' property is a number and may be specified as: - An int or float in the interval [0, inf]
def xgap(self): """ Sets the horizontal gap (in pixels) between bricks. The 'xgap' property is a number and may be specified as: - An int or float in the interval [0, inf] Returns ------- int|float """ return self["xgap"]
[ "def", "xgap", "(", "self", ")", ":", "return", "self", "[", "\"xgap\"", "]" ]
[ 1312, 4 ]
[ 1323, 27 ]
python
en
['en', 'error', 'th']
False
Histogram2d.xsrc
(self)
Sets the source reference on Chart Studio Cloud for x . The 'xsrc' 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 x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object
def xsrc(self): """ Sets the source reference on Chart Studio Cloud for x . The 'xsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str """ return self["xsrc"]
[ "def", "xsrc", "(", "self", ")", ":", "return", "self", "[", "\"xsrc\"", "]" ]
[ 1332, 4 ]
[ 1343, 27 ]
python
en
['en', 'error', 'th']
False
Histogram2d.y
(self)
Sets the sample data to be binned on the y axis. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray
Sets the sample data to be binned on the y axis. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series
def y(self): """ Sets the sample data to be binned on the y axis. The 'y' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray """ return self["y"]
[ "def", "y", "(", "self", ")", ":", "return", "self", "[", "\"y\"", "]" ]
[ 1352, 4 ]
[ 1363, 24 ]
python
en
['en', 'error', 'th']
False
Histogram2d.yaxis
(self)
Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular ...
Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. The 'yaxis' property is an identifier of a particular ...
def yaxis(self): """ Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on. The 'yaxis' property is an ident...
[ "def", "yaxis", "(", "self", ")", ":", "return", "self", "[", "\"yaxis\"", "]" ]
[ 1372, 4 ]
[ 1388, 28 ]
python
en
['en', 'error', 'th']
False
Histogram2d.ybingroup
(self)
Set a group of histogram traces which will have compatible y-bin settings. Using `ybingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same `ybingroup` value can be used to set (1D) histogram `bi...
Set a group of histogram traces which will have compatible y-bin settings. Using `ybingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same `ybingroup` value can be used to set (1D) histogram `bi...
def ybingroup(self): """ Set a group of histogram traces which will have compatible y-bin settings. Using `ybingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same `ybingroup` value can b...
[ "def", "ybingroup", "(", "self", ")", ":", "return", "self", "[", "\"ybingroup\"", "]" ]
[ 1397, 4 ]
[ 1413, 32 ]
python
en
['en', 'error', 'th']
False
Histogram2d.ybins
(self)
The 'ybins' property is an instance of YBins that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.YBins` - A dict of string/value properties that will be passed to the YBins constructor Supported dict properties: ...
The 'ybins' property is an instance of YBins that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.YBins` - A dict of string/value properties that will be passed to the YBins constructor Supported dict properties: ...
def ybins(self): """ The 'ybins' property is an instance of YBins that may be specified as: - An instance of :class:`plotly.graph_objs.histogram2d.YBins` - A dict of string/value properties that will be passed to the YBins constructor Supported di...
[ "def", "ybins", "(", "self", ")", ":", "return", "self", "[", "\"ybins\"", "]" ]
[ 1422, 4 ]
[ 1471, 28 ]
python
en
['en', 'error', 'th']
False
Histogram2d.ycalendar
(self)
Sets the calendar system to use with `y` date data. The 'ycalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', ...
Sets the calendar system to use with `y` date data. The 'ycalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', 'hebrew', 'islamic', 'julian', ...
def ycalendar(self): """ Sets the calendar system to use with `y` date data. The 'ycalendar' property is an enumeration that may be specified as: - One of the following enumeration values: ['gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian',...
[ "def", "ycalendar", "(", "self", ")", ":", "return", "self", "[", "\"ycalendar\"", "]" ]
[ 1480, 4 ]
[ 1495, 32 ]
python
en
['en', 'error', 'th']
False
Histogram2d.ygap
(self)
Sets the vertical gap (in pixels) between bricks. The 'ygap' property is a number and may be specified as: - An int or float in the interval [0, inf] Returns ------- int|float
Sets the vertical gap (in pixels) between bricks. The 'ygap' property is a number and may be specified as: - An int or float in the interval [0, inf]
def ygap(self): """ Sets the vertical gap (in pixels) between bricks. The 'ygap' property is a number and may be specified as: - An int or float in the interval [0, inf] Returns ------- int|float """ return self["ygap"]
[ "def", "ygap", "(", "self", ")", ":", "return", "self", "[", "\"ygap\"", "]" ]
[ 1504, 4 ]
[ 1515, 27 ]
python
en
['en', 'error', 'th']
False
Histogram2d.ysrc
(self)
Sets the source reference on Chart Studio Cloud for y . The 'ysrc' 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 y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object
def ysrc(self): """ Sets the source reference on Chart Studio Cloud for y . The 'ysrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str """ return self["ysrc"]
[ "def", "ysrc", "(", "self", ")", ":", "return", "self", "[", "\"ysrc\"", "]" ]
[ 1524, 4 ]
[ 1535, 27 ]
python
en
['en', 'error', 'th']
False
Histogram2d.z
(self)
Sets the aggregation data. The 'z' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray
Sets the aggregation data. The 'z' property is an array that may be specified as a tuple, list, numpy array, or pandas Series
def z(self): """ Sets the aggregation data. The 'z' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray """ return self["z"]
[ "def", "z", "(", "self", ")", ":", "return", "self", "[", "\"z\"", "]" ]
[ 1544, 4 ]
[ 1555, 24 ]
python
en
['en', 'error', 'th']
False
Histogram2d.zauto
(self)
Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. The 'zauto' property must be specified as a bool (either True,...
Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. The 'zauto' property must be specified as a bool (either True,...
def zauto(self): """ Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user. The 'zauto' property must be specified as ...
[ "def", "zauto", "(", "self", ")", ":", "return", "self", "[", "\"zauto\"", "]" ]
[ 1564, 4 ]
[ 1578, 28 ]
python
en
['en', 'error', 'th']
False
Histogram2d.zhoverformat
(self)
Sets the hover text formatting rule using d3 formatting mini- languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format The 'zhoverformat' property is a string and must be specified as: ...
Sets the hover text formatting rule using d3 formatting mini- languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format The 'zhoverformat' property is a string and must be specified as: ...
def zhoverformat(self): """ Sets the hover text formatting rule using d3 formatting mini- languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format The 'zhoverformat' property is a string...
[ "def", "zhoverformat", "(", "self", ")", ":", "return", "self", "[", "\"zhoverformat\"", "]" ]
[ 1587, 4 ]
[ 1602, 35 ]
python
en
['en', 'error', 'th']
False
Histogram2d.zmax
(self)
Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. The 'zmax' property is a number and may be specified as: - An int or float Returns ------- int|float
Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. The 'zmax' property is a number and may be specified as: - An int or float
def zmax(self): """ Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well. The 'zmax' property is a number and may be specified as: - An int or float Returns ------- int|float ...
[ "def", "zmax", "(", "self", ")", ":", "return", "self", "[", "\"zmax\"", "]" ]
[ 1611, 4 ]
[ 1623, 27 ]
python
en
['en', 'error', 'th']
False
Histogram2d.zmid
(self)
Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. The 'zmid' property is a number and may be specified as: - An int or float R...
Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. The 'zmid' property is a number and may be specified as: - An int or float
def zmid(self): """ Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`. The 'zmid' property is a number and may be specified as: -...
[ "def", "zmid", "(", "self", ")", ":", "return", "self", "[", "\"zmid\"", "]" ]
[ 1632, 4 ]
[ 1645, 27 ]
python
en
['en', 'error', 'th']
False
Histogram2d.zmin
(self)
Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. The 'zmin' property is a number and may be specified as: - An int or float Returns ------- int|float
Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. The 'zmin' property is a number and may be specified as: - An int or float
def zmin(self): """ Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well. The 'zmin' property is a number and may be specified as: - An int or float Returns ------- int|float ...
[ "def", "zmin", "(", "self", ")", ":", "return", "self", "[", "\"zmin\"", "]" ]
[ 1654, 4 ]
[ 1666, 27 ]
python
en
['en', 'error', 'th']
False
Histogram2d.zsmooth
(self)
Picks a smoothing algorithm use to smooth `z` data. The 'zsmooth' property is an enumeration that may be specified as: - One of the following enumeration values: ['fast', 'best', False] Returns ------- Any
Picks a smoothing algorithm use to smooth `z` data. The 'zsmooth' property is an enumeration that may be specified as: - One of the following enumeration values: ['fast', 'best', False]
def zsmooth(self): """ Picks a smoothing algorithm use to smooth `z` data. The 'zsmooth' property is an enumeration that may be specified as: - One of the following enumeration values: ['fast', 'best', False] Returns ------- Any """...
[ "def", "zsmooth", "(", "self", ")", ":", "return", "self", "[", "\"zsmooth\"", "]" ]
[ 1675, 4 ]
[ 1687, 30 ]
python
en
['en', 'error', 'th']
False
Histogram2d.zsrc
(self)
Sets the source reference on Chart Studio Cloud for z . The 'zsrc' 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 z . The 'zsrc' property must be specified as a string or as a plotly.grid_objs.Column object
def zsrc(self): """ Sets the source reference on Chart Studio Cloud for z . The 'zsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str """ return self["zsrc"]
[ "def", "zsrc", "(", "self", ")", ":", "return", "self", "[", "\"zsrc\"", "]" ]
[ 1696, 4 ]
[ 1707, 27 ]
python
en
['en', 'error', 'th']
False
Histogram2d.__init__
( self, arg=None, autobinx=None, autobiny=None, autocolorscale=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, hoverinfo...
Construct a new Histogram2d object The sample data from which statistics are computed is set in `x` and `y` (where `x` and `y` represent marginal distributions, binning is set in `xbins` and `ybins` in this case) or `z` (where `z` represent the 2D distribution and ...
Construct a new Histogram2d object The sample data from which statistics are computed is set in `x` and `y` (where `x` and `y` represent marginal distributions, binning is set in `xbins` and `ybins` in this case) or `z` (where `z` represent the 2D distribution and ...
def __init__( self, arg=None, autobinx=None, autobiny=None, autocolorscale=None, bingroup=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, histfunc=None, histnorm=None, ...
[ "def", "__init__", "(", "self", ",", "arg", "=", "None", ",", "autobinx", "=", "None", ",", "autobiny", "=", "None", ",", "autocolorscale", "=", "None", ",", "bingroup", "=", "None", ",", "coloraxis", "=", "None", ",", "colorbar", "=", "None", ",", "...
[ 2008, 4 ]
[ 2632, 34 ]
python
en
['en', 'error', 'th']
False
Title.font
(self)
Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute. The 'font' property is an instance of Font that may be specified as: - An instance of :class:`plotly.graph_objs.scattercarpet.marker.colorbar.title.Fon...
Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute. The 'font' property is an instance of Font that may be specified as: - An instance of :class:`plotly.graph_objs.scattercarpet.marker.colorbar.title.Fon...
def font(self): """ Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute. The 'font' property is an instance of Font that may be specified as: - An instance of :class:`plotly.graph_objs.scattercarpe...
[ "def", "font", "(", "self", ")", ":", "return", "self", "[", "\"font\"", "]" ]
[ 15, 4 ]
[ 53, 27 ]
python
en
['en', 'error', 'th']
False
Title.side
(self)
Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute. The 'side' property is an enumeration that may be specified as: - One of the following enumeration values...
Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute. The 'side' property is an enumeration that may be specified as: - One of the following enumeration values...
def side(self): """ Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute. The 'side' property is an enumeration that may be specified as: - One of the f...
[ "def", "side", "(", "self", ")", ":", "return", "self", "[", "\"side\"", "]" ]
[ 62, 4 ]
[ 76, 27 ]
python
en
['en', 'error', 'th']
False
Title.text
(self)
Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated. The 'text' property is a string and must be specified as: - A string - A ...
Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated. The 'text' property is a string and must be specified as: - A string - A ...
def text(self): """ Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated. The 'text' property is a string and must be specified as: ...
[ "def", "text", "(", "self", ")", ":", "return", "self", "[", "\"text\"", "]" ]
[ 85, 4 ]
[ 99, 27 ]
python
en
['en', 'error', 'th']
False
Title.__init__
(self, arg=None, font=None, side=None, text=None, **kwargs)
Construct a new Title object Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.scattercarpet. marker.colorbar.Title` font Sets this color bar's title ...
Construct a new Title object Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.scattercarpet. marker.colorbar.Title` font Sets this color bar's title ...
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): """ Construct a new Title object Parameters ---------- arg dict of properties compatible with this constructor or an instance of :class:`plotly.graph_objs.scattercarpet. ...
[ "def", "__init__", "(", "self", ",", "arg", "=", "None", ",", "font", "=", "None", ",", "side", "=", "None", ",", "text", "=", "None", ",", "*", "*", "kwargs", ")", ":", "super", "(", "Title", ",", "self", ")", ".", "__init__", "(", "\"title\"", ...
[ 126, 4 ]
[ 203, 34 ]
python
en
['en', 'error', 'th']
False
CredentialExchange.__init__
( self, *, credential_exchange_id: str = None, connection_id: str = None, thread_id: str = None, parent_thread_id: str = None, initiator: str = None, state: str = None, credential_definition_id: str = None, schema_id: str = None, cr...
Initialize a new CredentialExchange.
Initialize a new CredentialExchange.
def __init__( self, *, credential_exchange_id: str = None, connection_id: str = None, thread_id: str = None, parent_thread_id: str = None, initiator: str = None, state: str = None, credential_definition_id: str = None, schema_id: str = None...
[ "def", "__init__", "(", "self", ",", "*", ",", "credential_exchange_id", ":", "str", "=", "None", ",", "connection_id", ":", "str", "=", "None", ",", "thread_id", ":", "str", "=", "None", ",", "parent_thread_id", ":", "str", "=", "None", ",", "initiator"...
[ 33, 4 ]
[ 72, 34 ]
python
en
['en', 'en', 'en']
True
CredentialExchange.credential_exchange_id
(self)
Accessor for the ID associated with this exchange.
Accessor for the ID associated with this exchange.
def credential_exchange_id(self) -> str: """Accessor for the ID associated with this exchange.""" return self._id
[ "def", "credential_exchange_id", "(", "self", ")", "->", "str", ":", "return", "self", ".", "_id" ]
[ 75, 4 ]
[ 77, 23 ]
python
en
['en', 'en', 'en']
True
CredentialExchange.record_value
(self)
Accessor to for the JSON record value props for this credential exchange.
Accessor to for the JSON record value props for this credential exchange.
def record_value(self) -> dict: """Accessor to for the JSON record value props for this credential exchange.""" return { prop: getattr(self, prop) for prop in ( "connection_id", "initiator", "credential_offer", "cred...
[ "def", "record_value", "(", "self", ")", "->", "dict", ":", "return", "{", "prop", ":", "getattr", "(", "self", ",", "prop", ")", "for", "prop", "in", "(", "\"connection_id\"", ",", "\"initiator\"", ",", "\"credential_offer\"", ",", "\"credential_request\"", ...
[ 80, 4 ]
[ 101, 9 ]
python
en
['en', 'en', 'en']
True
CredentialExchange.retrieve_by_thread_and_initiator
( cls, context: InjectionContext, thread_id: str, initiator: str )
Retrieve a credential exchange record by thread ID and inititator.
Retrieve a credential exchange record by thread ID and inititator.
async def retrieve_by_thread_and_initiator( cls, context: InjectionContext, thread_id: str, initiator: str ) -> "CredentialExchange": """Retrieve a credential exchange record by thread ID and inititator.""" cache_key = f"credential_exchange_tidx::{thread_id}::{initiator}" record_id =...
[ "async", "def", "retrieve_by_thread_and_initiator", "(", "cls", ",", "context", ":", "InjectionContext", ",", "thread_id", ":", "str", ",", "initiator", ":", "str", ")", "->", "\"CredentialExchange\"", ":", "cache_key", "=", "f\"credential_exchange_tidx::{thread_id}::{i...
[ 104, 4 ]
[ 117, 21 ]
python
en
['en', 'en', 'en']
True
CredentialExchange.post_save
( self, context: InjectionContext, new_record: bool, last_state: str, webhook: bool = None, )
Perform post-save actions. Args: context: The injection context to use new_record: Flag indicating if the record was just created last_state: The previous state value webhook: Adjust whether the webhook is called
Perform post-save actions.
async def post_save( self, context: InjectionContext, new_record: bool, last_state: str, webhook: bool = None, ): """Perform post-save actions. Args: context: The injection context to use new_record: Flag indicating if the record was j...
[ "async", "def", "post_save", "(", "self", ",", "context", ":", "InjectionContext", ",", "new_record", ":", "bool", ",", "last_state", ":", "str", ",", "webhook", ":", "bool", "=", "None", ",", ")", ":", "await", "super", "(", "CredentialExchange", ",", "...
[ 119, 4 ]
[ 139, 86 ]
python
en
['en', 'en', 'en']
True
create_keypair
(seed: bytes = None)
Create a public and private signing keypair from a seed value. Args: seed: Seed for keypair Returns: A tuple of (public key, secret key)
Create a public and private signing keypair from a seed value.
def create_keypair(seed: bytes = None) -> (bytes, bytes): """ Create a public and private signing keypair from a seed value. Args: seed: Seed for keypair Returns: A tuple of (public key, secret key) """ if not seed: seed = random_seed() pk, sk = nacl.bindings.crypt...
[ "def", "create_keypair", "(", "seed", ":", "bytes", "=", "None", ")", "->", "(", "bytes", ",", "bytes", ")", ":", "if", "not", "seed", ":", "seed", "=", "random_seed", "(", ")", "pk", ",", "sk", "=", "nacl", ".", "bindings", ".", "crypto_sign_seed_ke...
[ 49, 0 ]
[ 63, 17 ]
python
en
['en', 'error', 'th']
False
random_seed
()
Generate a random seed value. Returns: A new random seed
Generate a random seed value.
def random_seed() -> bytes: """ Generate a random seed value. Returns: A new random seed """ return nacl.utils.random(nacl.bindings.crypto_box_SEEDBYTES)
[ "def", "random_seed", "(", ")", "->", "bytes", ":", "return", "nacl", ".", "utils", ".", "random", "(", "nacl", ".", "bindings", ".", "crypto_box_SEEDBYTES", ")" ]
[ 66, 0 ]
[ 74, 64 ]
python
en
['en', 'error', 'th']
False
seed_to_did
(seed: str)
Derive a DID from a seed value. Args: seed: The seed to derive Returns: The DID derived from the seed
Derive a DID from a seed value.
def seed_to_did(seed: str) -> str: """ Derive a DID from a seed value. Args: seed: The seed to derive Returns: The DID derived from the seed """ seed = validate_seed(seed) verkey, _ = create_keypair(seed) did = bytes_to_b58(verkey[:16]) return did
[ "def", "seed_to_did", "(", "seed", ":", "str", ")", "->", "str", ":", "seed", "=", "validate_seed", "(", "seed", ")", "verkey", ",", "_", "=", "create_keypair", "(", "seed", ")", "did", "=", "bytes_to_b58", "(", "verkey", "[", ":", "16", "]", ")", ...
[ 77, 0 ]
[ 91, 14 ]
python
en
['en', 'error', 'th']
False
validate_seed
(seed: (str, bytes))
Convert a seed parameter to standard format and check length. Args: seed: The seed to validate Returns: The validated and encoded seed
Convert a seed parameter to standard format and check length.
def validate_seed(seed: (str, bytes)) -> bytes: """ Convert a seed parameter to standard format and check length. Args: seed: The seed to validate Returns: The validated and encoded seed """ if not seed: return None if isinstance(seed, str): if "=" in seed:...
[ "def", "validate_seed", "(", "seed", ":", "(", "str", ",", "bytes", ")", ")", "->", "bytes", ":", "if", "not", "seed", ":", "return", "None", "if", "isinstance", "(", "seed", ",", "str", ")", ":", "if", "\"=\"", "in", "seed", ":", "seed", "=", "b...
[ 94, 0 ]
[ 116, 15 ]
python
en
['en', 'error', 'th']
False
sign_message
(message: bytes, secret: bytes)
Sign a message using a private signing key. Args: message: The message to sign secret: The private signing key Returns: The signature
Sign a message using a private signing key.
def sign_message(message: bytes, secret: bytes) -> bytes: """ Sign a message using a private signing key. Args: message: The message to sign secret: The private signing key Returns: The signature """ result = nacl.bindings.crypto_sign(message, secret) sig = result[...
[ "def", "sign_message", "(", "message", ":", "bytes", ",", "secret", ":", "bytes", ")", "->", "bytes", ":", "result", "=", "nacl", ".", "bindings", ".", "crypto_sign", "(", "message", ",", "secret", ")", "sig", "=", "result", "[", ":", "nacl", ".", "b...
[ 119, 0 ]
[ 133, 14 ]
python
en
['en', 'error', 'th']
False
verify_signed_message
(signed: bytes, verkey: bytes)
Verify a signed message according to a public verification key. Args: signed: The signed message verkey: The verkey to use in verification Returns: True if verified, else False
Verify a signed message according to a public verification key.
def verify_signed_message(signed: bytes, verkey: bytes) -> bool: """ Verify a signed message according to a public verification key. Args: signed: The signed message verkey: The verkey to use in verification Returns: True if verified, else False """ try: nacl.b...
[ "def", "verify_signed_message", "(", "signed", ":", "bytes", ",", "verkey", ":", "bytes", ")", "->", "bool", ":", "try", ":", "nacl", ".", "bindings", ".", "crypto_sign_open", "(", "signed", ",", "verkey", ")", "except", "nacl", ".", "exceptions", ".", "...
[ 136, 0 ]
[ 152, 15 ]
python
en
['en', 'error', 'th']
False
anon_crypt_message
(message: bytes, to_verkey: bytes)
Apply anon_crypt to a binary message. Args: message: The message to encrypt to_verkey: The verkey to encrypt the message for Returns: The anon encrypted message
Apply anon_crypt to a binary message.
def anon_crypt_message(message: bytes, to_verkey: bytes) -> bytes: """ Apply anon_crypt to a binary message. Args: message: The message to encrypt to_verkey: The verkey to encrypt the message for Returns: The anon encrypted message """ pk = nacl.bindings.crypto_sign_ed...
[ "def", "anon_crypt_message", "(", "message", ":", "bytes", ",", "to_verkey", ":", "bytes", ")", "->", "bytes", ":", "pk", "=", "nacl", ".", "bindings", ".", "crypto_sign_ed25519_pk_to_curve25519", "(", "to_verkey", ")", "enc_message", "=", "nacl", ".", "bindin...
[ 155, 0 ]
[ 169, 22 ]
python
en
['en', 'error', 'th']
False
anon_decrypt_message
(enc_message: bytes, secret: bytes)
Apply anon_decrypt to a binary message. Args: enc_message: The encrypted message secret: The seed to use Returns: The decrypted message
Apply anon_decrypt to a binary message.
def anon_decrypt_message(enc_message: bytes, secret: bytes) -> bytes: """ Apply anon_decrypt to a binary message. Args: enc_message: The encrypted message secret: The seed to use Returns: The decrypted message """ sign_pk, sign_sk = create_keypair(secret) pk = nacl...
[ "def", "anon_decrypt_message", "(", "enc_message", ":", "bytes", ",", "secret", ":", "bytes", ")", "->", "bytes", ":", "sign_pk", ",", "sign_sk", "=", "create_keypair", "(", "secret", ")", "pk", "=", "nacl", ".", "bindings", ".", "crypto_sign_ed25519_pk_to_cur...
[ 172, 0 ]
[ 189, 18 ]
python
en
['en', 'error', 'th']
False
auth_crypt_message
(message: bytes, to_verkey: bytes, from_secret: bytes)
Apply auth_crypt to a binary message. Args: message: The message to encrypt to_verkey: To recipient's verkey from_secret: The seed to use Returns: The encrypted message
Apply auth_crypt to a binary message.
def auth_crypt_message(message: bytes, to_verkey: bytes, from_secret: bytes) -> bytes: """ Apply auth_crypt to a binary message. Args: message: The message to encrypt to_verkey: To recipient's verkey from_secret: The seed to use Returns: The encrypted message """ ...
[ "def", "auth_crypt_message", "(", "message", ":", "bytes", ",", "to_verkey", ":", "bytes", ",", "from_secret", ":", "bytes", ")", "->", "bytes", ":", "nonce", "=", "nacl", ".", "utils", ".", "random", "(", "nacl", ".", "bindings", ".", "crypto_box_NONCEBYT...
[ 192, 0 ]
[ 219, 22 ]
python
en
['en', 'error', 'th']
False
auth_decrypt_message
(enc_message: bytes, secret: bytes)
Apply auth_decrypt to a binary message. Args: enc_message: The encrypted message secret: Secret for signing keys Returns: A tuple of (decrypted message, sender verkey)
Apply auth_decrypt to a binary message.
def auth_decrypt_message(enc_message: bytes, secret: bytes) -> (bytes, str): """ Apply auth_decrypt to a binary message. Args: enc_message: The encrypted message secret: Secret for signing keys Returns: A tuple of (decrypted message, sender verkey) """ sign_pk, sign_sk...
[ "def", "auth_decrypt_message", "(", "enc_message", ":", "bytes", ",", "secret", ":", "bytes", ")", "->", "(", "bytes", ",", "str", ")", ":", "sign_pk", ",", "sign_sk", "=", "create_keypair", "(", "secret", ")", "pk", "=", "nacl", ".", "bindings", ".", ...
[ 222, 0 ]
[ 247, 29 ]
python
en
['en', 'error', 'th']
False
prepare_pack_recipient_keys
( to_verkeys: Sequence[bytes], from_secret: bytes = None )
Assemble the recipients block of a packed message. Args: to_verkeys: Verkeys of recipients from_secret: Secret to use for signing keys Returns: A tuple of (json result, key)
Assemble the recipients block of a packed message.
def prepare_pack_recipient_keys( to_verkeys: Sequence[bytes], from_secret: bytes = None ) -> (str, bytes): """ Assemble the recipients block of a packed message. Args: to_verkeys: Verkeys of recipients from_secret: Secret to use for signing keys Returns: A tuple of (json re...
[ "def", "prepare_pack_recipient_keys", "(", "to_verkeys", ":", "Sequence", "[", "bytes", "]", ",", "from_secret", ":", "bytes", "=", "None", ")", "->", "(", "str", ",", "bytes", ")", ":", "cek", "=", "nacl", ".", "bindings", ".", "crypto_secretstream_xchacha2...
[ 250, 0 ]
[ 318, 32 ]
python
en
['en', 'error', 'th']
False
locate_pack_recipient_key
( recipients: Sequence[dict], find_key: Callable )
Locate pack recipient key. Decode the encryption key and sender verification key from a corresponding recipient block, if any is defined. Args: recipients: Recipients to locate find_key: Function used to find private key Returns: A tuple of (cek, sender_vk, recip_vk_b58) ...
Locate pack recipient key.
def locate_pack_recipient_key( recipients: Sequence[dict], find_key: Callable ) -> (bytes, str, str): """ Locate pack recipient key. Decode the encryption key and sender verification key from a corresponding recipient block, if any is defined. Args: recipients: Recipients to locate ...
[ "def", "locate_pack_recipient_key", "(", "recipients", ":", "Sequence", "[", "dict", "]", ",", "find_key", ":", "Callable", ")", "->", "(", "bytes", ",", "str", ",", "str", ")", ":", "not_found", "=", "[", "]", "for", "recip", "in", "recipients", ":", ...
[ 321, 0 ]
[ 373, 84 ]
python
en
['en', 'error', 'th']
False