{
"__type": "IngestedDoc",
"__tag": 4010,
"_content": {
"Notes": {
"__type": "Section",
"__tag": 4015,
"children": [],
"title": [],
"level": 0,
"target": null
},
"Warns": {
"__type": "Section",
"__tag": 4015,
"children": [],
"title": [],
"level": 0,
"target": null
},
"Raises": {
"__type": "Section",
"__tag": 4015,
"children": [],
"title": [],
"level": 0,
"target": null
},
"Yields": {
"__type": "Section",
"__tag": 4015,
"children": [],
"title": [],
"level": 0,
"target": null
},
"Methods": {
"__type": "Section",
"__tag": 4015,
"children": [],
"title": [],
"level": 0,
"target": null
},
"Returns": {
"__type": "Section",
"__tag": 4015,
"children": [],
"title": [],
"level": 0,
"target": null
},
"Summary": {
"__type": "Section",
"__tag": 4015,
"children": [
{
"__type": "Paragraph",
"__tag": 4045,
"children": [
{
"__type": "Text",
"__tag": 4046,
"value": "Create a PNG/JPEG/GIF/WEBP image object given raw data."
}
]
}
],
"title": [],
"level": 0,
"target": null
},
"Receives": {
"__type": "Section",
"__tag": 4015,
"children": [],
"title": [],
"level": 0,
"target": null
},
"Warnings": {
"__type": "Section",
"__tag": 4015,
"children": [],
"title": [],
"level": 0,
"target": null
},
"Attributes": {
"__type": "Section",
"__tag": 4015,
"children": [],
"title": [],
"level": 0,
"target": null
},
"Parameters": {
"__type": "Section",
"__tag": 4015,
"children": [
{
"__type": "Parameters",
"__tag": 4026,
"children": [
{
"__type": "DocParam",
"__tag": 4016,
"name": "data",
"annotation": "unicode, str or bytes",
"desc": [
{
"__type": "Paragraph",
"__tag": 4045,
"children": [
{
"__type": "Text",
"__tag": 4046,
"value": "The raw image data or a URL or filename to load the data from. This always results in embedded image data."
}
]
}
]
},
{
"__type": "DocParam",
"__tag": 4016,
"name": "url",
"annotation": "unicode",
"desc": [
{
"__type": "Paragraph",
"__tag": 4045,
"children": [
{
"__type": "Text",
"__tag": 4046,
"value": "A URL to download the data from. If you specify "
},
{
"__type": "InlineRole",
"__tag": 4003,
"value": "url=",
"domain": null,
"role": null,
"inventory": null
},
{
"__type": "Text",
"__tag": 4046,
"value": ", the image data will not be embedded unless you also specify "
},
{
"__type": "InlineRole",
"__tag": 4003,
"value": "embed=True",
"domain": null,
"role": null,
"inventory": null
},
{
"__type": "Text",
"__tag": 4046,
"value": "."
}
]
}
]
},
{
"__type": "DocParam",
"__tag": 4016,
"name": "filename",
"annotation": "unicode",
"desc": [
{
"__type": "Paragraph",
"__tag": 4045,
"children": [
{
"__type": "Text",
"__tag": 4046,
"value": "Path to a local file to load the data from. Images from a file are always embedded."
}
]
}
]
},
{
"__type": "DocParam",
"__tag": 4016,
"name": "format",
"annotation": "unicode",
"desc": [
{
"__type": "Paragraph",
"__tag": 4045,
"children": [
{
"__type": "Text",
"__tag": 4046,
"value": "The format of the image data (png/jpeg/jpg/gif/webp). If a filename or URL is given for format will be inferred from the filename extension."
}
]
}
]
},
{
"__type": "DocParam",
"__tag": 4016,
"name": "embed",
"annotation": "bool",
"desc": [
{
"__type": "Paragraph",
"__tag": 4045,
"children": [
{
"__type": "Text",
"__tag": 4046,
"value": "Should the image data be embedded using a data URI (True) or be loaded using an ![]()
tag. Set this to True if you want the image to be viewable later with no internet connection in the notebook."
}
]
},
{
"__type": "Paragraph",
"__tag": 4045,
"children": [
{
"__type": "Text",
"__tag": 4046,
"value": "Default is "
},
{
"__type": "InlineRole",
"__tag": 4003,
"value": "True",
"domain": null,
"role": null,
"inventory": null
},
{
"__type": "Text",
"__tag": 4046,
"value": ", unless the keyword argument "
},
{
"__type": "ParamRef",
"__tag": 4071,
"name": "url"
},
{
"__type": "Text",
"__tag": 4046,
"value": " is set, then default value is "
},
{
"__type": "InlineRole",
"__tag": 4003,
"value": "False",
"domain": null,
"role": null,
"inventory": null
},
{
"__type": "Text",
"__tag": 4046,
"value": "."
}
]
},
{
"__type": "Paragraph",
"__tag": 4045,
"children": [
{
"__type": "Text",
"__tag": 4046,
"value": "Note that QtConsole is not able to display images if "
},
{
"__type": "ParamRef",
"__tag": 4071,
"name": "embed"
},
{
"__type": "Text",
"__tag": 4046,
"value": " is set to "
},
{
"__type": "InlineRole",
"__tag": 4003,
"value": "False",
"domain": null,
"role": null,
"inventory": null
}
]
}
]
},
{
"__type": "DocParam",
"__tag": 4016,
"name": "width",
"annotation": "int",
"desc": [
{
"__type": "Paragraph",
"__tag": 4045,
"children": [
{
"__type": "Text",
"__tag": 4046,
"value": "Width in pixels to which to constrain the image in html"
}
]
}
]
},
{
"__type": "DocParam",
"__tag": 4016,
"name": "height",
"annotation": "int",
"desc": [
{
"__type": "Paragraph",
"__tag": 4045,
"children": [
{
"__type": "Text",
"__tag": 4046,
"value": "Height in pixels to which to constrain the image in html"
}
]
}
]
},
{
"__type": "DocParam",
"__tag": 4016,
"name": "retina",
"annotation": "bool",
"desc": [
{
"__type": "Paragraph",
"__tag": 4045,
"children": [
{
"__type": "Text",
"__tag": 4046,
"value": "Automatically set the width and height to half of the measured width and height. This only works for embedded images because it reads the width/height from image data. For non-embedded images, you can just set the desired display width and height directly."
}
]
}
]
},
{
"__type": "DocParam",
"__tag": 4016,
"name": "unconfined",
"annotation": "bool",
"desc": [
{
"__type": "Paragraph",
"__tag": 4045,
"children": [
{
"__type": "Text",
"__tag": 4046,
"value": "Set unconfined=True to disable max-width confinement of the image."
}
]
}
]
},
{
"__type": "DocParam",
"__tag": 4016,
"name": "metadata",
"annotation": "dict",
"desc": [
{
"__type": "Paragraph",
"__tag": 4045,
"children": [
{
"__type": "Text",
"__tag": 4046,
"value": "Specify extra metadata to attach to the image."
}
]
}
]
},
{
"__type": "DocParam",
"__tag": 4016,
"name": "alt",
"annotation": "unicode",
"desc": [
{
"__type": "Paragraph",
"__tag": 4045,
"children": [
{
"__type": "Text",
"__tag": 4046,
"value": "Alternative text for the image, for use by screen readers."
}
]
}
]
}
]
}
],
"title": [],
"level": 0,
"target": null
},
"Extended Summary": {
"__type": "Section",
"__tag": 4015,
"children": [
{
"__type": "Paragraph",
"__tag": 4045,
"children": [
{
"__type": "Text",
"__tag": 4046,
"value": "When this object is returned by an input cell or passed to the display function, it will result in the image being displayed in the frontend."
}
]
}
],
"title": [],
"level": 0,
"target": null
},
"Other Parameters": {
"__type": "Section",
"__tag": 4015,
"children": [],
"title": [],
"level": 0,
"target": null
}
},
"_ordered_sections": [
"Summary",
"Extended Summary",
"Parameters",
"Attributes",
"Methods",
"Returns",
"Yields",
"Receives",
"Other Parameters",
"Raises",
"Warns",
"Warnings",
"Notes"
],
"item_file": "/IPython/core/display.py",
"item_line": 869,
"item_type": "function",
"aliases": [
"IPython.display.Image.__init__"
],
"example_section_data": {
"__type": "Section",
"__tag": 4015,
"children": [
{
"__type": "Text",
"__tag": 4046,
"value": "embedded image data, works in qtconsole and notebook\nwhen passed positionally, the first arg can be any of raw image data,\na URL, or a filename from which to load image data.\nThe result is always embedding image data for inline images.\n\n"
},
{
"__type": "Text",
"__tag": 4046,
"value": "\n"
},
{
"__type": "Code",
"__tag": 4050,
"value": "Image('/path/to/image.jpg')\n",
"execution_status": "success"
},
{
"__type": "Text",
"__tag": 4046,
"value": "\n"
},
{
"__type": "Code",
"__tag": 4050,
"value": "Image(b'RAW_PNG_DATA...')\n",
"execution_status": "success"
},
{
"__type": "Text",
"__tag": 4046,
"value": "\nSpecifying Image(url=...) does not embed the image data,\nit only generates ``![]()
`` tag with a link to the source.\nThis will not work in the qtconsole or offline.\n\n"
},
{
"__type": "Code",
"__tag": 4050,
"value": "Image(url='https://www.google.fr/images/srpr/logo3w.png')\n",
"execution_status": "success"
}
],
"title": [],
"level": 0,
"target": null
},
"see_also": [],
"signature": {
"__type": "SignatureNode",
"__tag": 4029,
"kind": "function",
"parameters": [
{
"__type": "SigParam",
"__tag": 4030,
"name": "self",
"annotation": {
"__type": "Empty",
"__tag": 4031
},
"kind": "POSITIONAL_OR_KEYWORD",
"default": {
"__type": "Empty",
"__tag": 4031
}
},
{
"__type": "SigParam",
"__tag": 4030,
"name": "data",
"annotation": {
"__type": "Empty",
"__tag": 4031
},
"kind": "POSITIONAL_OR_KEYWORD",
"default": "None"
},
{
"__type": "SigParam",
"__tag": 4030,
"name": "url",
"annotation": {
"__type": "Empty",
"__tag": 4031
},
"kind": "POSITIONAL_OR_KEYWORD",
"default": "None"
},
{
"__type": "SigParam",
"__tag": 4030,
"name": "filename",
"annotation": {
"__type": "Empty",
"__tag": 4031
},
"kind": "POSITIONAL_OR_KEYWORD",
"default": "None"
},
{
"__type": "SigParam",
"__tag": 4030,
"name": "format",
"annotation": {
"__type": "Empty",
"__tag": 4031
},
"kind": "POSITIONAL_OR_KEYWORD",
"default": "None"
},
{
"__type": "SigParam",
"__tag": 4030,
"name": "embed",
"annotation": {
"__type": "Empty",
"__tag": 4031
},
"kind": "POSITIONAL_OR_KEYWORD",
"default": "None"
},
{
"__type": "SigParam",
"__tag": 4030,
"name": "width",
"annotation": {
"__type": "Empty",
"__tag": 4031
},
"kind": "POSITIONAL_OR_KEYWORD",
"default": "None"
},
{
"__type": "SigParam",
"__tag": 4030,
"name": "height",
"annotation": {
"__type": "Empty",
"__tag": 4031
},
"kind": "POSITIONAL_OR_KEYWORD",
"default": "None"
},
{
"__type": "SigParam",
"__tag": 4030,
"name": "retina",
"annotation": {
"__type": "Empty",
"__tag": 4031
},
"kind": "POSITIONAL_OR_KEYWORD",
"default": "False"
},
{
"__type": "SigParam",
"__tag": 4030,
"name": "unconfined",
"annotation": {
"__type": "Empty",
"__tag": 4031
},
"kind": "POSITIONAL_OR_KEYWORD",
"default": "False"
},
{
"__type": "SigParam",
"__tag": 4030,
"name": "metadata",
"annotation": {
"__type": "Empty",
"__tag": 4031
},
"kind": "POSITIONAL_OR_KEYWORD",
"default": "None"
},
{
"__type": "SigParam",
"__tag": 4030,
"name": "alt",
"annotation": {
"__type": "Empty",
"__tag": 4031
},
"kind": "POSITIONAL_OR_KEYWORD",
"default": "None"
}
],
"return_annotation": {
"__type": "Empty",
"__tag": 4031
},
"target_name": "__init__"
},
"references": null,
"qa": "IPython.core.display:Image.__init__",
"arbitrary": [],
"local_refs": [
"alt",
"data",
"embed",
"filename",
"format",
"height",
"metadata",
"retina",
"unconfined",
"url",
"width"
]
}