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 |
|---|---|---|---|---|---|---|---|---|---|---|---|
Tournament.add_participant | (self, display_name: str = None, username: str = None, email: str = None, seed: int = 0, misc: str = None, **params) | add a participant to the tournament
|methcoro|
Args:
display_name: The name displayed in the bracket/schedule - not required if email or challonge_username is provided. Must be unique per tournament.
username: Provide this if the participant has a Challonge account. He or she ... | add a participant to the tournament | async def add_participant(self, display_name: str = None, username: str = None, email: str = None, seed: int = 0, misc: str = None, **params):
""" add a participant to the tournament
|methcoro|
Args:
display_name: The name displayed in the bracket/schedule - not required if email o... | [
"async",
"def",
"add_participant",
"(",
"self",
",",
"display_name",
":",
"str",
"=",
"None",
",",
"username",
":",
"str",
"=",
"None",
",",
"email",
":",
"str",
"=",
"None",
",",
"seed",
":",
"int",
"=",
"0",
",",
"misc",
":",
"str",
"=",
"None",
... | [
576,
4
] | [
616,
20
] | python | en | ['en', 'en', 'en'] | True |
Tournament.add_participants | (self, *names: str) |
|methcoro|
Warnings:
|inprogress|
Raises:
APIException
| async def add_participants(self, *names: str) -> list:
"""
|methcoro|
Warnings:
|inprogress|
Raises:
APIException
"""
params = {'name': list(names)}
res = await self.connection('POST',
'tournaments/{}... | [
"async",
"def",
"add_participants",
"(",
"self",
",",
"*",
"names",
":",
"str",
")",
"->",
"list",
":",
"params",
"=",
"{",
"'name'",
":",
"list",
"(",
"names",
")",
"}",
"res",
"=",
"await",
"self",
".",
"connection",
"(",
"'POST'",
",",
"'tournamen... | [
618,
4
] | [
635,
49
] | python | en | ['en', 'error', 'th'] | False | |
Tournament.remove_participant | (self, p: Participant) | remove a participant from the tournament
|methcoro|
Args:
p: the participant to remove
Raises:
APIException
| remove a participant from the tournament | async def remove_participant(self, p: Participant):
""" remove a participant from the tournament
|methcoro|
Args:
p: the participant to remove
Raises:
APIException
"""
await self.connection('DELETE', 'tournaments/{}/participants/{}'.format(self... | [
"async",
"def",
"remove_participant",
"(",
"self",
",",
"p",
":",
"Participant",
")",
":",
"await",
"self",
".",
"connection",
"(",
"'DELETE'",
",",
"'tournaments/{}/participants/{}'",
".",
"format",
"(",
"self",
".",
"_id",
",",
"p",
".",
"_id",
")",
")",... | [
637,
4
] | [
651,
39
] | python | en | ['en', 'en', 'en'] | True |
Tournament.get_match | (self, m_id, force_update=False) | get a single match by id
|methcoro|
Args:
m_id: match id
force_update (default=False): True to force an update to the Challonge API
Returns:
Match
Raises:
APIException
| get a single match by id | async def get_match(self, m_id, force_update=False) -> Match:
""" get a single match by id
|methcoro|
Args:
m_id: match id
force_update (default=False): True to force an update to the Challonge API
Returns:
Match
Raises:
APIExce... | [
"async",
"def",
"get_match",
"(",
"self",
",",
"m_id",
",",
"force_update",
"=",
"False",
")",
"->",
"Match",
":",
"found_m",
"=",
"self",
".",
"_find_match",
"(",
"m_id",
")",
"if",
"force_update",
"or",
"found_m",
"is",
"None",
":",
"await",
"self",
... | [
653,
4
] | [
673,
22
] | python | en | ['en', 'en', 'en'] | True |
Tournament.get_matches | (self, force_update=False) | get all matches (once the tournament is started)
|methcoro|
Args:
force_update (default=False): True to force an update to the Challonge API
Returns:
list[Match]:
Raises:
APIException
| get all matches (once the tournament is started) | async def get_matches(self, force_update=False) -> list:
""" get all matches (once the tournament is started)
|methcoro|
Args:
force_update (default=False): True to force an update to the Challonge API
Returns:
list[Match]:
Raises:
APIExcep... | [
"async",
"def",
"get_matches",
"(",
"self",
",",
"force_update",
"=",
"False",
")",
"->",
"list",
":",
"if",
"force_update",
"or",
"self",
".",
"matches",
"is",
"None",
":",
"res",
"=",
"await",
"self",
".",
"connection",
"(",
"'GET'",
",",
"'tournaments... | [
675,
4
] | [
695,
33
] | python | en | ['en', 'en', 'en'] | True |
Tournament.shuffle_participants | (self) | Shuffle participants' seeds
|methcoro|
Note:
|from_api| Randomize seeds among participants. Only applicable before a tournament has started.
Raises:
APIException
| Shuffle participants' seeds | async def shuffle_participants(self):
""" Shuffle participants' seeds
|methcoro|
Note:
|from_api| Randomize seeds among participants. Only applicable before a tournament has started.
Raises:
APIException
"""
res = await self.connection('POST', ... | [
"async",
"def",
"shuffle_participants",
"(",
"self",
")",
":",
"res",
"=",
"await",
"self",
".",
"connection",
"(",
"'POST'",
",",
"'tournaments/{}/participants/randomize'",
".",
"format",
"(",
"self",
".",
"_id",
")",
")",
"self",
".",
"_refresh_participants_fr... | [
697,
4
] | [
710,
49
] | python | en | ['it', 'en', 'en'] | True |
Tournament.process_check_ins | (self) | finalize the check in phase
|methcoro|
Warning:
|unstable|
Note:
|from_api| This should be invoked after a tournament's check-in window closes before the tournament is started.
1. Marks participants who have not checked in as inactive.
2. Moves... | finalize the check in phase | async def process_check_ins(self):
""" finalize the check in phase
|methcoro|
Warning:
|unstable|
Note:
|from_api| This should be invoked after a tournament's check-in window closes before the tournament is started.
1. Marks participants who have no... | [
"async",
"def",
"process_check_ins",
"(",
"self",
")",
":",
"params",
"=",
"{",
"'include_participants'",
":",
"1",
",",
"# forced to 1 since we need to update the Participant instances",
"'include_matches'",
":",
"1",
"if",
"AUTO_GET_MATCHES",
"else",
"0",
"}",
"res",
... | [
712,
4
] | [
736,
36
] | python | en | ['en', 'en', 'en'] | True |
Tournament.abort_check_in | (self) | Abort the check in process
|methcoro|
Warning:
|unstable|
Note:
|from_api| When your tournament is in a 'checking_in' or 'checked_in' state, there's no way to edit the tournament's start time (start_at) or check-in duration (check_in_duration). You must first abort ch... | Abort the check in process | async def abort_check_in(self):
""" Abort the check in process
|methcoro|
Warning:
|unstable|
Note:
|from_api| When your tournament is in a 'checking_in' or 'checked_in' state, there's no way to edit the tournament's start time (start_at) or check-in duration (... | [
"async",
"def",
"abort_check_in",
"(",
"self",
")",
":",
"params",
"=",
"{",
"'include_participants'",
":",
"1",
",",
"# forced to 1 since we need to update the Participant instances",
"'include_matches'",
":",
"1",
"if",
"AUTO_GET_MATCHES",
"else",
"0",
"}",
"res",
"... | [
738,
4
] | [
760,
36
] | python | en | ['en', 'en', 'en'] | True |
Tournament.get_final_ranking | (self) | Get the ordered players ranking
Returns:
collections.OrderedDict[rank, List[Participant]]:
Raises:
APIException
| Get the ordered players ranking | async def get_final_ranking(self) -> OrderedDict:
""" Get the ordered players ranking
Returns:
collections.OrderedDict[rank, List[Participant]]:
Raises:
APIException
"""
if self._state != TournamentState.complete.value:
return None
... | [
"async",
"def",
"get_final_ranking",
"(",
"self",
")",
"->",
"OrderedDict",
":",
"if",
"self",
".",
"_state",
"!=",
"TournamentState",
".",
"complete",
".",
"value",
":",
"return",
"None",
"ranking",
"=",
"{",
"}",
"for",
"p",
"in",
"self",
".",
"partici... | [
762,
4
] | [
782,
71
] | python | en | ['en', 'en', 'en'] | True |
convert_serializable_special_cases | (o) |
Convert an object to a type that is fairly generally serializable (e.g. json serializable).
This only handles the cases that need converting. The json module handles all the rest.
For JSON, with json.dump or json.dumps with argument default=convert_serializable.
Example:
json.dumps(my_animal, inde... |
Convert an object to a type that is fairly generally serializable (e.g. json serializable).
This only handles the cases that need converting. The json module handles all the rest.
For JSON, with json.dump or json.dumps with argument default=convert_serializable.
Example:
json.dumps(my_animal, inde... | def convert_serializable_special_cases(o):
"""
Convert an object to a type that is fairly generally serializable (e.g. json serializable).
This only handles the cases that need converting. The json module handles all the rest.
For JSON, with json.dump or json.dumps with argument default=convert_seriali... | [
"def",
"convert_serializable_special_cases",
"(",
"o",
")",
":",
"if",
"isinstance",
"(",
"o",
",",
"Enum",
")",
":",
"serializable_representation",
"=",
"o",
".",
"name",
"elif",
"isinstance",
"(",
"o",
",",
"Decimal",
")",
":",
"# decimal.Decimal (e.g. in AWS ... | [
53,
0
] | [
88,
38
] | python | en | ['en', 'error', 'th'] | False |
dynamodb_to_json | (item, indent=None) |
Convert a DynamoDB item to JSON
:param item: DynamoDB item
:param indent: JSON indent
:return: JSON encoded string
|
Convert a DynamoDB item to JSON | def dynamodb_to_json(item, indent=None) -> str:
"""
Convert a DynamoDB item to JSON
:param item: DynamoDB item
:param indent: JSON indent
:return: JSON encoded string
"""
return json.dumps(item, default=convert_serializable_special_cases, sort_keys=True, indent=indent) | [
"def",
"dynamodb_to_json",
"(",
"item",
",",
"indent",
"=",
"None",
")",
"->",
"str",
":",
"return",
"json",
".",
"dumps",
"(",
"item",
",",
"default",
"=",
"convert_serializable_special_cases",
",",
"sort_keys",
"=",
"True",
",",
"indent",
"=",
"indent",
... | [
92,
0
] | [
100,
102
] | python | en | ['en', 'error', 'th'] | False |
dynamodb_to_dict | (item) |
Convert a DynamoDB item to a serializable dict
:param item: DynamoDB item
:return: serializable dict
| def dynamodb_to_dict(item) -> dict:
"""
Convert a DynamoDB item to a serializable dict
:param item: DynamoDB item
:return: serializable dict
"""
return json.loads(dynamodb_to_json(item)) | [
"def",
"dynamodb_to_dict",
"(",
"item",
")",
"->",
"dict",
":",
"return",
"json",
".",
"loads",
"(",
"dynamodb_to_json",
"(",
"item",
")",
")"
] | [
104,
0
] | [
113,
45
] | python | en | ['en', 'error', 'th'] | False | |
dict_to_dynamodb | (input_value: Any, convert_images: bool = True, raise_exception: bool = True) |
makes a dictionary follow boto3 item standards
:param input_value: input dictionary
:param convert_images: set to False to skip over images (they can be too large)
:param raise_exception: set to False to not raise exceptions on issues
:return: converted version of the original dictionary
|
makes a dictionary follow boto3 item standards | def dict_to_dynamodb(input_value: Any, convert_images: bool = True, raise_exception: bool = True) -> Any:
"""
makes a dictionary follow boto3 item standards
:param input_value: input dictionary
:param convert_images: set to False to skip over images (they can be too large)
:param raise_exception: s... | [
"def",
"dict_to_dynamodb",
"(",
"input_value",
":",
"Any",
",",
"convert_images",
":",
"bool",
"=",
"True",
",",
"raise_exception",
":",
"bool",
"=",
"True",
")",
"->",
"Any",
":",
"resp",
"=",
"None",
"# type: Any",
"if",
"type",
"(",
"input_value",
")",
... | [
117,
0
] | [
169,
15
] | python | en | ['en', 'error', 'th'] | False |
setup | (bot) |
Mandatory function to add the Cog to the bot.
|
Mandatory function to add the Cog to the bot.
| def setup(bot):
"""
Mandatory function to add the Cog to the bot.
"""
bot.add_cog(SubscriptionCog(bot)) | [
"def",
"setup",
"(",
"bot",
")",
":",
"bot",
".",
"add_cog",
"(",
"SubscriptionCog",
"(",
"bot",
")",
")"
] | [
669,
0
] | [
673,
37
] | python | en | ['en', 'error', 'th'] | False |
SubscriptionCog.create_subscription_channel_header | (self, ctx: commands.Context) |
Creates the Header on top of the subscription channel.
This will only be called once in normal circumstances, use "update_subscription_channel_header" to update the header afterwards.
Takes the actual text and images from the Config.
Example:
@AntiPetros create_subscriptio... |
Creates the Header on top of the subscription channel. | async def create_subscription_channel_header(self, ctx: commands.Context):
"""
Creates the Header on top of the subscription channel.
This will only be called once in normal circumstances, use "update_subscription_channel_header" to update the header afterwards.
Takes the actual text an... | [
"async",
"def",
"create_subscription_channel_header",
"(",
"self",
",",
"ctx",
":",
"commands",
".",
"Context",
")",
":",
"embed_data",
"=",
"await",
"self",
".",
"_create_topic_subscription_header_embed",
"(",
")",
"header_message",
"=",
"await",
"self",
".",
"su... | [
286,
4
] | [
299,
49
] | python | en | ['en', 'error', 'th'] | False |
SubscriptionCog.update_subscription_channel_header | (self, ctx: commands.Context) |
Updates the Header on top of the subscription channel.
Takes the text and image data from the Config (Cogs_Config.ini) and updates the Header message in-place.
Example:
@AntiPetros update_subscription_channel_header
|
Updates the Header on top of the subscription channel. | async def update_subscription_channel_header(self, ctx: commands.Context):
"""
Updates the Header on top of the subscription channel.
Takes the text and image data from the Config (Cogs_Config.ini) and updates the Header message in-place.
Example:
@AntiPetros update_subscri... | [
"async",
"def",
"update_subscription_channel_header",
"(",
"self",
",",
"ctx",
":",
"commands",
".",
"Context",
")",
":",
"embed_data",
"=",
"await",
"self",
".",
"_create_topic_subscription_header_embed",
"(",
")",
"header_message",
"=",
"await",
"self",
".",
"_g... | [
303,
4
] | [
315,
49
] | python | en | ['en', 'error', 'th'] | False |
SubscriptionCog.remove_topic | (self, ctx: commands.context, topic_name: str) |
Removes an existing Topic from the subscription channel and deletes the associated role.
All user that are subscribed to the Topic will be automatically informed of its removal.
This command will ask for conformation, before deleting the topic.
Args:
topic_name (str): Name... |
Removes an existing Topic from the subscription channel and deletes the associated role. | async def remove_topic(self, ctx: commands.context, topic_name: str):
"""
Removes an existing Topic from the subscription channel and deletes the associated role.
All user that are subscribed to the Topic will be automatically informed of its removal.
This command will ask for conformat... | [
"async",
"def",
"remove_topic",
"(",
"self",
",",
"ctx",
":",
"commands",
".",
"context",
",",
"topic_name",
":",
"str",
")",
":",
"topic_item",
"=",
"{",
"item",
".",
"name",
".",
"casefold",
"(",
")",
":",
"item",
"for",
"item",
"in",
"self",
".",
... | [
319,
4
] | [
342,
92
] | python | en | ['en', 'error', 'th'] | False |
SubscriptionCog.new_topic | (self, ctx: commands.Context, topic_creator_id: int = None) |
Creates a new Topic from an File.
The new topic data gets parsed out of the input file, if no topic_creator_id is specified, it defaults to the person invoking the command.
The file needs to be send as attachment to the invoking message.
Args:
topic_creator_id (int, option... |
Creates a new Topic from an File. | async def new_topic(self, ctx: commands.Context, topic_creator_id: int = None):
"""
Creates a new Topic from an File.
The new topic data gets parsed out of the input file, if no topic_creator_id is specified, it defaults to the person invoking the command.
The file needs to be send as a... | [
"async",
"def",
"new_topic",
"(",
"self",
",",
"ctx",
":",
"commands",
".",
"Context",
",",
"topic_creator_id",
":",
"int",
"=",
"None",
")",
":",
"if",
"self",
".",
"subscription_channel",
"is",
"None",
":",
"await",
"ctx",
".",
"send",
"(",
"'No subscr... | [
347,
4
] | [
403,
82
] | python | en | ['en', 'error', 'th'] | False |
SubscriptionCog.modify_topic_embed | (self, ctx: commands.Context, topic_name: str, setting: str, value: str) |
**UNTESTED** - Modifies an attribute of an topic in place - **UNTESTED**
Args:
topic_name (str): Name of the existing Topic, case-insensitive.
setting (str): The name of the attribute to modify
value (str): the new value, needs to be put in quotes (`"`) if it conta... |
**UNTESTED** - Modifies an attribute of an topic in place - **UNTESTED** | async def modify_topic_embed(self, ctx: commands.Context, topic_name: str, setting: str, value: str):
"""
**UNTESTED** - Modifies an attribute of an topic in place - **UNTESTED**
Args:
topic_name (str): Name of the existing Topic, case-insensitive.
setting (str): The na... | [
"async",
"def",
"modify_topic_embed",
"(",
"self",
",",
"ctx",
":",
"commands",
".",
"Context",
",",
"topic_name",
":",
"str",
",",
"setting",
":",
"str",
",",
"value",
":",
"str",
")",
":",
"allowed_setting_names",
"=",
"[",
"'color'",
",",
"'image'",
"... | [
407,
4
] | [
428,
37
] | python | en | ['en', 'error', 'th'] | False |
SubscriptionCog.unsubscribe | (self, ctx: commands.Context, topic_name: str) |
Unsubscribes a user from a topic via command.
This is an alternative to just removing the emoji on the topic embed.
Args:
topic_name (str): Name of the topic to unsubscribe, case-insensitive, needs to be put in quotes (`"`) if it contains spaces.
Example:
@Ant... |
Unsubscribes a user from a topic via command. | async def unsubscribe(self, ctx: commands.Context, topic_name: str):
"""
Unsubscribes a user from a topic via command.
This is an alternative to just removing the emoji on the topic embed.
Args:
topic_name (str): Name of the topic to unsubscribe, case-insensitive, needs to ... | [
"async",
"def",
"unsubscribe",
"(",
"self",
",",
"ctx",
":",
"commands",
".",
"Context",
",",
"topic_name",
":",
"str",
")",
":",
"topic_item",
"=",
"{",
"item",
".",
"name",
".",
"casefold",
"(",
")",
":",
"item",
"for",
"item",
"in",
"self",
".",
... | [
432,
4
] | [
456,
64
] | python | en | ['en', 'error', 'th'] | False |
SubscriptionCog.topic_template | (self, ctx: commands.Context, with_example: str = None) |
Provides an template file and instructions for topic creation.
File contains all possible topic attributes that can be set. Optionaly includes a second, filled out file as an example.
Args:
with_example (str, optional): if this parameter is "example", a second filled out filled is... |
Provides an template file and instructions for topic creation. | async def topic_template(self, ctx: commands.Context, with_example: str = None):
"""
Provides an template file and instructions for topic creation.
File contains all possible topic attributes that can be set. Optionaly includes a second, filled out file as an example.
Args:
... | [
"async",
"def",
"topic_template",
"(",
"self",
",",
"ctx",
":",
"commands",
".",
"Context",
",",
"with_example",
":",
"str",
"=",
"None",
")",
":",
"embed_data",
"=",
"await",
"self",
".",
"bot",
".",
"make_generic_embed",
"(",
"title",
"=",
"\"Topic Templ... | [
460,
4
] | [
493,
46
] | python | en | ['en', 'error', 'th'] | False |
SubscriptionCog._create_topic_role | (self, topic_item: TopicItem) |
Creates the new subscriber role.
Role has not permissions, but is mentionable.
Args:
topic_item (`TopicItem`): The container holding the Topic information.
|
Creates the new subscriber role. | async def _create_topic_role(self, topic_item: TopicItem):
"""
Creates the new subscriber role.
Role has not permissions, but is mentionable.
Args:
topic_item (`TopicItem`): The container holding the Topic information.
"""
log.debug(f"Trying to create role ... | [
"async",
"def",
"_create_topic_role",
"(",
"self",
",",
"topic_item",
":",
"TopicItem",
")",
":",
"log",
".",
"debug",
"(",
"f\"Trying to create role '{topic_item.name}_Subscriber'\"",
")",
"new_role",
"=",
"await",
"self",
".",
"bot",
".",
"antistasi_guild",
".",
... | [
549,
4
] | [
563,
75
] | python | en | ['en', 'error', 'th'] | False |
main | (config) |
Creates .stitched files from .suggested files.
input: a .suggested file of logs (in ParlaiDialog format) from Mturk task 2, each of
which starts with an initial prompt or topic request, and ends with a y
that corresponds to the y_exp given in the previous turn
output: a .stitched file (in ... |
Creates .stitched files from .suggested files. | def main(config):
"""
Creates .stitched files from .suggested files.
input: a .suggested file of logs (in ParlaiDialog format) from Mturk task 2, each of
which starts with an initial prompt or topic request, and ends with a y
that corresponds to the y_exp given in the previous turn
outp... | [
"def",
"main",
"(",
"config",
")",
":",
"examples",
"=",
"[",
"]",
"episodes",
"=",
"[",
"e",
"for",
"e",
"in",
"extract_parlai_episodes",
"(",
"config",
"[",
"'infile'",
"]",
")",
"]",
"for",
"episode",
"in",
"episodes",
":",
"history",
"=",
"[",
"]... | [
25,
0
] | [
70,
5
] | python | en | ['en', 'error', 'th'] | False |
Hoverlabel.align | (self) |
Sets the horizontal alignment of the text content within hover
label box. Has an effect only if the hover label text spans
more two or more lines
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['... |
Sets the horizontal alignment of the text content within hover
label box. Has an effect only if the hover label text spans
more two or more lines
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['... | def align(self):
"""
Sets the horizontal alignment of the text content within hover
label box. Has an effect only if the hover label text spans
more two or more lines
The 'align' property is an enumeration that may be specified as:
- One of the following enumeratio... | [
"def",
"align",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"align\"",
"]"
] | [
25,
4
] | [
40,
28
] | python | en | ['en', 'error', 'th'] | False |
Hoverlabel.alignsrc | (self) |
Sets the source reference on Chart Studio Cloud for align .
The 'alignsrc' 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 align .
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object | def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["alignsrc"] | [
"def",
"alignsrc",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"alignsrc\"",
"]"
] | [
49,
4
] | [
60,
31
] | python | en | ['en', 'error', 'th'] | False |
Hoverlabel.bgcolor | (self) |
Sets the background color of the hover labels for this trace
The 'bgcolor' 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 str... |
Sets the background color of the hover labels for this trace
The 'bgcolor' 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 str... | def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
The 'bgcolor' 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",
"bgcolor",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"bgcolor\"",
"]"
] | [
69,
4
] | [
120,
30
] | python | en | ['en', 'error', 'th'] | False |
Hoverlabel.bgcolorsrc | (self) |
Sets the source reference on Chart Studio Cloud for bgcolor .
The 'bgcolorsrc' 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 bgcolor .
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object | def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["bgcolorsrc"] | [
"def",
"bgcolorsrc",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"bgcolorsrc\"",
"]"
] | [
129,
4
] | [
140,
33
] | python | en | ['en', 'error', 'th'] | False |
Hoverlabel.bordercolor | (self) |
Sets the border color of the hover labels for this trace.
The 'bordercolor' 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 st... |
Sets the border color of the hover labels for this trace.
The 'bordercolor' 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 st... | def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
The 'bordercolor' 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%... | [
"def",
"bordercolor",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"bordercolor\"",
"]"
] | [
149,
4
] | [
200,
34
] | python | en | ['en', 'error', 'th'] | False |
Hoverlabel.bordercolorsrc | (self) |
Sets the source reference on Chart Studio Cloud for
bordercolor .
The 'bordercolorsrc' 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
bordercolor .
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object | def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["bo... | [
"def",
"bordercolorsrc",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"bordercolorsrc\"",
"]"
] | [
209,
4
] | [
221,
37
] | python | en | ['en', 'error', 'th'] | False |
Hoverlabel.font | (self) |
Sets the font used in hover labels.
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.sankey.link.hoverlabel.Font`
- A dict of string/value properties that will be passed
to the Font constructor
... |
Sets the font used in hover labels.
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.sankey.link.hoverlabel.Font`
- A dict of string/value properties that will be passed
to the Font constructor
... | def font(self):
"""
Sets the font used in hover labels.
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.sankey.link.hoverlabel.Font`
- A dict of string/value properties that will be passed
... | [
"def",
"font",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"font\"",
"]"
] | [
230,
4
] | [
277,
27
] | python | en | ['en', 'error', 'th'] | False |
Hoverlabel.namelength | (self) |
Sets the default length (in number of characters) of the trace
name in the hover labels for all traces. -1 shows the whole
name regardless of length. 0-3 shows the first 0-3 characters,
and an integer >3 will show the whole name if it is less than
that many characters, but if it... |
Sets the default length (in number of characters) of the trace
name in the hover labels for all traces. -1 shows the whole
name regardless of length. 0-3 shows the first 0-3 characters,
and an integer >3 will show the whole name if it is less than
that many characters, but if it... | def namelength(self):
"""
Sets the default length (in number of characters) of the trace
name in the hover labels for all traces. -1 shows the whole
name regardless of length. 0-3 shows the first 0-3 characters,
and an integer >3 will show the whole name if it is less than
... | [
"def",
"namelength",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"namelength\"",
"]"
] | [
286,
4
] | [
304,
33
] | python | en | ['en', 'error', 'th'] | False |
Hoverlabel.namelengthsrc | (self) |
Sets the source reference on Chart Studio Cloud for namelength
.
The 'namelengthsrc' 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 namelength
.
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object | def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["name... | [
"def",
"namelengthsrc",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"namelengthsrc\"",
"]"
] | [
313,
4
] | [
325,
36
] | python | en | ['en', 'error', 'th'] | False |
Hoverlabel.__init__ | (
self,
arg=None,
align=None,
alignsrc=None,
bgcolor=None,
bgcolorsrc=None,
bordercolor=None,
bordercolorsrc=None,
font=None,
namelength=None,
namelengthsrc=None,
**kwargs
) |
Construct a new Hoverlabel object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of
:class:`plotly.graph_objs.sankey.link.Hoverlabel`
align
Sets the horizontal alignment of the... |
Construct a new Hoverlabel object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of
:class:`plotly.graph_objs.sankey.link.Hoverlabel`
align
Sets the horizontal alignment of the... | def __init__(
self,
arg=None,
align=None,
alignsrc=None,
bgcolor=None,
bgcolorsrc=None,
bordercolor=None,
bordercolorsrc=None,
font=None,
namelength=None,
namelengthsrc=None,
**kwargs
):
"""
Construct a n... | [
"def",
"__init__",
"(",
"self",
",",
"arg",
"=",
"None",
",",
"align",
"=",
"None",
",",
"alignsrc",
"=",
"None",
",",
"bgcolor",
"=",
"None",
",",
"bgcolorsrc",
"=",
"None",
",",
"bordercolor",
"=",
"None",
",",
"bordercolorsrc",
"=",
"None",
",",
"... | [
370,
4
] | [
502,
34
] | python | en | ['en', 'error', 'th'] | False |
Tickformatstop.dtickrange | (self) |
range [*min*, *max*], where "min", "max" - dtick values which
describe some zoom level, it is possible to omit "min" or "max"
value by passing "null"
The 'dtickrange' property is an info array that may be specified as:
* a list or tuple of 2 elements where:
(0) The... |
range [*min*, *max*], where "min", "max" - dtick values which
describe some zoom level, it is possible to omit "min" or "max"
value by passing "null"
The 'dtickrange' property is an info array that may be specified as:
* a list or tuple of 2 elements where:
(0) The... | def dtickrange(self):
"""
range [*min*, *max*], where "min", "max" - dtick values which
describe some zoom level, it is possible to omit "min" or "max"
value by passing "null"
The 'dtickrange' property is an info array that may be specified as:
* a list or tuple... | [
"def",
"dtickrange",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"dtickrange\"",
"]"
] | [
15,
4
] | [
31,
33
] | python | en | ['en', 'error', 'th'] | False |
Tickformatstop.enabled | (self) |
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
The 'enabled' property must be specified as a bool
(either True, or False)
Returns
-------
bool
|
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
The 'enabled' property must be specified as a bool
(either True, or False) | def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
The 'enabled' property must be specified as a bool
(either True, or False)
Returns
-------
bool
"""
ret... | [
"def",
"enabled",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"enabled\"",
"]"
] | [
40,
4
] | [
52,
30
] | python | en | ['en', 'error', 'th'] | False |
Tickformatstop.name | (self) |
When used in a template, named items are created in the output
figure in addition to any items the figure already has in this
array. You can modify these items in the output figure by
making your own item with `templateitemname` matching this
`name` alongside your modifications ... |
When used in a template, named items are created in the output
figure in addition to any items the figure already has in this
array. You can modify these items in the output figure by
making your own item with `templateitemname` matching this
`name` alongside your modifications ... | def name(self):
"""
When used in a template, named items are created in the output
figure in addition to any items the figure already has in this
array. You can modify these items in the output figure by
making your own item with `templateitemname` matching this
`name` al... | [
"def",
"name",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"name\"",
"]"
] | [
61,
4
] | [
79,
27
] | python | en | ['en', 'error', 'th'] | False |
Tickformatstop.templateitemname | (self) |
Used to refer to a named item in this array in the template.
Named items from the template will be created even without a
matching item in the input figure, but you can modify one by
making an item with `templateitemname` matching its `name`,
alongside your modifications (includ... |
Used to refer to a named item in this array in the template.
Named items from the template will be created even without a
matching item in the input figure, but you can modify one by
making an item with `templateitemname` matching its `name`,
alongside your modifications (includ... | def templateitemname(self):
"""
Used to refer to a named item in this array in the template.
Named items from the template will be created even without a
matching item in the input figure, but you can modify one by
making an item with `templateitemname` matching its `name`,
... | [
"def",
"templateitemname",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"templateitemname\"",
"]"
] | [
88,
4
] | [
107,
39
] | python | en | ['en', 'error', 'th'] | False |
Tickformatstop.value | (self) |
string - dtickformat for described zoom level, the same as
"tickformat"
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
Returns
-------
str
|
string - dtickformat for described zoom level, the same as
"tickformat"
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string | def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
Returns
-------
str
"... | [
"def",
"value",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"value\"",
"]"
] | [
116,
4
] | [
129,
28
] | python | en | ['en', 'error', 'th'] | False |
Tickformatstop.__init__ | (
self,
arg=None,
dtickrange=None,
enabled=None,
name=None,
templateitemname=None,
value=None,
**kwargs
) |
Construct a new Tickformatstop object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of :class:`plotly.graph_objs.funnel.marker.
colorbar.Tickformatstop`
dtickrange
range [*min... |
Construct a new Tickformatstop object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of :class:`plotly.graph_objs.funnel.marker.
colorbar.Tickformatstop`
dtickrange
range [*min... | def __init__(
self,
arg=None,
dtickrange=None,
enabled=None,
name=None,
templateitemname=None,
value=None,
**kwargs
):
"""
Construct a new Tickformatstop object
Parameters
----------
arg
dict... | [
"def",
"__init__",
"(",
"self",
",",
"arg",
"=",
"None",
",",
"dtickrange",
"=",
"None",
",",
"enabled",
"=",
"None",
",",
"name",
"=",
"None",
",",
"templateitemname",
"=",
"None",
",",
"value",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"sup... | [
172,
4
] | [
282,
34
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.bgcolor | (self) |
Sets the color of padded area.
The 'bgcolor' 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 padded area.
The 'bgcolor' 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 bgcolor(self):
"""
Sets the color of padded area.
The 'bgcolor' 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 str... | [
"def",
"bgcolor",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"bgcolor\"",
"]"
] | [
59,
4
] | [
109,
30
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.bordercolor | (self) |
Sets the axis line color.
The 'bordercolor' 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 'bordercolor' 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 bordercolor(self):
"""
Sets the axis line color.
The 'bordercolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
- An hsv/hsva ... | [
"def",
"bordercolor",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"bordercolor\"",
"]"
] | [
118,
4
] | [
168,
34
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.borderwidth | (self) |
Sets the width (in px) or the border enclosing this color bar.
The 'borderwidth' 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) or the border enclosing this color bar.
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf] | def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
int|float
"""
return self["... | [
"def",
"borderwidth",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"borderwidth\"",
"]"
] | [
177,
4
] | [
188,
34
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.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\"",
"]"
] | [
197,
4
] | [
226,
28
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.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\"",
"]"
] | [
235,
4
] | [
251,
37
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.len | (self) |
Sets the length of the color bar This measure excludes the
padding of both ends. That is, the color bar length is this
length minus the padding on both ends.
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Return... |
Sets the length of the color bar This measure excludes the
padding of both ends. That is, the color bar length is this
length minus the padding on both ends.
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf] | def len(self):
"""
Sets the length of the color bar This measure excludes the
padding of both ends. That is, the color bar length is this
length minus the padding on both ends.
The 'len' property is a number and may be specified as:
- An int or float in the interva... | [
"def",
"len",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"len\"",
"]"
] | [
260,
4
] | [
273,
26
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.lenmode | (self) |
Determines whether this color bar's length (i.e. the measure in
the color variation direction) is set in units of plot
"fraction" or in *pixels. Use `len` to set the value.
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumerati... |
Determines whether this color bar's length (i.e. the measure in
the color variation direction) is set in units of plot
"fraction" or in *pixels. Use `len` to set the value.
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumerati... | def lenmode(self):
"""
Determines whether this color bar's length (i.e. the measure in
the color variation direction) is set in units of plot
"fraction" or in *pixels. Use `len` to set the value.
The 'lenmode' property is an enumeration that may be specified as:
- ... | [
"def",
"lenmode",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"lenmode\"",
"]"
] | [
282,
4
] | [
296,
30
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.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\"",
"]"
] | [
305,
4
] | [
320,
29
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.outlinecolor | (self) |
Sets the axis line color.
The 'outlinecolor' 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 'outlinecolor' 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 outlinecolor(self):
"""
Sets the axis line color.
The 'outlinecolor' 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",
"outlinecolor",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"outlinecolor\"",
"]"
] | [
329,
4
] | [
379,
35
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.outlinewidth | (self) |
Sets the width (in px) of the axis line.
The 'outlinewidth' 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 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf] | def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
int|float
"""
return self["outlinewidth"] | [
"def",
"outlinewidth",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"outlinewidth\"",
"]"
] | [
388,
4
] | [
399,
35
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.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\"",
"]"
] | [
408,
4
] | [
419,
40
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.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\"",
"]"
] | [
428,
4
] | [
443,
35
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.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\"",
"]"
] | [
452,
4
] | [
463,
37
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.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\"",
"]"
] | [
472,
4
] | [
487,
37
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.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\"",
"]"
] | [
496,
4
] | [
508,
37
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.thickness | (self) |
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
int|float
|
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf] | def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
i... | [
"def",
"thickness",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"thickness\"",
"]"
] | [
517,
4
] | [
529,
32
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.thicknessmode | (self) |
Determines whether this color bar's thickness (i.e. the measure
in the constant color direction) is set in units of plot
"fraction" or in "pixels". Use `thickness` to set the value.
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the foll... |
Determines whether this color bar's thickness (i.e. the measure
in the constant color direction) is set in units of plot
"fraction" or in "pixels". Use `thickness` to set the value.
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the foll... | def thicknessmode(self):
"""
Determines whether this color bar's thickness (i.e. the measure
in the constant color direction) is set in units of plot
"fraction" or in "pixels". Use `thickness` to set the value.
The 'thicknessmode' property is an enumeration that may be speci... | [
"def",
"thicknessmode",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"thicknessmode\"",
"]"
] | [
538,
4
] | [
552,
36
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.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\"",
"]"
] | [
561,
4
] | [
579,
28
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.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\"",
"]"
] | [
588,
4
] | [
603,
32
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.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\"",
"]"
] | [
612,
4
] | [
662,
32
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.tickfont | (self) |
Sets the color bar's tick label font
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.Tickfont`
- A dict of string/value properties that will be passed
to th... |
Sets the color bar's tick label font
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.Tickfont`
- A dict of string/value properties that will be passed
to th... | def tickfont(self):
"""
Sets the color bar's tick label font
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.Tickfont`
- A dict of string/value properties that w... | [
"def",
"tickfont",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"tickfont\"",
"]"
] | [
671,
4
] | [
708,
31
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.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\"",
"]"
] | [
717,
4
] | [
737,
33
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.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.scattermapbox.marker.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed t... |
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.scattermapbox.marker.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed t... | 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.scattermapbox.marker.colorbar.Tickformatstop
- A list or tuple of dicts of string/value proper... | [
"def",
"tickformatstops",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"tickformatstops\"",
"]"
] | [
746,
4
] | [
794,
38
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.tickformatstopdefaults | (self) |
When used in a template (as layout.template.data.scattermapbox.
marker.colorbar.tickformatstopdefaults), sets the default
property values to use for elements of
scattermapbox.marker.colorbar.tickformatstops
The 'tickformatstopdefaults' property is an instance of Tickformats... |
When used in a template (as layout.template.data.scattermapbox.
marker.colorbar.tickformatstopdefaults), sets the default
property values to use for elements of
scattermapbox.marker.colorbar.tickformatstops
The 'tickformatstopdefaults' property is an instance of Tickformats... | def tickformatstopdefaults(self):
"""
When used in a template (as layout.template.data.scattermapbox.
marker.colorbar.tickformatstopdefaults), sets the default
property values to use for elements of
scattermapbox.marker.colorbar.tickformatstops
The 'tickformatstopdef... | [
"def",
"tickformatstopdefaults",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"tickformatstopdefaults\"",
"]"
] | [
803,
4
] | [
822,
45
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.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\"",
"]"
] | [
831,
4
] | [
842,
30
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.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\"",
"]"
] | [
851,
4
] | [
869,
31
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.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\"",
"]"
] | [
878,
4
] | [
890,
33
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.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\"",
"]"
] | [
899,
4
] | [
913,
28
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.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\"",
"]"
] | [
922,
4
] | [
934,
33
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.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\"",
"]"
] | [
943,
4
] | [
956,
31
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.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\"",
"]"
] | [
965,
4
] | [
976,
34
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.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\"",
"]"
] | [
985,
4
] | [
997,
31
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.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\"",
"]"
] | [
1006,
4
] | [
1017,
34
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.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\"",
"]"
] | [
1026,
4
] | [
1037,
32
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.title | (self) |
The 'title' property is an instance of Title
that may be specified as:
- An instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
Supported dict propert... |
The 'title' property is an instance of Title
that may be specified as:
- An instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
Supported dict propert... | def title(self):
"""
The 'title' property is an instance of Title
that may be specified as:
- An instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
... | [
"def",
"title",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"title\"",
"]"
] | [
1046,
4
] | [
1076,
28
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.titlefont | (self) |
Deprecated: Please use scattermapbox.marker.colorbar.title.font
instead. 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:
... |
Deprecated: Please use scattermapbox.marker.colorbar.title.font
instead. 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:
... | def titlefont(self):
"""
Deprecated: Please use scattermapbox.marker.colorbar.title.font
instead. 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
... | [
"def",
"titlefont",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"titlefont\"",
"]"
] | [
1085,
4
] | [
1125,
32
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.titleside | (self) |
Deprecated: Please use scattermapbox.marker.colorbar.title.side
instead. 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 enumerat... |
Deprecated: Please use scattermapbox.marker.colorbar.title.side
instead. 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 enumerat... | def titleside(self):
"""
Deprecated: Please use scattermapbox.marker.colorbar.title.side
instead. 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.
Th... | [
"def",
"titleside",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"titleside\"",
"]"
] | [
1134,
4
] | [
1149,
32
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.x | (self) |
Sets the x position of the color bar (in plot fraction).
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
Returns
-------
int|float
|
Sets the x position of the color bar (in plot fraction).
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3] | def x(self):
"""
Sets the x position of the color bar (in plot fraction).
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
Returns
-------
int|float
"""
return self["x"] | [
"def",
"x",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"x\"",
"]"
] | [
1158,
4
] | [
1169,
24
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.xanchor | (self) |
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left',... |
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left',... | def xanchor(self):
"""
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration va... | [
"def",
"xanchor",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"xanchor\"",
"]"
] | [
1178,
4
] | [
1192,
30
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.xpad | (self) |
Sets the amount of padding (in px) along the x direction.
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
int|float
|
Sets the amount of padding (in px) along the x direction.
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf] | def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
int|float
"""
return self["xpad"] | [
"def",
"xpad",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"xpad\"",
"]"
] | [
1201,
4
] | [
1212,
27
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.y | (self) |
Sets the y position of the color bar (in plot fraction).
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
Returns
-------
int|float
|
Sets the y position of the color bar (in plot fraction).
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3] | def y(self):
"""
Sets the y position of the color bar (in plot fraction).
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
Returns
-------
int|float
"""
return self["y"] | [
"def",
"y",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"y\"",
"]"
] | [
1221,
4
] | [
1232,
24
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.yanchor | (self) |
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'mi... |
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'mi... | def yanchor(self):
"""
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration value... | [
"def",
"yanchor",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"yanchor\"",
"]"
] | [
1241,
4
] | [
1255,
30
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.ypad | (self) |
Sets the amount of padding (in px) along the y direction.
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
int|float
|
Sets the amount of padding (in px) along the y direction.
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf] | def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
int|float
"""
return self["ypad"] | [
"def",
"ypad",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"ypad\"",
"]"
] | [
1264,
4
] | [
1275,
27
] | python | en | ['en', 'error', 'th'] | False |
ColorBar.__init__ | (
self,
arg=None,
bgcolor=None,
bordercolor=None,
borderwidth=None,
dtick=None,
exponentformat=None,
len=None,
lenmode=None,
nticks=None,
outlinecolor=None,
outlinewidth=None,
separatethousands=None,
showexpo... |
Construct a new ColorBar object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of :class:`plotly.graph_objs.scattermapbox.
marker.ColorBar`
bgcolor
Sets the color of padded are... |
Construct a new ColorBar object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of :class:`plotly.graph_objs.scattermapbox.
marker.ColorBar`
bgcolor
Sets the color of padded are... | def __init__(
self,
arg=None,
bgcolor=None,
bordercolor=None,
borderwidth=None,
dtick=None,
exponentformat=None,
len=None,
lenmode=None,
nticks=None,
outlinecolor=None,
outlinewidth=None,
separatethousands=None,
... | [
"def",
"__init__",
"(",
"self",
",",
"arg",
"=",
"None",
",",
"bgcolor",
"=",
"None",
",",
"bordercolor",
"=",
"None",
",",
"borderwidth",
"=",
"None",
",",
"dtick",
"=",
"None",
",",
"exponentformat",
"=",
"None",
",",
"len",
"=",
"None",
",",
"lenm... | [
1484,
4
] | [
1945,
34
] | python | en | ['en', 'error', 'th'] | False |
IndyHolder.__init__ | (self, wallet) |
Initialize an IndyHolder instance.
Args:
wallet: IndyWallet instance
|
Initialize an IndyHolder instance. | def __init__(self, wallet):
"""
Initialize an IndyHolder instance.
Args:
wallet: IndyWallet instance
"""
self.logger = logging.getLogger(__name__)
self.wallet = wallet | [
"def",
"__init__",
"(",
"self",
",",
"wallet",
")",
":",
"self",
".",
"logger",
"=",
"logging",
".",
"getLogger",
"(",
"__name__",
")",
"self",
".",
"wallet",
"=",
"wallet"
] | [
25,
4
] | [
34,
28
] | python | en | ['en', 'error', 'th'] | False |
IndyHolder.create_credential_request | (
self, credential_offer, credential_definition, did
) |
Create a credential offer for the given credential definition id.
Args:
credential_offer: The credential offer to create request for
credential_definition: The credential definition to create an offer for
Returns:
A credential request
|
Create a credential offer for the given credential definition id. | async def create_credential_request(
self, credential_offer, credential_definition, did
):
"""
Create a credential offer for the given credential definition id.
Args:
credential_offer: The credential offer to create request for
credential_definition: The cred... | [
"async",
"def",
"create_credential_request",
"(",
"self",
",",
"credential_offer",
",",
"credential_definition",
",",
"did",
")",
":",
"(",
"credential_request_json",
",",
"credential_request_metadata_json",
",",
")",
"=",
"await",
"indy",
".",
"anoncreds",
".",
"pr... | [
36,
4
] | [
71,
62
] | python | en | ['en', 'error', 'th'] | False |
IndyHolder.store_credential | (
self,
credential_definition,
credential_data,
credential_request_metadata,
credential_attr_mime_types=None,
credential_id=None
) |
Store a credential in the wallet.
Args:
credential_definition: Credential definition for this credential
credential_data: Credential data generated by the issuer
credential_request_metadata: credential request metadata generated
by the issuer
... |
Store a credential in the wallet. | async def store_credential(
self,
credential_definition,
credential_data,
credential_request_metadata,
credential_attr_mime_types=None,
credential_id=None
):
"""
Store a credential in the wallet.
Args:
credential_definition: Creden... | [
"async",
"def",
"store_credential",
"(",
"self",
",",
"credential_definition",
",",
"credential_data",
",",
"credential_request_metadata",
",",
"credential_attr_mime_types",
"=",
"None",
",",
"credential_id",
"=",
"None",
")",
":",
"credential_id",
"=",
"await",
"indy... | [
73,
4
] | [
118,
28
] | python | en | ['en', 'error', 'th'] | False |
IndyHolder.get_credentials | (self, start: int, count: int, wql: dict) |
Get credentials stored in the wallet.
Args:
start: Starting index
count: Number of records to return
wql: wql query dict
|
Get credentials stored in the wallet. | async def get_credentials(self, start: int, count: int, wql: dict):
"""
Get credentials stored in the wallet.
Args:
start: Starting index
count: Number of records to return
wql: wql query dict
"""
search_handle, record_count = await indy.anon... | [
"async",
"def",
"get_credentials",
"(",
"self",
",",
"start",
":",
"int",
",",
"count",
":",
"int",
",",
"wql",
":",
"dict",
")",
":",
"search_handle",
",",
"record_count",
"=",
"await",
"indy",
".",
"anoncreds",
".",
"prover_search_credentials",
"(",
"sel... | [
120,
4
] | [
147,
26
] | python | en | ['en', 'error', 'th'] | False |
IndyHolder.get_credentials_for_presentation_request_by_referent | (
self,
presentation_request: dict,
referents: Sequence[str],
start: int,
count: int,
extra_query: dict = {},
) |
Get credentials stored in the wallet.
Args:
presentation_request: Valid presentation request from issuer
referents: Presentation request referents to use to search for creds
start: Starting index
count: Maximum number of records to return
ext... |
Get credentials stored in the wallet. | async def get_credentials_for_presentation_request_by_referent(
self,
presentation_request: dict,
referents: Sequence[str],
start: int,
count: int,
extra_query: dict = {},
):
"""
Get credentials stored in the wallet.
Args:
presenta... | [
"async",
"def",
"get_credentials_for_presentation_request_by_referent",
"(",
"self",
",",
"presentation_request",
":",
"dict",
",",
"referents",
":",
"Sequence",
"[",
"str",
"]",
",",
"start",
":",
"int",
",",
"count",
":",
"int",
",",
"extra_query",
":",
"dict"... | [
149,
4
] | [
213,
49
] | python | en | ['en', 'error', 'th'] | False |
IndyHolder.get_credential | (self, credential_id: str) |
Get a credential stored in the wallet.
Args:
credential_id: Credential id to retrieve
|
Get a credential stored in the wallet. | async def get_credential(self, credential_id: str):
"""
Get a credential stored in the wallet.
Args:
credential_id: Credential id to retrieve
"""
try:
credential_json = await indy.anoncreds.prover_get_credential(
self.wallet.handle, crede... | [
"async",
"def",
"get_credential",
"(",
"self",
",",
"credential_id",
":",
"str",
")",
":",
"try",
":",
"credential_json",
"=",
"await",
"indy",
".",
"anoncreds",
".",
"prover_get_credential",
"(",
"self",
".",
"wallet",
".",
"handle",
",",
"credential_id",
"... | [
215,
4
] | [
236,
25
] | python | en | ['en', 'error', 'th'] | False |
IndyHolder.delete_credential | (self, credential_id: str) |
Remove a credential stored in the wallet.
Args:
credential_id: Credential id to remove
|
Remove a credential stored in the wallet. | async def delete_credential(self, credential_id: str):
"""
Remove a credential stored in the wallet.
Args:
credential_id: Credential id to remove
"""
try:
indy_stor = IndyStorage(self.wallet)
mime_types_record = await indy_stor.get_record(
... | [
"async",
"def",
"delete_credential",
"(",
"self",
",",
"credential_id",
":",
"str",
")",
":",
"try",
":",
"indy_stor",
"=",
"IndyStorage",
"(",
"self",
".",
"wallet",
")",
"mime_types_record",
"=",
"await",
"indy_stor",
".",
"get_record",
"(",
"IndyHolder",
... | [
238,
4
] | [
266,
21
] | python | en | ['en', 'error', 'th'] | False |
IndyHolder.get_mime_type | (
self,
credential_id: str,
attr: str = None
) |
Get MIME type per attribute (or for all attributes).
Args:
credential_id: credential id
attr: attribute of interest or omit for all
Returns: Attribute MIME type or dict mapping attribute names to MIME types
attr_meta_json = all_meta.tags.get(attr)
|
Get MIME type per attribute (or for all attributes). | async def get_mime_type(
self,
credential_id: str,
attr: str = None
) -> Union[dict, str]:
"""
Get MIME type per attribute (or for all attributes).
Args:
credential_id: credential id
attr: attribute of interest or omit for all
Returns... | [
"async",
"def",
"get_mime_type",
"(",
"self",
",",
"credential_id",
":",
"str",
",",
"attr",
":",
"str",
"=",
"None",
")",
"->",
"Union",
"[",
"dict",
",",
"str",
"]",
":",
"try",
":",
"mime_types_record",
"=",
"await",
"IndyStorage",
"(",
"self",
".",... | [
268,
4
] | [
292,
83
] | python | en | ['en', 'error', 'th'] | False |
IndyHolder.create_presentation | (
self,
presentation_request: dict,
requested_credentials: dict,
schemas: dict,
credential_definitions: dict,
) |
Get credentials stored in the wallet.
Args:
presentation_request: Valid indy format presentation request
requested_credentials: Indy format requested_credentials
schemas: Indy formatted schemas_json
credential_definitions: Indy formatted schemas_json
... |
Get credentials stored in the wallet. | async def create_presentation(
self,
presentation_request: dict,
requested_credentials: dict,
schemas: dict,
credential_definitions: dict,
):
"""
Get credentials stored in the wallet.
Args:
presentation_request: Valid indy format presentat... | [
"async",
"def",
"create_presentation",
"(",
"self",
",",
"presentation_request",
":",
"dict",
",",
"requested_credentials",
":",
"dict",
",",
"schemas",
":",
"dict",
",",
"credential_definitions",
":",
"dict",
",",
")",
":",
"presentation_json",
"=",
"await",
"i... | [
294,
4
] | [
323,
27
] | python | en | ['en', 'error', 'th'] | False |
TestOpt.test_compare_opts | (self) |
Compare opts by loading them with Opt.load().
Will not compare the override field.
|
Compare opts by loading them with Opt.load(). | def test_compare_opts(self):
"""
Compare opts by loading them with Opt.load().
Will not compare the override field.
"""
with testing_utils.tempdir() as tmpdir:
# Write test opts
opt_dir = tmpdir
opt_path_1 = os.path.join(opt_dir, '1.opt')
... | [
"def",
"test_compare_opts",
"(",
"self",
")",
":",
"with",
"testing_utils",
".",
"tempdir",
"(",
")",
"as",
"tmpdir",
":",
"# Write test opts",
"opt_dir",
"=",
"tmpdir",
"opt_path_1",
"=",
"os",
".",
"path",
".",
"join",
"(",
"opt_dir",
",",
"'1.opt'",
")"... | [
54,
4
] | [
84,
52
] | python | en | ['en', 'error', 'th'] | False |
TestOpt.test_compare_opts_load_raw | (self) |
Compare opts by loading them from JSON instead of with Opt.load().
Will compare the override field.
|
Compare opts by loading them from JSON instead of with Opt.load(). | def test_compare_opts_load_raw(self):
"""
Compare opts by loading them from JSON instead of with Opt.load().
Will compare the override field.
"""
with testing_utils.tempdir() as tmpdir:
# Write test opts
opt_dir = tmpdir
opt_path_1 = os.path... | [
"def",
"test_compare_opts_load_raw",
"(",
"self",
")",
":",
"with",
"testing_utils",
".",
"tempdir",
"(",
")",
"as",
"tmpdir",
":",
"# Write test opts",
"opt_dir",
"=",
"tmpdir",
"opt_path_1",
"=",
"os",
".",
"path",
".",
"join",
"(",
"opt_dir",
",",
"'1.opt... | [
86,
4
] | [
129,
52
] | python | en | ['en', 'error', 'th'] | False |
TestInitOpt.test_init_opt | (self) |
Test --init-opt.
|
Test --init-opt.
| def test_init_opt(self):
"""
Test --init-opt.
"""
with testing_utils.tempdir() as temp_dir:
init_opt_path = os.path.join(temp_dir, 'init_opt.opt')
test_model_file = '/test_model_path/model'
# Save a test opt file
init_opt = Opt({'model_f... | [
"def",
"test_init_opt",
"(",
"self",
")",
":",
"with",
"testing_utils",
".",
"tempdir",
"(",
")",
"as",
"temp_dir",
":",
"init_opt_path",
"=",
"os",
".",
"path",
".",
"join",
"(",
"temp_dir",
",",
"'init_opt.opt'",
")",
"test_model_file",
"=",
"'/test_model_... | [
137,
4
] | [
154,
64
] | python | en | ['en', 'error', 'th'] | False |
TestInitOpt.test_allow_missing_init_opts | (self) |
Test --allow-missing-init-opts.
|
Test --allow-missing-init-opts.
| def test_allow_missing_init_opts(self):
"""
Test --allow-missing-init-opts.
"""
with testing_utils.tempdir() as temp_dir:
init_opt_path = os.path.join(temp_dir, 'init_opt.opt')
# Save a test opt file with an argument that doesn't exist
init_opt = Op... | [
"def",
"test_allow_missing_init_opts",
"(",
"self",
")",
":",
"with",
"testing_utils",
".",
"tempdir",
"(",
")",
"as",
"temp_dir",
":",
"init_opt_path",
"=",
"os",
".",
"path",
".",
"join",
"(",
"temp_dir",
",",
"'init_opt.opt'",
")",
"# Save a test opt file wit... | [
156,
4
] | [
179,
57
] | python | en | ['en', 'error', 'th'] | False |
Hoverlabel.align | (self) |
Sets the horizontal alignment of the text content within hover
label box. Has an effect only if the hover label text spans
more two or more lines
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['... |
Sets the horizontal alignment of the text content within hover
label box. Has an effect only if the hover label text spans
more two or more lines
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['... | def align(self):
"""
Sets the horizontal alignment of the text content within hover
label box. Has an effect only if the hover label text spans
more two or more lines
The 'align' property is an enumeration that may be specified as:
- One of the following enumeratio... | [
"def",
"align",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"align\"",
"]"
] | [
25,
4
] | [
40,
28
] | python | en | ['en', 'error', 'th'] | False |
Hoverlabel.alignsrc | (self) |
Sets the source reference on Chart Studio Cloud for align .
The 'alignsrc' 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 align .
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object | def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["alignsrc"] | [
"def",
"alignsrc",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"alignsrc\"",
"]"
] | [
49,
4
] | [
60,
31
] | python | en | ['en', 'error', 'th'] | False |
Hoverlabel.bgcolor | (self) |
Sets the background color of the hover labels for this trace
The 'bgcolor' 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 str... |
Sets the background color of the hover labels for this trace
The 'bgcolor' 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 str... | def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
The 'bgcolor' 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",
"bgcolor",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"bgcolor\"",
"]"
] | [
69,
4
] | [
120,
30
] | python | en | ['en', 'error', 'th'] | False |
Hoverlabel.bgcolorsrc | (self) |
Sets the source reference on Chart Studio Cloud for bgcolor .
The 'bgcolorsrc' 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 bgcolor .
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object | def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["bgcolorsrc"] | [
"def",
"bgcolorsrc",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"bgcolorsrc\"",
"]"
] | [
129,
4
] | [
140,
33
] | 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.