dash-core-components
Version:
Core component suite for Dash
1,437 lines • 78.9 kB
JSON
{
"src/components/Checklist.react.js": {
"description": "Checklist is a component that encapsulates several checkboxes.\nThe values and labels of the checklist is specified in the `options`\nproperty and the checked items are specified with the `values` property.\nEach checkbox is rendered as an input with a surrounding label.",
"methods": [],
"props": {
"id": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"inputStyle": {
"type": {
"name": "object"
},
"required": false,
"description": "The style of the <input> checkbox element",
"defaultValue": {
"value": "{}",
"computed": false
}
},
"inputClassName": {
"type": {
"name": "string"
},
"required": false,
"description": "The class of the <input> checkbox element",
"defaultValue": {
"value": "''",
"computed": false
}
},
"labelStyle": {
"type": {
"name": "object"
},
"required": false,
"description": "The style of the <label> that wraps the checkbox input\n and the option's label",
"defaultValue": {
"value": "{}",
"computed": false
}
},
"labelClassName": {
"type": {
"name": "string"
},
"required": false,
"description": "The class of the <label> that wraps the checkbox input\n and the option's label",
"defaultValue": {
"value": "''",
"computed": false
}
},
"options": {
"type": {
"name": "shape",
"value": {
"label": {
"name": "string",
"description": "The checkbox's label",
"required": false
},
"value": {
"name": "string",
"description": "The value of the checkbox. This value\ncorresponds to the items specified in the\n`values` property.",
"required": false
},
"disabled": {
"name": "bool",
"description": "If true, this checkbox is disabled and can't be clicked on.",
"required": false
}
}
},
"required": false,
"description": "An array of options",
"defaultValue": {
"value": "[]",
"computed": false
}
},
"values": {
"type": {
"name": "arrayOf",
"value": {
"name": "string"
}
},
"required": false,
"description": "The currently selected value"
},
"fireEvent": {
"type": {
"name": "func"
},
"required": false,
"description": "Dash-assigned callback that gets fired when the checkbox item gets selected."
},
"setProps": {
"type": {
"name": "func"
},
"required": false,
"description": "Dash-assigned callback that gets fired when the value changes."
},
"dashEvents": {
"type": {
"name": "enum",
"value": [
{
"value": "'change'",
"computed": false
}
]
},
"required": false,
"description": ""
}
}
},
"src/components/DatePickerRange.react.js": {
"description": "DatePickerRange is a tailor made component designed for selecting\ntimespan across multiple days off of a calendar.\n\nThe DatePicker integrates well with the Python datetime module with the\nstartDate and endDate being returned in a string format suitable for\ncreating datetime objects.\n\nThis component is based off of Airbnb's react-dates react component\nwhich can be found here: https://github.com/airbnb/react-dates",
"methods": [
{
"name": "convertPropsToMoment",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "props",
"type": null
}
],
"returns": null
}
],
"props": {
"id": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"start_date": {
"type": {
"name": "string"
},
"required": false,
"description": "Specifies the starting date for the component.\nAccepts datetime.datetime objects or strings\nin the format 'YYYY-MM-DD'"
},
"end_date": {
"type": {
"name": "string"
},
"required": false,
"description": "Specifies the ending date for the component.\nAccepts datetime.datetime objects or strings\nin the format 'YYYY-MM-DD'"
},
"min_date_allowed": {
"type": {
"name": "string"
},
"required": false,
"description": "Specifies the lowest selectable date for the component.\nAccepts datetime.datetime objects or strings\nin the format 'YYYY-MM-DD'"
},
"max_date_allowed": {
"type": {
"name": "string"
},
"required": false,
"description": "Specifies the highest selectable date for the component.\nAccepts datetime.datetime objects or strings\nin the format 'YYYY-MM-DD'"
},
"initial_visible_month": {
"type": {
"name": "string"
},
"required": false,
"description": "Specifies the month that is initially presented when the user\nopens the calendar. Accepts datetime.datetime objects or strings\nin the format 'YYYY-MM-DD'"
},
"start_date_placeholder_text": {
"type": {
"name": "string"
},
"required": false,
"description": "Text that will be displayed in the first input\nbox of the date picker when no date is selected. Default value is 'Start Date'"
},
"end_date_placeholder_text": {
"type": {
"name": "string"
},
"required": false,
"description": "Text that will be displayed in the second input\nbox of the date picker when no date is selected. Default value is 'End Date'"
},
"day_size": {
"type": {
"name": "number"
},
"required": false,
"description": "Size of rendered calendar days, higher number\nmeans bigger day size and larger calendar overall",
"defaultValue": {
"value": "39",
"computed": false
}
},
"calendar_orientation": {
"type": {
"name": "enum",
"value": [
{
"value": "'vertical'",
"computed": false
},
{
"value": "'horizontal'",
"computed": false
}
]
},
"required": false,
"description": "Orientation of calendar, either vertical or horizontal.\nValid options are 'vertical' or 'horizontal'.",
"defaultValue": {
"value": "'horizontal'",
"computed": false
}
},
"is_RTL": {
"type": {
"name": "bool"
},
"required": false,
"description": "Determines whether the calendar and days operate\nfrom left to right or from right to left",
"defaultValue": {
"value": "false",
"computed": false
}
},
"reopen_calendar_on_clear": {
"type": {
"name": "bool"
},
"required": false,
"description": "If True, the calendar will automatically open when cleared",
"defaultValue": {
"value": "false",
"computed": false
}
},
"number_of_months_shown": {
"type": {
"name": "number"
},
"required": false,
"description": "Number of calendar months that are shown when calendar is opened",
"defaultValue": {
"value": "1",
"computed": false
}
},
"with_portal": {
"type": {
"name": "bool"
},
"required": false,
"description": "If True, calendar will open in a screen overlay portal,\nnot supported on vertical calendar",
"defaultValue": {
"value": "false",
"computed": false
}
},
"with_full_screen_portal": {
"type": {
"name": "bool"
},
"required": false,
"description": "If True, calendar will open in a full screen overlay portal, will\ntake precedent over 'withPortal' if both are set to true,\nnot supported on vertical calendar",
"defaultValue": {
"value": "false",
"computed": false
}
},
"first_day_of_week": {
"type": {
"name": "enum",
"value": [
{
"value": "0",
"computed": false
},
{
"value": "1",
"computed": false
},
{
"value": "2",
"computed": false
},
{
"value": "3",
"computed": false
},
{
"value": "4",
"computed": false
},
{
"value": "5",
"computed": false
},
{
"value": "6",
"computed": false
}
]
},
"required": false,
"description": "Specifies what day is the first day of the week, values must be\nfrom [0, ..., 6] with 0 denoting Sunday and 6 denoting Saturday",
"defaultValue": {
"value": "0",
"computed": false
}
},
"minimum_nights": {
"type": {
"name": "number"
},
"required": false,
"description": "Specifies a minimum number of nights that must be selected between\nthe startDate and the endDate"
},
"stay_open_on_select": {
"type": {
"name": "bool"
},
"required": false,
"description": "If True the calendar will not close when the user has selected a value\nand will wait until the user clicks off the calendar",
"defaultValue": {
"value": "false",
"computed": false
}
},
"show_outside_days": {
"type": {
"name": "bool"
},
"required": false,
"description": "If True the calendar will display days that rollover into\nthe next month"
},
"month_format": {
"type": {
"name": "string"
},
"required": false,
"description": "Specifies the format that the month will be displayed in the calendar,\nvalid formats are variations of \"MM YY\". For example:\n\"MM YY\" renders as '05 97' for May 1997\n\"MMMM, YYYY\" renders as 'May, 1997' for May 1997\n\"MMM, YY\" renders as 'Sep, 97' for September 1997"
},
"display_format": {
"type": {
"name": "string"
},
"required": false,
"description": "Specifies the format that the selected dates will be displayed\nvalid formats are variations of \"MM YY DD\". For example:\n\"MM YY DD\" renders as '05 10 97' for May 10th 1997\n\"MMMM, YY\" renders as 'May, 1997' for May 10th 1997\n\"M, D, YYYY\" renders as '07, 10, 1997' for September 10th 1997\n\"MMMM\" renders as 'May' for May 10 1997"
},
"disabled": {
"type": {
"name": "bool"
},
"required": false,
"description": "If True, no dates can be selected.",
"defaultValue": {
"value": "false",
"computed": false
}
},
"clearable": {
"type": {
"name": "bool"
},
"required": false,
"description": "Whether or not the dropdown is \"clearable\", that is, whether or\nnot a small \"x\" appears on the right of the dropdown that removes\nthe selected value.",
"defaultValue": {
"value": "false",
"computed": false
}
},
"setProps": {
"type": {
"name": "func"
},
"required": false,
"description": "Dash-assigned callback that gets fired when the value changes."
},
"dashEvents": {
"type": {
"name": "enum",
"value": [
{
"value": "'change'",
"computed": false
}
]
},
"required": false,
"description": "Dash-assigned callback that gets fired when the value changes."
}
}
},
"src/components/DatePickerSingle.react.js": {
"description": "DatePickerRange is a tailor made component designed for selecting\na single day off of a calendar.\n\nThe DatePicker integrates well with the Python datetime module with the\nstartDate and endDate being returned in a string format suitable for\ncreating datetime objects.\n\nThis component is based off of Airbnb's react-dates react component\nwhich can be found here: https://github.com/airbnb/react-dates",
"methods": [
{
"name": "convertPropsToMoment",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "props",
"type": null
}
],
"returns": null
}
],
"props": {
"id": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"date": {
"type": {
"name": "string"
},
"required": false,
"description": "Specifies the starting date for the component, best practice is to pass\nvalue via datetime object"
},
"min_date_allowed": {
"type": {
"name": "string"
},
"required": false,
"description": "Specifies the lowest selectable date for the component.\nAccepts datetime.datetime objects or strings\nin the format 'YYYY-MM-DD'"
},
"max_date_allowed": {
"type": {
"name": "string"
},
"required": false,
"description": "Specifies the highest selectable date for the component.\nAccepts datetime.datetime objects or strings\nin the format 'YYYY-MM-DD'"
},
"initial_visible_month": {
"type": {
"name": "string"
},
"required": false,
"description": "Specifies the month that is initially presented when the user\nopens the calendar. Accepts datetime.datetime objects or strings\nin the format 'YYYY-MM-DD'"
},
"day_size": {
"type": {
"name": "number"
},
"required": false,
"description": "Size of rendered calendar days, higher number\nmeans bigger day size and larger calendar overall",
"defaultValue": {
"value": "39",
"computed": false
}
},
"calendar_orientation": {
"type": {
"name": "enum",
"value": [
{
"value": "'vertical'",
"computed": false
},
{
"value": "'horizontal'",
"computed": false
}
]
},
"required": false,
"description": "Orientation of calendar, either vertical or horizontal.\nValid options are 'vertical' or 'horizontal'.",
"defaultValue": {
"value": "'horizontal'",
"computed": false
}
},
"is_RTL": {
"type": {
"name": "bool"
},
"required": false,
"description": "Determines whether the calendar and days operate\nfrom left to right or from right to left",
"defaultValue": {
"value": "false",
"computed": false
}
},
"placeholder": {
"type": {
"name": "string"
},
"required": false,
"description": "Text that will be displayed in the input\nbox of the date picker when no date is selected.\nDefault value is 'Start Date'"
},
"reopen_calendar_on_clear": {
"type": {
"name": "bool"
},
"required": false,
"description": "If True, the calendar will automatically open when cleared",
"defaultValue": {
"value": "false",
"computed": false
}
},
"number_of_months_shown": {
"type": {
"name": "number"
},
"required": false,
"description": "Number of calendar months that are shown when calendar is opened",
"defaultValue": {
"value": "1",
"computed": false
}
},
"with_portal": {
"type": {
"name": "bool"
},
"required": false,
"description": "If True, calendar will open in a screen overlay portal,\nnot supported on vertical calendar",
"defaultValue": {
"value": "false",
"computed": false
}
},
"with_full_screen_portal": {
"type": {
"name": "bool"
},
"required": false,
"description": "If True, calendar will open in a full screen overlay portal, will\ntake precedent over 'withPortal' if both are set to True,\nnot supported on vertical calendar",
"defaultValue": {
"value": "false",
"computed": false
}
},
"first_day_of_week": {
"type": {
"name": "enum",
"value": [
{
"value": "0",
"computed": false
},
{
"value": "1",
"computed": false
},
{
"value": "2",
"computed": false
},
{
"value": "3",
"computed": false
},
{
"value": "4",
"computed": false
},
{
"value": "5",
"computed": false
},
{
"value": "6",
"computed": false
}
]
},
"required": false,
"description": "Specifies what day is the first day of the week, values must be\nfrom [0, ..., 6] with 0 denoting Sunday and 6 denoting Saturday",
"defaultValue": {
"value": "0",
"computed": false
}
},
"stay_open_on_select": {
"type": {
"name": "bool"
},
"required": false,
"description": "If True the calendar will not close when the user has selected a value\nand will wait until the user clicks off the calendar",
"defaultValue": {
"value": "false",
"computed": false
}
},
"show_outside_days": {
"type": {
"name": "bool"
},
"required": false,
"description": "If True the calendar will display days that rollover into\nthe next month",
"defaultValue": {
"value": "true",
"computed": false
}
},
"month_format": {
"type": {
"name": "string"
},
"required": false,
"description": "Specifies the format that the month will be displayed in the calendar,\nvalid formats are variations of \"MM YY\". For example:\n\"MM YY\" renders as '05 97' for May 1997\n\"MMMM, YYYY\" renders as 'May, 1997' for May 1997\n\"MMM, YY\" renders as 'Sep, 97' for September 1997"
},
"display_format": {
"type": {
"name": "string"
},
"required": false,
"description": "Specifies the format that the selected dates will be displayed\nvalid formats are variations of \"MM YY DD\". For example:\n\"MM YY DD\" renders as '05 10 97' for May 10th 1997\n\"MMMM, YY\" renders as 'May, 1997' for May 10th 1997\n\"M, D, YYYY\" renders as '07, 10, 1997' for September 10th 1997\n\"MMMM\" renders as 'May' for May 10 1997"
},
"disabled": {
"type": {
"name": "bool"
},
"required": false,
"description": "If True, no dates can be selected.",
"defaultValue": {
"value": "false",
"computed": false
}
},
"clearable": {
"type": {
"name": "bool"
},
"required": false,
"description": "Whether or not the dropdown is \"clearable\", that is, whether or\nnot a small \"x\" appears on the right of the dropdown that removes\nthe selected value.",
"defaultValue": {
"value": "false",
"computed": false
}
},
"setProps": {
"type": {
"name": "func"
},
"required": false,
"description": "Dash-assigned callback that gets fired when the value changes."
},
"dashEvents": {
"type": {
"name": "enum",
"value": [
{
"value": "'change'",
"computed": false
}
]
},
"required": false,
"description": "Dash-assigned callback that gets fired when the value changes."
}
}
},
"src/components/Dropdown.react.js": {
"description": "Dropdown is an interactive dropdown element for selecting one or more\nitems.\nThe values and labels of the dropdown items are specified in the `options`\nproperty and the selected item(s) are specified with the `value` property.\n\nUse a dropdown when you have many options (more than 5) or when you are\nconstrained for space. Otherwise, you can use RadioItems or a Checklist,\nwhich have the benefit of showing the users all of the items at once.",
"methods": [],
"props": {
"id": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"clearable": {
"type": {
"name": "bool"
},
"required": false,
"description": "Whether or not the dropdown is \"clearable\", that is, whether or\nnot a small \"x\" appears on the right of the dropdown that removes\nthe selected value.",
"defaultValue": {
"value": "true",
"computed": false
}
},
"disabled": {
"type": {
"name": "bool"
},
"required": false,
"description": "If true, the option is disabled",
"defaultValue": {
"value": "false",
"computed": false
}
},
"multi": {
"type": {
"name": "bool"
},
"required": false,
"description": "If true, the user can select multiple values",
"defaultValue": {
"value": "false",
"computed": false
}
},
"options": {
"type": {
"name": "arrayOf",
"value": {
"name": "shape",
"value": {
"disabled": {
"name": "bool",
"required": false
},
"label": {
"name": "string",
"required": false
},
"value": {
"name": "string",
"required": false
}
}
}
},
"required": false,
"description": ""
},
"placeholder": {
"type": {
"name": "string"
},
"required": false,
"description": "The grey, default text shown when no option is selected"
},
"searchable": {
"type": {
"name": "bool"
},
"required": false,
"description": "Whether to enable the searching feature or not",
"defaultValue": {
"value": "true",
"computed": false
}
},
"value": {
"type": {
"name": "union",
"value": [
{
"name": "string"
},
{
"name": "arrayOf",
"value": {
"name": "string"
}
}
]
},
"required": false,
"description": "The value of the input. If `multi` is false (the default)\nthen value is just a string that corresponds to the values\nprovided in the `options` property. If `multi` is true, then\nmultiple values can be selected at once, and `value` is an\narray of items with values corresponding to those in the\n`options` prop."
},
"setProps": {
"type": {
"name": "func"
},
"required": false,
"description": "Dash-assigned callback that gets fired when the input changes"
},
"dashEvents": {
"type": {
"name": "enum",
"value": [
{
"value": "'change'",
"computed": false
}
]
},
"required": false,
"description": ""
}
}
},
"src/components/Graph.react.js": {
"description": "",
"methods": [
{
"name": "plot",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "props",
"type": null
}
],
"returns": null
},
{
"name": "bindEvents",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "props",
"type": null
}
],
"returns": null
}
],
"props": {
"id": {
"type": {
"name": "string"
},
"required": true,
"description": ""
},
"clickData": {
"type": {
"name": "object"
},
"required": false,
"description": "Data from latest click event",
"defaultValue": {
"value": "null",
"computed": false
}
},
"hoverData": {
"type": {
"name": "object"
},
"required": false,
"description": "Data from latest hover event",
"defaultValue": {
"value": "null",
"computed": false
}
},
"clear_on_unhover": {
"type": {
"name": "bool"
},
"required": false,
"description": "If True, `clear_on_unhover` will clear the `hoverData` property\nwhen the user \"unhovers\" from a point.\nIf False, then the `hoverData` property will be equal to the\ndata from the last point that was hovered over.",
"defaultValue": {
"value": "false",
"computed": false
}
},
"selectedData": {
"type": {
"name": "object"
},
"required": false,
"description": "Data from latest select event",
"defaultValue": {
"value": "null",
"computed": false
}
},
"relayoutData": {
"type": {
"name": "object"
},
"required": false,
"description": "Data from latest relayout event which occurs\nwhen the user zooms or pans on the plot",
"defaultValue": {
"value": "null",
"computed": false
}
},
"figure": {
"type": {
"name": "object"
},
"required": false,
"description": "Plotly `figure` object. See schema:\nhttps://plot.ly/javascript/reference",
"defaultValue": {
"value": "{data: [], layout: {}}",
"computed": false
}
},
"style": {
"type": {
"name": "object"
},
"required": false,
"description": "Generic style overrides on the plot div"
},
"animate": {
"type": {
"name": "bool"
},
"required": false,
"description": "Beta: If true, animate between updates using\nplotly.js's `animate` function",
"defaultValue": {
"value": "false",
"computed": false
}
},
"animation_options": {
"type": {
"name": "object"
},
"required": false,
"description": "Beta: Object containing animation settings.\nOnly applies if `animate` is `true`",
"defaultValue": {
"value": "{\n frame: {\n redraw: false\n },\n transition: {\n duration: 750,\n ease: 'cubic-in-out'\n }\n}",
"computed": false
}
},
"config": {
"type": {
"name": "shape",
"value": {
"staticPlot": {
"name": "bool",
"description": "no interactivity, for export or image generation",
"required": false
},
"editable": {
"name": "bool",
"description": "we can edit titles, move annotations, etc - sets all pieces of `edits`\nunless a separate `edits` config item overrides individual parts",
"required": false
},
"edits": {
"name": "shape",
"value": {
"annotationPosition": {
"name": "bool",
"description": "annotationPosition: the main anchor of the annotation, which is the\ntext (if no arrow) or the arrow (which drags the whole thing leaving\nthe arrow length & direction unchanged)",
"required": false
},
"annotationTail": {
"name": "bool",
"description": "just for annotations with arrows, change the length and direction of the arrow",
"required": false
},
"annotationText": {
"name": "bool",
"required": false
},
"axisTitleText": {
"name": "bool",
"required": false
},
"colorbarPosition": {
"name": "bool",
"required": false
},
"colorbarTitleText": {
"name": "bool",
"required": false
},
"legendPosition": {
"name": "bool",
"required": false
},
"legendText": {
"name": "bool",
"description": "edit the trace name fields from the legend",
"required": false
},
"shapePosition": {
"name": "bool",
"required": false
},
"titleText": {
"name": "bool",
"description": "the global `layout.title`",
"required": false
}
},
"description": "a set of editable properties",
"required": false
},
"autosizable": {
"name": "bool",
"description": "DO autosize once regardless of layout.autosize\n(use default width or height values otherwise)",
"required": false
},
"queueLength": {
"name": "number",
"description": "set the length of the undo/redo queue",
"required": false
},
"fillFrame": {
"name": "bool",
"description": "if we DO autosize, do we fill the container or the screen?",
"required": false
},
"frameMargins": {
"name": "number",
"description": "if we DO autosize, set the frame margins in percents of plot size",
"required": false
},
"scrollZoom": {
"name": "bool",
"description": "mousewheel or two-finger scroll zooms the plot",
"required": false
},
"doubleClick": {
"name": "enum",
"value": [
{
"value": "false",
"computed": false
},
{
"value": "'reset'",
"computed": false
},
{
"value": "'autosize'",
"computed": false
},
{
"value": "'reset+autosize'",
"computed": false
}
],
"description": "double click interaction (false, 'reset', 'autosize' or 'reset+autosize')",
"required": false
},
"showTips": {
"name": "bool",
"description": "new users see some hints about interactivity",
"required": false
},
"showAxisDragHandles": {
"name": "bool",
"description": "enable axis pan/zoom drag handles",
"required": false
},
"showAxisRangeEntryBoxes": {
"name": "bool",
"description": "enable direct range entry at the pan/zoom drag points\n(drag handles must be enabled above)",
"required": false
},
"showLink": {
"name": "bool",
"description": "link to open this plot in plotly",
"required": false
},
"sendData": {
"name": "bool",
"description": "if we show a link, does it contain data or just link to a plotly file?",
"required": false
},
"linkText": {
"name": "string",
"description": "text appearing in the sendData link",
"required": false
},
"displayModeBar": {
"name": "enum",
"value": [
{
"value": "true",
"computed": false
},
{
"value": "false",
"computed": false
},
{
"value": "'hover'",
"computed": false
}
],
"description": "display the mode bar (true, false, or 'hover')",
"required": false
},
"modeBarButtonsToRemove": {
"name": "array",
"description": "remove mode bar button by name.\nAll modebar button names at https://github.com/plotly/plotly.js/blob/master/src/components/modebar/buttons.js\nCommon names include:\n - sendDataToCloud\n- (2D): zoom2d, pan2d, select2d, lasso2d, zoomIn2d, zoomOut2d, autoScale2d, resetScale2d\n- (Cartesian): hoverClosestCartesian, hoverCompareCartesian\n- (3D): zoom3d, pan3d, orbitRotation, tableRotation, handleDrag3d, resetCameraDefault3d, resetCameraLastSave3d, hoverClosest3d\n- (Geo): zoomInGeo, zoomOutGeo, resetGeo, hoverClosestGeo\n- hoverClosestGl2d, hoverClosestPie, toggleHover, resetViews",
"required": false
},
"modeBarButtonsToAdd": {
"name": "array",
"description": "add mode bar button using config objects",
"required": false
},
"modeBarButtons": {
"name": "any",
"description": "fully custom mode bar buttons as nested array,\nwhere the outer arrays represents button groups, and\nthe inner arrays have buttons config objects or names of default buttons",
"required": false
},
"displaylogo": {
"name": "bool",
"description": "add the plotly logo on the end of the mode bar",
"required": false
},
"plotGlPixelRatio": {
"name": "number",
"description": "increase the pixel ratio for Gl plot images",
"required": false
},
"topojsonURL": {
"name": "string",
"description": "URL to topojson files used in geo charts",
"required": false
},
"mapboxAccessToken": {
"name": "any",
"description": "Mapbox access token (required to plot mapbox trace types)\nIf using an Mapbox Atlas server, set this option to '',\nso that plotly.js won't attempt to authenticate to the public Mapbox server.",
"required": false
}
}
},
"required": false,
"description": "Plotly.js config options.\nSee https://plot.ly/javascript/configuration-options/\nfor more info.",
"defaultValue": {
"value": "{\n staticPlot: false,\n editable: false,\n edits: {\n annotationPosition: false,\n annotationTail: false,\n annotationText: false,\n axisTitleText: false,\n colorbarPosition: false,\n colorbarTitleText: false,\n legendPosition: false,\n legendText: false,\n shapePosition: false,\n titleText: false\n },\n autosizable: false,\n queueLength: 0,\n fillFrame: false,\n frameMargins: 0,\n scrollZoom: false,\n doubleClick: 'reset+autosize',\n showTips: true,\n showAxisDragHandles: true,\n showAxisRangeEntryBoxes: true,\n showLink: false,\n sendData: true,\n linkText: 'Edit chart',\n showSources: false,\n displayModeBar: 'hover',\n modeBarButtonsToRemove: [],\n modeBarButtonsToAdd: [],\n modeBarButtons: false,\n displaylogo: true,\n plotGlPixelRatio: 2,\n topojsonURL: 'https://cdn.plot.ly/',\n mapboxAccessToken: null\n}",
"computed": false
}
},
"dashEvents": {
"type": {
"name": "enum",
"value": [
{
"value": "'click'",
"computed": false
},
{
"value": "'hover'",
"computed": false
},
{
"value": "'selected'",
"computed": false
},
{
"value": "'relayout'",
"computed": false
},
{
"value": "'unhover'",
"computed": false
}
]
},
"required": false,
"description": ""
},
"setProps": {
"type": {
"name": "func"
},
"required": false,
"description": "Function that updates the state tree."
},
"dashFireEvent": {
"type": {
"name": "func"
},
"required": false,
"description": "Function that fires events"
}
}
},
"src/components/Input.react.js": {
"description": "A basic HTML input control for entering text, numbers, or passwords.\n\nNote that checkbox and radio types are supported through\nthe Checklist and RadioItems component. Dates, times, and file uploads\nare also supported through separate components.",
"methods": [],
"props": {
"id": {
"type": {
"name": "string"
},
"required": false,
"description": "The ID of this component, used to identify dash components\nin callbacks. The ID needs to be unique across all of the\ncomponents in an app."
},
"value": {
"type": {
"name": "string"
},
"required": false,
"description": "The value of the input"
},
"style": {
"type": {
"name": "object"
},
"required": false,
"description": "The input's inline styles"
},
"className": {
"type": {
"name": "string"
},
"required": false,
"description": "The class of the input element"
},
"type": {
"type": {
"name": "enum",
"value": [
{
"value": "\"text\"",
"computed": false
},
{
"value": "'number'",
"computed": false
},
{
"value": "'password'",
"computed": false
},
{
"value": "'email'",
"computed": false
},
{
"value": "'range'",
"computed": false
},
{
"value": "'search'",
"computed": false
},
{
"value": "'tel'",
"computed": false
},
{
"value": "'url'",
"computed": false
},
{
"value": "'hidden'",
"computed": false
}
]
},
"required": false,
"description": "The type of control to render."
},
"autocomplete": {
"type": {
"name": "string"
},
"required": false,
"description": "This attribute indicates whether the value of the control can be automatically completed by the browser."
},
"autofocus": {
"type": {
"name": "string"
},
"required": false,
"description": "The element should be automatically focused after the page loaded."
},
"inputmode": {
"type": {
"name": "enum",
"value": [
{
"value": "\"verbatim\"",
"computed": false
},
{
"value": "\"latin\"",
"computed": false
},
{
"value": "\"latin-name\"",
"computed": false
},
{
"value": "\"latin-prose\"",
"computed": false
},
{
"value": "\"full-width-latin\"",
"computed": false
},
{
"value": "\"kana\"",
"computed": false
},
{
"value": "\"katakana\"",
"computed": false
},
{
"value": "\"numeric\"",
"computed": false
},
{
"value": "\"tel\"",
"computed": false
},
{
"value": "\"email\"",
"computed": false
},
{
"value": "\"url\"",
"computed": false
}
]
},
"required": false,
"description": ""
},
"list": {
"type": {
"name": "string"
},
"required": false,
"description": "Identifies a list of pre-defined options to suggest to the user.\nThe value must be the id of a <datalist> element in the same document.\nThe browser displays only options that are valid values for this\ninput element.\nThis attribute is ignored when the type attribute's value is\nhidden, checkbox, radio, file, or a button type."
},
"max": {
"type": {
"name": "string"
},
"required": false,
"description": "The maximum (numeric or date-time) value for this item, which must not be less than its minimum (min attribute) value."
},
"maxlength": {
"type": {
"name": "string"
},
"required": false,
"description": "If the value of the type attribute is text, email, search, password, tel, or url, this attribute specifies the maximum number of characters (in UTF-16 code units) that the user can enter. For other control types, it is ignored. It can exceed the value of the size attribute. If it is not specified, the user can enter an unlimited number of characters. Specifying a negative number results in the default behavior (i.e. the user can enter an unlimited number of characters). The constraint is evaluated only when the value of the attribute has been changed."
},
"min": {
"type": {
"name": "string"
},
"required": false,
"description": "The minimum (numeric or date-time) value for this item, which must not be greater than its maximum (max attribute) value."
},
"minlength": {
"type": {
"name": "string"
},
"required": false,
"description": "If the value of the type attribute is text, email, search, password, tel, or url, this attribute specifies the minimum number of characters (in Unicode code points) that the user can enter. For other control types, it is ignored."
},
"multiple": {
"type": {
"name": "string"
},
"required": false,
"description": "This Boolean attribute indicates whether the user can enter more than one value. This attribute applies when the type attribute is set to email or file, otherwise it is ignored."
},
"name": {
"type": {
"name": "string"
},
"required": false,
"description": "The name of the control, which is submitted with the form data."
},
"pattern": {
"type": {
"name": "string"
},
"required": false,
"description": "A regular expression that the control's value is checked against. The pattern must match the entire value, not just some subset. Use the title attribute to describe the pattern to help the user. This attribute applies when the value of the type attribute is text, search, tel, url, email, or password, otherwise it is ignored. The regular expression language is the same as JavaScript RegExp algorithm, with the 'u' parameter that makes it treat the pattern as a sequence of unicode code points. The pattern is not surrounded by forward slashes."
},
"placeholder": {
"type": {
"name": "string"
},
"required": false,
"description": "A hint to the user of what can be entered in the control . The placeholder text must not contain carriage returns or line-feeds. Note: Do not use the placeholder attribute instead of a <label> element, their purposes are different. The <label> attribute describes the role of the form element (i.e. it indicates what kind of information is expected), and the placeholder attribute is a hint about the format that the content should take. There are cases in which the placeholder attribute is never displayed to the user, so the form must be understandable without it."
},
"readonly": {
"type": {
"name": "string"
},
"required": false,
"description": "This attribute indicates that the user cannot modify the value of the control. The value of the attribute is irrelevant. If you need read-write access to the input value, do not add the \"readonly\" attribute. It is ignored if the value of the type attribute is hidden, range, color, checkbox, radio, file, or a button type (such as button or submit)."
},
"required": {
"type": {
"name": "string"
},
"required": false,
"description": "This attribute specifies that the user must fill in a value before submitting a form. It cannot be used when the type attribute is hidden, image, or a button type (submit, reset, or button). The :optional and :required CSS pseudo-classes will be applied to the field as appropriate."
},
"selectionDirection": {
"type": {
"name": "string"
},
"required": false,
"description": "The direction in which selection occurred. This is \"forward\" if the selection was made from left-to-right in an LTR locale or right-to-left in an RTL locale, or \"backward\" if the selection was made in the opposite direction. On platforms on which it's possible this value isn't known, the value can be \"none\"; for example, on macOS, the default direction is \"none\", then as the user begins to modify the selection using the keyboard, this will change to reflect the direction in which the selection is expanding."
},
"selectionEnd": {
"type": {
"name": "string"
},
"required": false,
"description": "The offset into the element's text content of the last selected character. If there's no selection, this value indicates the offset to the character following the current text input cursor position (that is, the position the next character typed would occupy)."
},
"selectionStart": {
"type": {
"name": "string"
},
"required": false,
"description": "The offset into the element's text content of the first selected character. If there's no selection, this value indicates the offset to the character following the current text input cursor position (that is, the position the next character typed would occupy)."
},
"size": {
"type": {
"name": "string"
},
"required": false,
"description": "The initial size of the control. This value is in pixels unless the value of the type attribute is text or password, in which case it is an integer number of characters. Starting in, this attribute applies only when the type attribute is set to text, search, tel, url, email, or password, otherwise it is ignored. In addition, the size must be greater than zero. If you do not specify a size, a default value of 20 is used.' simply states \"the user agent should ensure that at least that many characters are visible\", but different characters can have different widths in certain fonts. In some browsers, a certain string with x characters will not be entirely visible even if size is defined to