InlineXbrlDocument class

InlineXbrlDocument class

An inline XBRL document.

Inheritance: InlineXbrlDocument → Document → Node

The InlineXbrlDocument type exposes the following members:

Constructors

ConstructorDescription
InlineXbrlDocument(file_name)Initializes a new instance of InlineXbrlDocument class and open a file.
InlineXbrlDocument(file_name, options)

Properties

PropertyDescription
node_type
parent_node
base_uri
owner_document
child_nodes
node_name
node_value
text_content
local_name
prefix
namespace_uri
has_child_nodes
previous_sibling
next_sibling
first_child
last_child
COMMENT_NODE
DOCUMENT_NODE
DOCUMENT_TYPE_NODE
ELEMENT_NODE
PROCESSING_INSTRUCTION_NODE
TEXT_NODE
character_set
content_type
document_element
document_uri
child_elements
referencesGets the InlineReferences in the inline XBRL document.
relationshipsGets the collection of InlineRelationship in the inline XBRL document.
role_referencesGets the collection of RoleReference in the inline XBRL document.
arcrole_referencesGets the collection of ArcroleReference in the inline XBRL document.
contextsGets the collection of Context in the inline XBRL document.
unitsGets the collection of Unit in the inline XBRL document.
factsGets the collection of InlineFact in the inline XBRL document.
footnotesGets the collection of InlineFootnote in the inline XBRL document.
continuationsGets the collection of InlineContinuation in the inline XBRL document.
validation_errorsGets the collection of ValidationError in the inline XBRL document.

Methods

MethodDescription
export_to_xbrl(file_name)Export to xbrl file.
export_to_xbrl(stream)Export to xbrl stream.
export_to_xbrl()Export to XbrlDocument object.
save(file_name)Creates and saves the inline xbrl file to the disk.
save(stream)Creates and saves the inline xbrl file to the stream.
save(file_name, save_options)
save(stream, save_options)
append_child(node)
remove_child(node)
replace_child(node, child)
refresh_inline_xbrl_objects()If add, update, remove Inline Xbrl elements in the DOM tree, this method should be called to refresh inline xbrl objects.
get_concept_by_name(concept_name)Gets the concept which has the specified name.
get_concept_by_id(concept_id)Gets the context which has the specified id.
get_concept_by_loc(loc)Gets the concept by the locator.
get_role_type_by_uri(role_type_uri)Gets the RoleType which has the specified uri.
get_arcrole_type_by_uri(arcrole_type_uri)Gets the ArcroleType which has the specified uri.
validate()Validates this inline XBRL document.
is_valid()Checks whether this inlince XBRL document is valid.
get_context_by_id(id)Gets the context which has the specified id.
get_unit_by_id(id)Gets the unit which has the specified id.
get_continuation_chain_by_continuation_reference(continuation_reference)Gets the continuation chain according to the continuation reference.
create_html_element(name, prefix)Creates a Html elment.
create_inline_xbrl_element(name, prefix)Creates an inline xbrl elment.
create_xbrl_instance_element(name, prefix)Creates a xbrl instance elment.
create_xbrl_linkbase_element(name, prefix)Creates a xbrl linkbase elment.

See Also

InlineTuple class