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 |
|---|---|---|---|---|---|---|---|---|---|---|---|
BaseSettings.copy | (self) | Produce a copy of the settings instance. | Produce a copy of the settings instance. | def copy(self) -> "BaseSettings":
"""Produce a copy of the settings instance.""" | [
"def",
"copy",
"(",
"self",
")",
"->",
"\"BaseSettings\"",
":"
] | [
87,
4
] | [
88,
54
] | python | en | ['en', 'en', 'en'] | True |
BaseSettings.extend | (self, other: Mapping[str, object]) | Merge another mapping to produce a new settings instance. | Merge another mapping to produce a new settings instance. | def extend(self, other: Mapping[str, object]) -> "BaseSettings":
"""Merge another mapping to produce a new settings instance.""" | [
"def",
"extend",
"(",
"self",
",",
"other",
":",
"Mapping",
"[",
"str",
",",
"object",
"]",
")",
"->",
"\"BaseSettings\"",
":"
] | [
91,
4
] | [
92,
71
] | python | en | ['en', 'en', 'en'] | True |
BaseSettings.__repr__ | (self) | Provide a human readable representation of this object. | Provide a human readable representation of this object. | def __repr__(self) -> str:
"""Provide a human readable representation of this object."""
items = ("{}={}".format(k, self[k]) for k in self)
return "<{}({})>".format(self.__class__.__name__, ", ".join(items)) | [
"def",
"__repr__",
"(",
"self",
")",
"->",
"str",
":",
"items",
"=",
"(",
"\"{}={}\"",
".",
"format",
"(",
"k",
",",
"self",
"[",
"k",
"]",
")",
"for",
"k",
"in",
"self",
")",
"return",
"\"<{}({})>\"",
".",
"format",
"(",
"self",
".",
"__class__",
... | [
94,
4
] | [
97,
75
] | python | en | ['en', 'en', 'en'] | True |
BaseInjector.inject | (
self,
base_cls: type,
settings: Mapping[str, object] = None,
*,
required: bool = True
) |
Get the provided instance of a given class identifier.
Args:
cls: The base class to retrieve an instance of
settings: An optional mapping providing configuration to the provider
Returns:
An instance of the base class, or None
|
Get the provided instance of a given class identifier. | async def inject(
self,
base_cls: type,
settings: Mapping[str, object] = None,
*,
required: bool = True
) -> object:
"""
Get the provided instance of a given class identifier.
Args:
cls: The base class to retrieve an instance of
... | [
"async",
"def",
"inject",
"(",
"self",
",",
"base_cls",
":",
"type",
",",
"settings",
":",
"Mapping",
"[",
"str",
",",
"object",
"]",
"=",
"None",
",",
"*",
",",
"required",
":",
"bool",
"=",
"True",
")",
"->",
"object",
":"
] | [
108,
4
] | [
125,
11
] | python | en | ['en', 'error', 'th'] | False |
BaseInjector.copy | (self) | Produce a copy of the injector instance. | Produce a copy of the injector instance. | def copy(self) -> "BaseInjector":
"""Produce a copy of the injector instance.""" | [
"def",
"copy",
"(",
"self",
")",
"->",
"\"BaseInjector\"",
":"
] | [
128,
4
] | [
129,
54
] | python | en | ['en', 'en', 'en'] | True |
BaseProvider.provide | (self, settings: BaseSettings, injector: BaseInjector) | Provide the object instance given a config and injector. | Provide the object instance given a config and injector. | async def provide(self, settings: BaseSettings, injector: BaseInjector):
"""Provide the object instance given a config and injector.""" | [
"async",
"def",
"provide",
"(",
"self",
",",
"settings",
":",
"BaseSettings",
",",
"injector",
":",
"BaseInjector",
")",
":"
] | [
139,
4
] | [
140,
70
] | python | en | ['en', 'en', 'en'] | True |
TorchRankerAgent.add_cmdline_args | (
cls, parser: ParlaiParser, partial_opt: Optional[Opt] = None
) |
Add CLI args.
|
Add CLI args.
| def add_cmdline_args(
cls, parser: ParlaiParser, partial_opt: Optional[Opt] = None
) -> ParlaiParser:
"""
Add CLI args.
"""
super().add_cmdline_args(parser, partial_opt=partial_opt)
agent = parser.add_argument_group('TorchRankerAgent')
agent.add_argument(
... | [
"def",
"add_cmdline_args",
"(",
"cls",
",",
"parser",
":",
"ParlaiParser",
",",
"partial_opt",
":",
"Optional",
"[",
"Opt",
"]",
"=",
"None",
")",
"->",
"ParlaiParser",
":",
"super",
"(",
")",
".",
"add_cmdline_args",
"(",
"parser",
",",
"partial_opt",
"="... | [
53,
4
] | [
181,
21
] | python | en | ['en', 'error', 'th'] | False |
TorchRankerAgent.build_criterion | (self) |
Construct and return the loss function.
By default torch.nn.CrossEntropyLoss.
|
Construct and return the loss function. | def build_criterion(self):
"""
Construct and return the loss function.
By default torch.nn.CrossEntropyLoss.
"""
if self.fp16:
return FP16SafeCrossEntropy(reduction='none')
else:
return torch.nn.CrossEntropyLoss(reduction='none') | [
"def",
"build_criterion",
"(",
"self",
")",
":",
"if",
"self",
".",
"fp16",
":",
"return",
"FP16SafeCrossEntropy",
"(",
"reduction",
"=",
"'none'",
")",
"else",
":",
"return",
"torch",
".",
"nn",
".",
"CrossEntropyLoss",
"(",
"reduction",
"=",
"'none'",
")... | [
254,
4
] | [
263,
62
] | python | en | ['en', 'error', 'th'] | False |
TorchRankerAgent._set_candidate_variables | (self, opt) |
Sets candidate variables from opt.
NOTE: we call this function prior to `super().__init__` so
that these variables are set properly during the call to the
`set_interactive_mode` function.
|
Sets candidate variables from opt. | def _set_candidate_variables(self, opt):
"""
Sets candidate variables from opt.
NOTE: we call this function prior to `super().__init__` so
that these variables are set properly during the call to the
`set_interactive_mode` function.
"""
# candidate variables
... | [
"def",
"_set_candidate_variables",
"(",
"self",
",",
"opt",
")",
":",
"# candidate variables",
"self",
".",
"candidates",
"=",
"opt",
"[",
"'candidates'",
"]",
"self",
".",
"eval_candidates",
"=",
"opt",
"[",
"'eval_candidates'",
"]",
"# options",
"self",
".",
... | [
265,
4
] | [
279,
65
] | python | en | ['en', 'error', 'th'] | False |
TorchRankerAgent.set_interactive_mode | (self, mode, shared=False) |
Set interactive mode defaults.
In interactive mode, we set `ignore_bad_candidates` to True.
Additionally, we change the `eval_candidates` to the option
specified in `--interactive-candidates`, which defaults to False.
Interactive mode possibly changes the fixed candidates path... |
Set interactive mode defaults. | def set_interactive_mode(self, mode, shared=False):
"""
Set interactive mode defaults.
In interactive mode, we set `ignore_bad_candidates` to True.
Additionally, we change the `eval_candidates` to the option
specified in `--interactive-candidates`, which defaults to False.
... | [
"def",
"set_interactive_mode",
"(",
"self",
",",
"mode",
",",
"shared",
"=",
"False",
")",
":",
"super",
"(",
")",
".",
"set_interactive_mode",
"(",
"mode",
",",
"shared",
")",
"if",
"not",
"mode",
":",
"# Not in interactive mode, nothing to do",
"return",
"# ... | [
281,
4
] | [
313,
14
] | python | en | ['en', 'error', 'th'] | False |
TorchRankerAgent.score_candidates | (self, batch, cand_vecs, cand_encs=None) |
Given a batch and candidate set, return scores (for ranking).
:param Batch batch:
a Batch object (defined in torch_agent.py)
:param LongTensor cand_vecs:
padded and tokenized candidates
:param FloatTensor cand_encs:
encoded candidates, if these are p... |
Given a batch and candidate set, return scores (for ranking). | def score_candidates(self, batch, cand_vecs, cand_encs=None):
"""
Given a batch and candidate set, return scores (for ranking).
:param Batch batch:
a Batch object (defined in torch_agent.py)
:param LongTensor cand_vecs:
padded and tokenized candidates
:pa... | [
"def",
"score_candidates",
"(",
"self",
",",
"batch",
",",
"cand_vecs",
",",
"cand_encs",
"=",
"None",
")",
":",
"pass"
] | [
332,
4
] | [
345,
12
] | python | en | ['en', 'error', 'th'] | False |
TorchRankerAgent._get_batch_train_metrics | (self, scores) |
Get fast metrics calculations if we train with batch candidates.
Specifically, calculate accuracy ('train_accuracy'), average rank, and mean
reciprocal rank.
|
Get fast metrics calculations if we train with batch candidates. | def _get_batch_train_metrics(self, scores):
"""
Get fast metrics calculations if we train with batch candidates.
Specifically, calculate accuracy ('train_accuracy'), average rank, and mean
reciprocal rank.
"""
batchsize = scores.size(0)
# get accuracy
tar... | [
"def",
"_get_batch_train_metrics",
"(",
"self",
",",
"scores",
")",
":",
"batchsize",
"=",
"scores",
".",
"size",
"(",
"0",
")",
"# get accuracy",
"targets",
"=",
"scores",
".",
"new_empty",
"(",
"batchsize",
")",
".",
"long",
"(",
")",
"targets",
"=",
"... | [
351,
4
] | [
369,
64
] | python | en | ['en', 'error', 'th'] | False |
TorchRankerAgent._get_train_preds | (self, scores, label_inds, cands, cand_vecs) |
Return predictions from training.
|
Return predictions from training.
| def _get_train_preds(self, scores, label_inds, cands, cand_vecs):
"""
Return predictions from training.
"""
# TODO: speed these calculations up
batchsize = scores.size(0)
if self.rank_top_k > 0:
_, ranks = scores.topk(
min(self.rank_top_k, scor... | [
"def",
"_get_train_preds",
"(",
"self",
",",
"scores",
",",
"label_inds",
",",
"cands",
",",
"cand_vecs",
")",
":",
"# TODO: speed these calculations up",
"batchsize",
"=",
"scores",
".",
"size",
"(",
"0",
")",
"if",
"self",
".",
"rank_top_k",
">",
"0",
":",... | [
371,
4
] | [
413,
28
] | python | en | ['en', 'error', 'th'] | False |
TorchRankerAgent.is_valid | (self, obs) |
Override from TorchAgent.
Check to see if label candidates contain the label.
|
Override from TorchAgent. | def is_valid(self, obs):
"""
Override from TorchAgent.
Check to see if label candidates contain the label.
"""
if not self.ignore_bad_candidates:
return super().is_valid(obs)
if not super().is_valid(obs):
return False
# skip examples for... | [
"def",
"is_valid",
"(",
"self",
",",
"obs",
")",
":",
"if",
"not",
"self",
".",
"ignore_bad_candidates",
":",
"return",
"super",
"(",
")",
".",
"is_valid",
"(",
"obs",
")",
"if",
"not",
"super",
"(",
")",
".",
"is_valid",
"(",
"obs",
")",
":",
"ret... | [
415,
4
] | [
440,
19
] | python | en | ['en', 'error', 'th'] | False |
TorchRankerAgent.train_step | (self, batch) |
Train on a single batch of examples.
|
Train on a single batch of examples.
| def train_step(self, batch):
"""
Train on a single batch of examples.
"""
self._maybe_invalidate_fixed_encs_cache()
if batch.text_vec is None and batch.image is None:
return
self.model.train()
self.zero_grad()
cands, cand_vecs, label_inds = se... | [
"def",
"train_step",
"(",
"self",
",",
"batch",
")",
":",
"self",
".",
"_maybe_invalidate_fixed_encs_cache",
"(",
")",
"if",
"batch",
".",
"text_vec",
"is",
"None",
"and",
"batch",
".",
"image",
"is",
"None",
":",
"return",
"self",
".",
"model",
".",
"tr... | [
442,
4
] | [
484,
74
] | python | en | ['en', 'error', 'th'] | False |
TorchRankerAgent.eval_step | (self, batch) |
Evaluate a single batch of examples.
|
Evaluate a single batch of examples.
| def eval_step(self, batch):
"""
Evaluate a single batch of examples.
"""
if batch.text_vec is None and batch.image is None:
return
batchsize = (
batch.text_vec.size(0)
if batch.text_vec is not None
else batch.image.size(0)
)... | [
"def",
"eval_step",
"(",
"self",
",",
"batch",
")",
":",
"if",
"batch",
".",
"text_vec",
"is",
"None",
"and",
"batch",
".",
"image",
"is",
"None",
":",
"return",
"batchsize",
"=",
"(",
"batch",
".",
"text_vec",
".",
"size",
"(",
"0",
")",
"if",
"ba... | [
486,
4
] | [
572,
69
] | python | en | ['en', 'error', 'th'] | False |
TorchRankerAgent.block_repeats | (self, cand_preds) |
Heuristic to block a model repeating a line from the history.
|
Heuristic to block a model repeating a line from the history.
| def block_repeats(self, cand_preds):
"""
Heuristic to block a model repeating a line from the history.
"""
history_strings = []
for h in self.history.history_raw_strings:
# Heuristic: Block any given line in the history, splitting by '\n'.
history_strings.... | [
"def",
"block_repeats",
"(",
"self",
",",
"cand_preds",
")",
":",
"history_strings",
"=",
"[",
"]",
"for",
"h",
"in",
"self",
".",
"history",
".",
"history_raw_strings",
":",
"# Heuristic: Block any given line in the history, splitting by '\\n'.",
"history_strings",
"."... | [
574,
4
] | [
590,
24
] | python | en | ['en', 'error', 'th'] | False |
TorchRankerAgent._set_label_cands_vec | (self, *args, **kwargs) |
Set the 'label_candidates_vec' field in the observation.
Useful to override to change vectorization behavior.
|
Set the 'label_candidates_vec' field in the observation. | def _set_label_cands_vec(self, *args, **kwargs):
"""
Set the 'label_candidates_vec' field in the observation.
Useful to override to change vectorization behavior.
"""
obs = args[0]
if 'labels' in obs:
cands_key = 'candidates'
else:
cands_k... | [
"def",
"_set_label_cands_vec",
"(",
"self",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"obs",
"=",
"args",
"[",
"0",
"]",
"if",
"'labels'",
"in",
"obs",
":",
"cands_key",
"=",
"'candidates'",
"else",
":",
"cands_key",
"=",
"'eval_candidates'",
... | [
592,
4
] | [
607,
60
] | python | en | ['en', 'error', 'th'] | False |
TorchRankerAgent._build_candidates | (self, batch, source, mode) |
Build a candidate set for this batch.
:param batch:
a Batch object (defined in torch_agent.py)
:param source:
the source from which candidates should be built, one of
['batch', 'batch-all-cands', 'inline', 'fixed']
:param mode:
'train' or... |
Build a candidate set for this batch. | def _build_candidates(self, batch, source, mode):
"""
Build a candidate set for this batch.
:param batch:
a Batch object (defined in torch_agent.py)
:param source:
the source from which candidates should be built, one of
['batch', 'batch-all-cands', '... | [
"def",
"_build_candidates",
"(",
"self",
",",
"batch",
",",
"source",
",",
"mode",
")",
":",
"label_vecs",
"=",
"batch",
".",
"label_vec",
"# [bsz] list of lists of LongTensors",
"label_inds",
"=",
"None",
"batchsize",
"=",
"(",
"batch",
".",
"text_vec",
".",
... | [
609,
4
] | [
809,
45
] | python | en | ['en', 'error', 'th'] | False |
TorchRankerAgent.share | (self) |
Share model parameters.
|
Share model parameters.
| def share(self):
"""
Share model parameters.
"""
shared = super().share()
shared['fixed_candidates'] = self.fixed_candidates
shared['fixed_candidate_vecs'] = self.fixed_candidate_vecs
shared['fixed_candidate_encs'] = self.fixed_candidate_encs
shared['num_f... | [
"def",
"share",
"(",
"self",
")",
":",
"shared",
"=",
"super",
"(",
")",
".",
"share",
"(",
")",
"shared",
"[",
"'fixed_candidates'",
"]",
"=",
"self",
".",
"fixed_candidates",
"shared",
"[",
"'fixed_candidate_vecs'",
"]",
"=",
"self",
".",
"fixed_candidat... | [
818,
4
] | [
832,
21
] | python | en | ['en', 'error', 'th'] | False |
TorchRankerAgent.set_vocab_candidates | (self, shared) |
Load the tokens from the vocab as candidates.
self.vocab_candidates will contain a [num_cands] list of strings
self.vocab_candidate_vecs will contain a [num_cands, 1] LongTensor
|
Load the tokens from the vocab as candidates. | def set_vocab_candidates(self, shared):
"""
Load the tokens from the vocab as candidates.
self.vocab_candidates will contain a [num_cands] list of strings
self.vocab_candidate_vecs will contain a [num_cands, 1] LongTensor
"""
if shared:
self.vocab_candidates ... | [
"def",
"set_vocab_candidates",
"(",
"self",
",",
"shared",
")",
":",
"if",
"shared",
":",
"self",
".",
"vocab_candidates",
"=",
"shared",
"[",
"'vocab_candidates'",
"]",
"self",
".",
"vocab_candidate_vecs",
"=",
"shared",
"[",
"'vocab_candidate_vecs'",
"]",
"sel... | [
834,
4
] | [
877,
48
] | python | en | ['en', 'error', 'th'] | False |
TorchRankerAgent.set_fixed_candidates | (self, shared) |
Load a set of fixed candidates and their vectors (or vectorize them here).
self.fixed_candidates will contain a [num_cands] list of strings
self.fixed_candidate_vecs will contain a [num_cands, seq_len] LongTensor
See the note on the --fixed-candidate-vecs flag for an explanation of th... |
Load a set of fixed candidates and their vectors (or vectorize them here). | def set_fixed_candidates(self, shared):
"""
Load a set of fixed candidates and their vectors (or vectorize them here).
self.fixed_candidates will contain a [num_cands] list of strings
self.fixed_candidate_vecs will contain a [num_cands, seq_len] LongTensor
See the note on the -... | [
"def",
"set_fixed_candidates",
"(",
"self",
",",
"shared",
")",
":",
"if",
"shared",
":",
"self",
".",
"fixed_candidates",
"=",
"shared",
"[",
"'fixed_candidates'",
"]",
"self",
".",
"fixed_candidate_vecs",
"=",
"shared",
"[",
"'fixed_candidate_vecs'",
"]",
"sel... | [
879,
4
] | [
965,
48
] | python | en | ['en', 'error', 'th'] | False |
TorchRankerAgent.load_candidates | (self, path, cand_type='vectors') |
Load fixed candidates from a path.
|
Load fixed candidates from a path.
| def load_candidates(self, path, cand_type='vectors'):
"""
Load fixed candidates from a path.
"""
logging.info(f"Loading fixed candidate set {cand_type} from {path}")
with PathManager.open(path, 'rb') as f:
return torch.load(f, map_location=lambda cpu, _: cpu) | [
"def",
"load_candidates",
"(",
"self",
",",
"path",
",",
"cand_type",
"=",
"'vectors'",
")",
":",
"logging",
".",
"info",
"(",
"f\"Loading fixed candidate set {cand_type} from {path}\"",
")",
"with",
"PathManager",
".",
"open",
"(",
"path",
",",
"'rb'",
")",
"as... | [
967,
4
] | [
973,
65
] | python | en | ['en', 'error', 'th'] | False |
TorchRankerAgent._make_candidate_vecs | (self, cands) |
Prebuild cached vectors for fixed candidates.
|
Prebuild cached vectors for fixed candidates.
| def _make_candidate_vecs(self, cands):
"""
Prebuild cached vectors for fixed candidates.
"""
cand_batches = [cands[i : i + 512] for i in range(0, len(cands), 512)]
logging.info(
f"Vectorizing fixed candidate set ({len(cand_batches)} batch(es) of up to 512)"
)
... | [
"def",
"_make_candidate_vecs",
"(",
"self",
",",
"cands",
")",
":",
"cand_batches",
"=",
"[",
"cands",
"[",
"i",
":",
"i",
"+",
"512",
"]",
"for",
"i",
"in",
"range",
"(",
"0",
",",
"len",
"(",
"cands",
")",
",",
"512",
")",
"]",
"logging",
".",
... | [
975,
4
] | [
988,
20
] | python | en | ['en', 'error', 'th'] | False |
TorchRankerAgent._save_candidates | (self, vecs, path, cand_type='vectors') |
Save cached vectors.
|
Save cached vectors.
| def _save_candidates(self, vecs, path, cand_type='vectors'):
"""
Save cached vectors.
"""
logging.info(f"Saving fixed candidate set {cand_type} to {path}")
with PathManager.open(path, 'wb') as f:
torch.save(vecs, f) | [
"def",
"_save_candidates",
"(",
"self",
",",
"vecs",
",",
"path",
",",
"cand_type",
"=",
"'vectors'",
")",
":",
"logging",
".",
"info",
"(",
"f\"Saving fixed candidate set {cand_type} to {path}\"",
")",
"with",
"PathManager",
".",
"open",
"(",
"path",
",",
"'wb'... | [
990,
4
] | [
996,
31
] | python | en | ['en', 'error', 'th'] | False |
TorchRankerAgent.encode_candidates | (self, padded_cands) |
Convert the given candidates to vectors.
This is an abstract method that must be implemented by the user.
:param padded_cands:
The padded candidates.
|
Convert the given candidates to vectors. | def encode_candidates(self, padded_cands):
"""
Convert the given candidates to vectors.
This is an abstract method that must be implemented by the user.
:param padded_cands:
The padded candidates.
"""
raise NotImplementedError(
'Abstract method: ... | [
"def",
"encode_candidates",
"(",
"self",
",",
"padded_cands",
")",
":",
"raise",
"NotImplementedError",
"(",
"'Abstract method: user must implement encode_candidates(). '",
"'If your agent encodes candidates independently '",
"'from context, you can get performance gains with fixed cands b... | [
998,
4
] | [
1013,
9
] | python | en | ['en', 'error', 'th'] | False |
TorchRankerAgent._make_candidate_encs | (self, vecs) |
Encode candidates from candidate vectors.
Requires encode_candidates() to be implemented.
|
Encode candidates from candidate vectors. | def _make_candidate_encs(self, vecs):
"""
Encode candidates from candidate vectors.
Requires encode_candidates() to be implemented.
"""
cand_encs = []
bsz = self.opt.get('encode_candidate_vecs_batchsize', 256)
vec_batches = [vecs[i : i + bsz] for i in range(0, l... | [
"def",
"_make_candidate_encs",
"(",
"self",
",",
"vecs",
")",
":",
"cand_encs",
"=",
"[",
"]",
"bsz",
"=",
"self",
".",
"opt",
".",
"get",
"(",
"'encode_candidate_vecs_batchsize'",
",",
"256",
")",
"vec_batches",
"=",
"[",
"vecs",
"[",
"i",
":",
"i",
"... | [
1015,
4
] | [
1034,
59
] | python | en | ['en', 'error', 'th'] | False |
TorchRankerAgent.vectorize_fixed_candidates | (self, cands_batch, add_start=False, add_end=False) |
Convert a batch of candidates from text to vectors.
:param cands_batch:
a [batchsize] list of candidates (strings)
:returns:
a [num_cands] list of candidate vectors
By default, candidates are simply vectorized (tokens replaced by token ids).
A child cla... |
Convert a batch of candidates from text to vectors. | def vectorize_fixed_candidates(self, cands_batch, add_start=False, add_end=False):
"""
Convert a batch of candidates from text to vectors.
:param cands_batch:
a [batchsize] list of candidates (strings)
:returns:
a [num_cands] list of candidate vectors
By... | [
"def",
"vectorize_fixed_candidates",
"(",
"self",
",",
"cands_batch",
",",
"add_start",
"=",
"False",
",",
"add_end",
"=",
"False",
")",
":",
"return",
"[",
"self",
".",
"_vectorize_text",
"(",
"cand",
",",
"truncate",
"=",
"self",
".",
"label_truncate",
","... | [
1036,
4
] | [
1058,
9
] | python | en | ['en', 'error', 'th'] | False |
PlotlyGraphObjectError.__init__ | (self, message="", path=(), notes=()) |
General graph object error for validation failures.
:param (str|unicode) message: The error message.
:param (iterable) path: A path pointing to the error.
:param notes: Add additional notes, but keep default exception message.
|
General graph object error for validation failures. | def __init__(self, message="", path=(), notes=()):
"""
General graph object error for validation failures.
:param (str|unicode) message: The error message.
:param (iterable) path: A path pointing to the error.
:param notes: Add additional notes, but keep default exception messag... | [
"def",
"__init__",
"(",
"self",
",",
"message",
"=",
"\"\"",
",",
"path",
"=",
"(",
")",
",",
"notes",
"=",
"(",
")",
")",
":",
"self",
".",
"message",
"=",
"message",
"self",
".",
"plain_message",
"=",
"message",
"# for backwards compat",
"self",
".",... | [
9,
4
] | [
22,
61
] | python | en | ['en', 'error', 'th'] | False |
PlotlyGraphObjectError.__str__ | (self) | This is called by Python to present the error message. | This is called by Python to present the error message. | def __str__(self):
"""This is called by Python to present the error message."""
format_dict = {
"message": self.message,
"path": "[" + "][".join(repr(k) for k in self.path) + "]",
"notes": "\n".join(self.notes),
}
return "{message}\n\nPath To Error: {p... | [
"def",
"__str__",
"(",
"self",
")",
":",
"format_dict",
"=",
"{",
"\"message\"",
":",
"self",
".",
"message",
",",
"\"path\"",
":",
"\"[\"",
"+",
"\"][\"",
".",
"join",
"(",
"repr",
"(",
"k",
")",
"for",
"k",
"in",
"self",
".",
"path",
")",
"+",
... | [
24,
4
] | [
31,
84
] | python | en | ['en', 'en', 'en'] | True |
PlotlyDictKeyError.__init__ | (self, obj, path, notes=()) | See PlotlyGraphObjectError.__init__ for param docs. | See PlotlyGraphObjectError.__init__ for param docs. | def __init__(self, obj, path, notes=()):
"""See PlotlyGraphObjectError.__init__ for param docs."""
format_dict = {"attribute": path[-1], "object_name": obj._name}
message = "'{attribute}' is not allowed in '{object_name}'".format(
**format_dict
)
notes = [obj.help(ret... | [
"def",
"__init__",
"(",
"self",
",",
"obj",
",",
"path",
",",
"notes",
"=",
"(",
")",
")",
":",
"format_dict",
"=",
"{",
"\"attribute\"",
":",
"path",
"[",
"-",
"1",
"]",
",",
"\"object_name\"",
":",
"obj",
".",
"_name",
"}",
"message",
"=",
"\"'{a... | [
35,
4
] | [
44,
9
] | python | en | ['en', 'mg', 'hi'] | False |
PlotlyDictValueError.__init__ | (self, obj, path, notes=()) | See PlotlyGraphObjectError.__init__ for param docs. | See PlotlyGraphObjectError.__init__ for param docs. | def __init__(self, obj, path, notes=()):
"""See PlotlyGraphObjectError.__init__ for param docs."""
format_dict = {"attribute": path[-1], "object_name": obj._name}
message = "'{attribute}' has invalid value inside '{object_name}'".format(
**format_dict
)
notes = [obj.h... | [
"def",
"__init__",
"(",
"self",
",",
"obj",
",",
"path",
",",
"notes",
"=",
"(",
")",
")",
":",
"format_dict",
"=",
"{",
"\"attribute\"",
":",
"path",
"[",
"-",
"1",
"]",
",",
"\"object_name\"",
":",
"obj",
".",
"_name",
"}",
"message",
"=",
"\"'{a... | [
48,
4
] | [
57,
9
] | python | en | ['en', 'mg', 'hi'] | False |
PlotlyListEntryError.__init__ | (self, obj, path, notes=()) | See PlotlyGraphObjectError.__init__ for param docs. | See PlotlyGraphObjectError.__init__ for param docs. | def __init__(self, obj, path, notes=()):
"""See PlotlyGraphObjectError.__init__ for param docs."""
format_dict = {"index": path[-1], "object_name": obj._name}
message = "Invalid entry found in '{object_name}' at index, '{index}'".format(
**format_dict
)
notes = [obj.h... | [
"def",
"__init__",
"(",
"self",
",",
"obj",
",",
"path",
",",
"notes",
"=",
"(",
")",
")",
":",
"format_dict",
"=",
"{",
"\"index\"",
":",
"path",
"[",
"-",
"1",
"]",
",",
"\"object_name\"",
":",
"obj",
".",
"_name",
"}",
"message",
"=",
"\"Invalid... | [
61,
4
] | [
70,
9
] | python | en | ['en', 'mg', 'hi'] | False |
PlotlyDataTypeError.__init__ | (self, obj, path, notes=()) | See PlotlyGraphObjectError.__init__ for param docs. | See PlotlyGraphObjectError.__init__ for param docs. | def __init__(self, obj, path, notes=()):
"""See PlotlyGraphObjectError.__init__ for param docs."""
format_dict = {"index": path[-1], "object_name": obj._name}
message = "Invalid entry found in '{object_name}' at index, '{index}'".format(
**format_dict
)
note = "It's i... | [
"def",
"__init__",
"(",
"self",
",",
"obj",
",",
"path",
",",
"notes",
"=",
"(",
")",
")",
":",
"format_dict",
"=",
"{",
"\"index\"",
":",
"path",
"[",
"-",
"1",
"]",
",",
"\"object_name\"",
":",
"obj",
".",
"_name",
"}",
"message",
"=",
"\"Invalid... | [
74,
4
] | [
84,
9
] | python | en | ['en', 'mg', 'hi'] | False |
XAxis.autorange | (self) |
Determines whether or not the range of this axis is computed in
relation to the input data. See `rangemode` for more info. If
`range` is provided, then `autorange` is set to False.
The 'autorange' property is an enumeration that may be specified as:
- One of the following... |
Determines whether or not the range of this axis is computed in
relation to the input data. See `rangemode` for more info. If
`range` is provided, then `autorange` is set to False.
The 'autorange' property is an enumeration that may be specified as:
- One of the following... | def autorange(self):
"""
Determines whether or not the range of this axis is computed in
relation to the input data. See `rangemode` for more info. If
`range` is provided, then `autorange` is set to False.
The 'autorange' property is an enumeration that may be specified as:
... | [
"def",
"autorange",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"autorange\"",
"]"
] | [
71,
4
] | [
85,
32
] | python | en | ['en', 'error', 'th'] | False |
XAxis.backgroundcolor | (self) |
Sets the background color of this axis' wall.
The 'backgroundcolor' 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.... |
Sets the background color of this axis' wall.
The 'backgroundcolor' 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 backgroundcolor(self):
"""
Sets the background color of this axis' wall.
The 'backgroundcolor' 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",
"backgroundcolor",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"backgroundcolor\"",
"]"
] | [
94,
4
] | [
144,
38
] | python | en | ['en', 'error', 'th'] | False |
XAxis.calendar | (self) |
Sets the calendar system to use for `range` and `tick0` if this
is a date axis. This does not set the calendar for interpreting
data on this axis, that's specified in the trace or via the
global `layout.calendar`
The 'calendar' property is an enumeration that may be specifi... |
Sets the calendar system to use for `range` and `tick0` if this
is a date axis. This does not set the calendar for interpreting
data on this axis, that's specified in the trace or via the
global `layout.calendar`
The 'calendar' property is an enumeration that may be specifi... | def calendar(self):
"""
Sets the calendar system to use for `range` and `tick0` if this
is a date axis. This does not set the calendar for interpreting
data on this axis, that's specified in the trace or via the
global `layout.calendar`
The 'calendar' property is an ... | [
"def",
"calendar",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"calendar\"",
"]"
] | [
153,
4
] | [
171,
31
] | python | en | ['en', 'error', 'th'] | False |
XAxis.categoryarray | (self) |
Sets the order in which categories on this axis appear. Only
has an effect if `categoryorder` is set to "array". Used with
`categoryorder`.
The 'categoryarray' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
Returns
... |
Sets the order in which categories on this axis appear. Only
has an effect if `categoryorder` is set to "array". Used with
`categoryorder`.
The 'categoryarray' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series | def categoryarray(self):
"""
Sets the order in which categories on this axis appear. Only
has an effect if `categoryorder` is set to "array". Used with
`categoryorder`.
The 'categoryarray' property is an array that may be specified as a tuple,
list, numpy array, or p... | [
"def",
"categoryarray",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"categoryarray\"",
"]"
] | [
180,
4
] | [
193,
36
] | python | en | ['en', 'error', 'th'] | False |
XAxis.categoryarraysrc | (self) |
Sets the source reference on Chart Studio Cloud for
categoryarray .
The 'categoryarraysrc' 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
categoryarray .
The 'categoryarraysrc' property must be specified as a string or
as a plotly.grid_objs.Column object | def categoryarraysrc(self):
"""
Sets the source reference on Chart Studio Cloud for
categoryarray .
The 'categoryarraysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return se... | [
"def",
"categoryarraysrc",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"categoryarraysrc\"",
"]"
] | [
202,
4
] | [
214,
39
] | python | en | ['en', 'error', 'th'] | False |
XAxis.categoryorder | (self) |
Specifies the ordering logic for the case of categorical
variables. By default, plotly uses "trace", which specifies the
order that is present in the data supplied. Set `categoryorder`
to *category ascending* or *category descending* if order
should be determined by the alphanum... |
Specifies the ordering logic for the case of categorical
variables. By default, plotly uses "trace", which specifies the
order that is present in the data supplied. Set `categoryorder`
to *category ascending* or *category descending* if order
should be determined by the alphanum... | def categoryorder(self):
"""
Specifies the ordering logic for the case of categorical
variables. By default, plotly uses "trace", which specifies the
order that is present in the data supplied. Set `categoryorder`
to *category ascending* or *category descending* if order
... | [
"def",
"categoryorder",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"categoryorder\"",
"]"
] | [
223,
4
] | [
254,
36
] | python | en | ['en', 'error', 'th'] | False |
XAxis.color | (self) |
Sets default for all colors associated with this axis all at
once: line, font, tick, and grid colors. Grid color is
lightened by blending this with the plot background Individual
pieces can override this.
The 'color' property is a color and may be specified as:
- ... |
Sets default for all colors associated with this axis all at
once: line, font, tick, and grid colors. Grid color is
lightened by blending this with the plot background Individual
pieces can override this.
The 'color' property is a color and may be specified as:
- ... | def color(self):
"""
Sets default for all colors associated with this axis all at
once: line, font, tick, and grid colors. Grid color is
lightened by blending this with the plot background Individual
pieces can override this.
The 'color' property is a color and may b... | [
"def",
"color",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"color\"",
"]"
] | [
263,
4
] | [
316,
28
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
325,
4
] | [
354,
28
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
363,
4
] | [
379,
37
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
388,
4
] | [
438,
32
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
447,
4
] | [
458,
32
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
467,
4
] | [
487,
34
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
496,
4
] | [
546,
32
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
555,
4
] | [
566,
32
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
575,
4
] | [
592,
29
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
601,
4
] | [
616,
29
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
625,
4
] | [
646,
28
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
655,
4
] | [
671,
32
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
680,
4
] | [
691,
40
] | python | en | ['en', 'error', 'th'] | False |
XAxis.showaxeslabels | (self) |
Sets whether or not this axis is labeled
The 'showaxeslabels' property must be specified as a bool
(either True, or False)
Returns
-------
bool
|
Sets whether or not this axis is labeled
The 'showaxeslabels' property must be specified as a bool
(either True, or False) | def showaxeslabels(self):
"""
Sets whether or not this axis is labeled
The 'showaxeslabels' property must be specified as a bool
(either True, or False)
Returns
-------
bool
"""
return self["showaxeslabels"] | [
"def",
"showaxeslabels",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"showaxeslabels\"",
"]"
] | [
700,
4
] | [
711,
37
] | python | en | ['en', 'error', 'th'] | False |
XAxis.showbackground | (self) |
Sets whether or not this axis' wall has a background color.
The 'showbackground' property must be specified as a bool
(either True, or False)
Returns
-------
bool
|
Sets whether or not this axis' wall has a background color.
The 'showbackground' property must be specified as a bool
(either True, or False) | def showbackground(self):
"""
Sets whether or not this axis' wall has a background color.
The 'showbackground' property must be specified as a bool
(either True, or False)
Returns
-------
bool
"""
return self["showbackground"] | [
"def",
"showbackground",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"showbackground\"",
"]"
] | [
720,
4
] | [
731,
37
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
740,
4
] | [
755,
35
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
764,
4
] | [
776,
31
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
785,
4
] | [
796,
31
] | python | en | ['en', 'error', 'th'] | False |
XAxis.showspikes | (self) |
Sets whether or not spikes starting from data points to this
axis' wall are shown on hover.
The 'showspikes' property must be specified as a bool
(either True, or False)
Returns
-------
bool
|
Sets whether or not spikes starting from data points to this
axis' wall are shown on hover.
The 'showspikes' property must be specified as a bool
(either True, or False) | def showspikes(self):
"""
Sets whether or not spikes starting from data points to this
axis' wall are shown on hover.
The 'showspikes' property must be specified as a bool
(either True, or False)
Returns
-------
bool
"""
return self["... | [
"def",
"showspikes",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"showspikes\"",
"]"
] | [
805,
4
] | [
817,
33
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
826,
4
] | [
837,
37
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
846,
4
] | [
861,
37
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
870,
4
] | [
882,
37
] | python | en | ['en', 'error', 'th'] | False |
XAxis.spikecolor | (self) |
Sets the color of the spikes.
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 string (e.g. 'hsv(0,100%,100%)'... |
Sets the color of the spikes.
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 string (e.g. 'hsv(0,100%,100%)'... | def spikecolor(self):
"""
Sets the color of the spikes.
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/hsv... | [
"def",
"spikecolor",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"spikecolor\"",
"]"
] | [
891,
4
] | [
941,
33
] | python | en | ['en', 'error', 'th'] | False |
XAxis.spikesides | (self) |
Sets whether or not spikes extending from the projection data
points to this axis' wall boundaries are shown on hover.
The 'spikesides' property must be specified as a bool
(either True, or False)
Returns
-------
bool
|
Sets whether or not spikes extending from the projection data
points to this axis' wall boundaries are shown on hover.
The 'spikesides' property must be specified as a bool
(either True, or False) | def spikesides(self):
"""
Sets whether or not spikes extending from the projection data
points to this axis' wall boundaries are shown on hover.
The 'spikesides' property must be specified as a bool
(either True, or False)
Returns
-------
bool
... | [
"def",
"spikesides",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"spikesides\"",
"]"
] | [
950,
4
] | [
962,
33
] | python | en | ['en', 'error', 'th'] | False |
XAxis.spikethickness | (self) |
Sets the thickness (in px) of the spikes.
The 'spikethickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
int|float
|
Sets the thickness (in px) of the spikes.
The 'spikethickness' property is a number and may be specified as:
- An int or float in the interval [0, inf] | def spikethickness(self):
"""
Sets the thickness (in px) of the spikes.
The 'spikethickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
int|float
"""
return self["spikethickness"... | [
"def",
"spikethickness",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"spikethickness\"",
"]"
] | [
971,
4
] | [
982,
37
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
991,
4
] | [
1009,
28
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
1018,
4
] | [
1033,
32
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
1042,
4
] | [
1092,
32
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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.scene.xaxis.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.scene.xaxis.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.scene.xaxis.Tickfont`
- A dict of string/value properties that will be passed
to... | [
"def",
"tickfont",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"tickfont\"",
"]"
] | [
1101,
4
] | [
1138,
31
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
1147,
4
] | [
1167,
33
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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.scene.xaxis.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickf... |
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.scene.xaxis.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickf... | 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.scene.xaxis.Tickformatstop
- A list or tuple of dicts of string/value properties that
... | [
"def",
"tickformatstops",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"tickformatstops\"",
"]"
] | [
1176,
4
] | [
1224,
38
] | python | en | ['en', 'error', 'th'] | False |
XAxis.tickformatstopdefaults | (self) |
When used in a template (as
layout.template.layout.scene.xaxis.tickformatstopdefaults),
sets the default property values to use for elements of
layout.scene.xaxis.tickformatstops
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be spec... |
When used in a template (as
layout.template.layout.scene.xaxis.tickformatstopdefaults),
sets the default property values to use for elements of
layout.scene.xaxis.tickformatstops
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be spec... | def tickformatstopdefaults(self):
"""
When used in a template (as
layout.template.layout.scene.xaxis.tickformatstopdefaults),
sets the default property values to use for elements of
layout.scene.xaxis.tickformatstops
The 'tickformatstopdefaults' property is an instan... | [
"def",
"tickformatstopdefaults",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"tickformatstopdefaults\"",
"]"
] | [
1233,
4
] | [
1252,
45
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
1261,
4
] | [
1272,
30
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
1281,
4
] | [
1299,
31
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
1308,
4
] | [
1320,
33
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
1329,
4
] | [
1343,
28
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
1352,
4
] | [
1364,
33
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
1373,
4
] | [
1386,
31
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
1395,
4
] | [
1406,
34
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
1415,
4
] | [
1427,
31
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
1436,
4
] | [
1447,
34
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
1456,
4
] | [
1467,
32
] | python | en | ['en', 'error', 'th'] | False |
XAxis.title | (self) |
The 'title' property is an instance of Title
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.scene.xaxis.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.scene.xaxis.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.scene.xaxis.Title`
- A dict of string/value properties that will be passed
to the Title constructor
Suppo... | [
"def",
"title",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"title\"",
"]"
] | [
1476,
4
] | [
1501,
28
] | python | en | ['en', 'error', 'th'] | False |
XAxis.titlefont | (self) |
Deprecated: Please use layout.scene.xaxis.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 instan... |
Deprecated: Please use layout.scene.xaxis.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 instan... | def titlefont(self):
"""
Deprecated: Please use layout.scene.xaxis.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 spe... | [
"def",
"titlefont",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"titlefont\"",
"]"
] | [
1510,
4
] | [
1549,
32
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
1558,
4
] | [
1572,
27
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
1581,
4
] | [
1594,
30
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
1603,
4
] | [
1616,
31
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
1625,
4
] | [
1675,
36
] | python | en | ['en', 'error', 'th'] | False |
XAxis.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\"",
"]"
] | [
1684,
4
] | [
1695,
36
] | python | en | ['en', 'error', 'th'] | False |
XAxis.__init__ | (
self,
arg=None,
autorange=None,
backgroundcolor=None,
calendar=None,
categoryarray=None,
categoryarraysrc=None,
categoryorder=None,
color=None,
dtick=None,
exponentformat=None,
gridcolor=None,
gridwidth=None,
... |
Construct a new XAxis object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of
:class:`plotly.graph_objs.layout.scene.XAxis`
autorange
Determines whether or not the range of th... |
Construct a new XAxis object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of
:class:`plotly.graph_objs.layout.scene.XAxis`
autorange
Determines whether or not the range of th... | def __init__(
self,
arg=None,
autorange=None,
backgroundcolor=None,
calendar=None,
categoryarray=None,
categoryarraysrc=None,
categoryorder=None,
color=None,
dtick=None,
exponentformat=None,
gridcolor=None,
gridwidth... | [
"def",
"__init__",
"(",
"self",
",",
"arg",
"=",
"None",
",",
"autorange",
"=",
"None",
",",
"backgroundcolor",
"=",
"None",
",",
"calendar",
"=",
"None",
",",
"categoryarray",
"=",
"None",
",",
"categoryarraysrc",
"=",
"None",
",",
"categoryorder",
"=",
... | [
1969,
4
] | [
2558,
34
] | python | en | ['en', 'error', 'th'] | False |
main | () | Benchmark between async and synchronous inference interfaces.
Sample runs for 20 demo images on K80 GPU, model - mask_rcnn_r50_fpn_1x:
async sync
7981.79 ms 9660.82 ms
8074.52 ms 9660.94 ms
7976.44 ms 9406.83 ms
Async variant takes about 0.83-0.85 of the time of the synchronous
... | Benchmark between async and synchronous inference interfaces. | async def main():
"""Benchmark between async and synchronous inference interfaces.
Sample runs for 20 demo images on K80 GPU, model - mask_rcnn_r50_fpn_1x:
async sync
7981.79 ms 9660.82 ms
8074.52 ms 9660.94 ms
7976.44 ms 9406.83 ms
Async variant takes about 0.83-0.85 of the tim... | [
"async",
"def",
"main",
"(",
")",
":",
"project_dir",
"=",
"os",
".",
"path",
".",
"abspath",
"(",
"os",
".",
"path",
".",
"dirname",
"(",
"os",
".",
"path",
".",
"dirname",
"(",
"__file__",
")",
")",
")",
"config_file",
"=",
"os",
".",
"path",
"... | [
14,
0
] | [
95,
61
] | python | en | ['en', 'en', 'en'] | True |
setup_args | () |
Set up args.
|
Set up args.
| def setup_args():
"""
Set up args.
"""
parser = ParlaiParser(False, False)
parser.add_parlai_data_path()
cc = parser.add_argument_group('Download Support Docs')
cc.add_argument(
'-nw',
'--slsize',
default=716,
type=int,
metavar='N',
help='numbe... | [
"def",
"setup_args",
"(",
")",
":",
"parser",
"=",
"ParlaiParser",
"(",
"False",
",",
"False",
")",
"parser",
".",
"add_parlai_data_path",
"(",
")",
"cc",
"=",
"parser",
".",
"add_argument_group",
"(",
"'Download Support Docs'",
")",
"cc",
".",
"add_argument",... | [
58,
0
] | [
130,
30
] | python | en | ['en', 'error', 'th'] | False |
Marker.color | (self) |
Sets the marker color of selected points.
The 'color' 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%... |
Sets the marker color of selected points.
The 'color' 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%... | def color(self):
"""
Sets the marker color of selected points.
The 'color' 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",
"color",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"color\"",
"]"
] | [
15,
4
] | [
65,
28
] | python | en | ['en', 'error', 'th'] | False |
Marker.opacity | (self) |
Sets the marker opacity of selected points.
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 marker opacity of selected points.
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 marker opacity of selected points.
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\"",
"]"
] | [
74,
4
] | [
85,
30
] | python | en | ['en', 'error', 'th'] | False |
Marker.size | (self) |
Sets the marker size of selected points.
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
int|float
|
Sets the marker size of selected points.
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf] | def size(self):
"""
Sets the marker size of selected points.
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
int|float
"""
return self["size"] | [
"def",
"size",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"size\"",
"]"
] | [
94,
4
] | [
105,
27
] | python | en | ['en', 'error', 'th'] | False |
Marker.__init__ | (self, arg=None, color=None, opacity=None, size=None, **kwargs) |
Construct a new Marker object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of
:class:`plotly.graph_objs.violin.selected.Marker`
color
Sets the marker color of selected points... |
Construct a new Marker object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of
:class:`plotly.graph_objs.violin.selected.Marker`
color
Sets the marker color of selected points... | def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs):
"""
Construct a new Marker object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of
:class:`plotly.graph_objs.vi... | [
"def",
"__init__",
"(",
"self",
",",
"arg",
"=",
"None",
",",
"color",
"=",
"None",
",",
"opacity",
"=",
"None",
",",
"size",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"super",
"(",
"Marker",
",",
"self",
")",
".",
"__init__",
"(",
"\"marke... | [
124,
4
] | [
193,
34
] | python | en | ['en', 'error', 'th'] | False |
Delta.decreasing | (self) |
The 'decreasing' property is an instance of Decreasing
that may be specified as:
- An instance of :class:`plotly.graph_objs.indicator.delta.Decreasing`
- A dict of string/value properties that will be passed
to the Decreasing constructor
Supported dict p... |
The 'decreasing' property is an instance of Decreasing
that may be specified as:
- An instance of :class:`plotly.graph_objs.indicator.delta.Decreasing`
- A dict of string/value properties that will be passed
to the Decreasing constructor
Supported dict p... | def decreasing(self):
"""
The 'decreasing' property is an instance of Decreasing
that may be specified as:
- An instance of :class:`plotly.graph_objs.indicator.delta.Decreasing`
- A dict of string/value properties that will be passed
to the Decreasing constructor
... | [
"def",
"decreasing",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"decreasing\"",
"]"
] | [
23,
4
] | [
42,
33
] | python | en | ['en', 'error', 'th'] | False |
Delta.font | (self) |
Set the font used to display the delta
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.indicator.delta.Font`
- A dict of string/value properties that will be passed
to the Font constructor
... |
Set the font used to display the delta
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.indicator.delta.Font`
- A dict of string/value properties that will be passed
to the Font constructor
... | def font(self):
"""
Set the font used to display the delta
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.indicator.delta.Font`
- A dict of string/value properties that will be passed
to... | [
"def",
"font",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"font\"",
"]"
] | [
51,
4
] | [
88,
27
] | python | en | ['en', 'error', 'th'] | False |
Delta.increasing | (self) |
The 'increasing' property is an instance of Increasing
that may be specified as:
- An instance of :class:`plotly.graph_objs.indicator.delta.Increasing`
- A dict of string/value properties that will be passed
to the Increasing constructor
Supported dict p... |
The 'increasing' property is an instance of Increasing
that may be specified as:
- An instance of :class:`plotly.graph_objs.indicator.delta.Increasing`
- A dict of string/value properties that will be passed
to the Increasing constructor
Supported dict p... | def increasing(self):
"""
The 'increasing' property is an instance of Increasing
that may be specified as:
- An instance of :class:`plotly.graph_objs.indicator.delta.Increasing`
- A dict of string/value properties that will be passed
to the Increasing constructor
... | [
"def",
"increasing",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"increasing\"",
"]"
] | [
97,
4
] | [
116,
33
] | python | en | ['en', 'error', 'th'] | False |
Delta.position | (self) |
Sets the position of delta with respect to the number.
The 'position' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'bottom', 'left', 'right']
Returns
-------
Any
|
Sets the position of delta with respect to the number.
The 'position' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'bottom', 'left', 'right'] | def position(self):
"""
Sets the position of delta with respect to the number.
The 'position' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'bottom', 'left', 'right']
Returns
-------
... | [
"def",
"position",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"position\"",
"]"
] | [
125,
4
] | [
137,
31
] | 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.