arelle.FunctionXfi#

See COPYRIGHT.md for copyright information.

Module Contents#

Functions#

call

instance

item

xbrlTuple

item_context

item_context_element

context

unit

unit_numerator

unit_denominator

measure_name

period

context_period

parent_child

is_start_end_period

is_forever_period

is_duration_period

is_instant_period

is_period_type

period_start

period_end

period_instant

period_datetime

entity

context_entity

identifier

context_identifier

entity_identifier

identifier_value

identifier_scheme

fact_identifier_value

fact_identifier_scheme

segment

entity_segment

context_segment

scenario

context_scenario

precision

decimals

infer_precision_decimals

numeric

non_numeric

fraction

conceptProperty

checkXffFunctionUse

uncovered_aspect

has_fallback_value

uncovered_non_dimensional_aspects

uncovered_dimensional_aspects

uncovered_aspects

nodesEqual

setsEqual

identical_nodes

identical_nodes_test

s_equal

s_equal_test

u_equal

u_equal_test

v_equal

v_equal_test

c_equal

c_equal_test

identical_node_set

s_equal_set

v_equal_set

c_equal_set

u_equal_set

x_equal

x_equal_test

duplicate_item

duplicate_tuple

duplicate_tuple_test

p_equal

p_equal_test

cu_equal

cu_equal_test

pc_equal

pc_equal_test

pcu_equal

pcu_equal_test

start_equal

end_equal

taxonomy_refs

date_equal_test

nodes_correspond

facts_in_instance

items_in_instance

tuples_in_instance

items_in_tuple

tuples_in_tuple

non_nil_facts_in_instance

concept

concept_balance

concept_period_type

concept_custom_attribute

concept_data_type

concept_data_type_derived_from

concept_substitutions

concepts_from_local_name

concepts_from_local_name_pattern

filter_member_network_selection

filter_member_network_members

filter_member_DRS_selection

filter_member_DRS_members

dimension_default

fact_segment_remainder

fact_scenario_remainder

fact_dim_value

fact_has_explicit_dimension

fact_has_typed_dimension

fact_explicit_dimension_value_value

fact_has_explicit_dimension_value

fact_explicit_dimension_value

fact_typed_dimension_value

fact_typed_dimension_simple_value

fact_explicit_dimensions

fact_typed_dimensions

fact_dimension_s_equal2

linkbase_link_roles

navigate_relationships

concept_label

arcrole_definition

role_definition

fact_footnotes

concept_relationships

concept_relationships_step

relationship_from_concept

relationship_to_concept

distinct_nonAbstract_parent_concepts

relationship_element_attribute

element_attribute

relationship_attribute

relationship_link_attribute

element_name

relationship_name

relationship_link_name

xbrl_instance

format_number

create_element

any_identifier

unique_identifiers

single_unique_identifier

any_start_date

unique_start_dates

single_unique_start_date

any_end_date

unique_end_dates

single_unique_end_date

any_instant_date

unique_instant_dates

single_unique_instant_date

filingIndicatorValues

positive_filing_indicators

positive_filing_indicator

negative_filing_indicators

negative_filing_indicator

Data#

xfiFunctions

API#

exception arelle.FunctionXfi.xfiFunctionNotAvailable#

Bases: Exception

__repr__()#
arelle.FunctionXfi.call(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, localname: str, args: arelle.formula.XPathContext.ResultStack) → arelle.formula.XPathContext.RecursiveContextItem#
arelle.FunctionXfi.instance(xc, p, args, i=0)#
arelle.FunctionXfi.item(xc, args, i=0)#
arelle.FunctionXfi.xbrlTuple(xc, args, i=0)#
arelle.FunctionXfi.item_context(xc, args, i=0)#
arelle.FunctionXfi.item_context_element(xc, args, name)#
arelle.FunctionXfi.context(xc, p, args)#
arelle.FunctionXfi.unit(xc, p, args)#
arelle.FunctionXfi.unit_numerator(xc, p, args)#
arelle.FunctionXfi.unit_denominator(xc, p, args)#
arelle.FunctionXfi.measure_name(xc, p, args)#
arelle.FunctionXfi.period(xc, p, args)#
arelle.FunctionXfi.context_period(xc, p, args)#
arelle.FunctionXfi.parent_child(args, parentName, childName, findDescendant=False)#
arelle.FunctionXfi.is_start_end_period(xc, p, args)#
arelle.FunctionXfi.is_forever_period(xc, p, args)#
arelle.FunctionXfi.is_duration_period(xc, p, args)#
arelle.FunctionXfi.is_instant_period(xc, p, args)#
arelle.FunctionXfi.is_period_type(args, periodElement)#
arelle.FunctionXfi.period_start(xc, p, args)#
arelle.FunctionXfi.period_end(xc, p, args)#
arelle.FunctionXfi.period_instant(xc, p, args)#
arelle.FunctionXfi.period_datetime(p, args, periodElement)#
arelle.FunctionXfi.entity(xc, p, args)#
arelle.FunctionXfi.context_entity(xc, p, args)#
arelle.FunctionXfi.identifier(xc, p, args)#
arelle.FunctionXfi.context_identifier(xc, p, args)#
arelle.FunctionXfi.entity_identifier(xc, p, args)#
arelle.FunctionXfi.identifier_value(xc, p, args)#
arelle.FunctionXfi.identifier_scheme(xc, p, args)#
arelle.FunctionXfi.fact_identifier_value(xc, p, args)#
arelle.FunctionXfi.fact_identifier_scheme(xc, p, args)#
arelle.FunctionXfi.segment(xc, p, args)#
arelle.FunctionXfi.entity_segment(xc, p, args)#
arelle.FunctionXfi.context_segment(xc, p, args)#
arelle.FunctionXfi.scenario(xc, p, args)#
arelle.FunctionXfi.context_scenario(xc, p, args)#
arelle.FunctionXfi.precision(xc, p, args)#
arelle.FunctionXfi.decimals(xc, p, args)#
arelle.FunctionXfi.infer_precision_decimals(xc, p, args, attrName)#
arelle.FunctionXfi.numeric(xc, p, args)#
arelle.FunctionXfi.non_numeric(xc, p, args)#
arelle.FunctionXfi.fraction(xc, p, args)#
arelle.FunctionXfi.conceptProperty(xc, p, args, property)#
arelle.FunctionXfi.checkXffFunctionUse(xc, p, functionName)#
arelle.FunctionXfi.uncovered_aspect(xc, p, args)#
arelle.FunctionXfi.has_fallback_value(xc, p, args)#
arelle.FunctionXfi.uncovered_non_dimensional_aspects(xc, p, args)#
arelle.FunctionXfi.uncovered_dimensional_aspects(xc, p, args)#
arelle.FunctionXfi.uncovered_aspects(xc, p, args, dimensionAspects=False)#
arelle.FunctionXfi.nodesEqual(xc, args, test, mustBeItems=False, nonItemErrCode=None)#
arelle.FunctionXfi.setsEqual(xc, args, test, mustBeItems=False)#
arelle.FunctionXfi.identical_nodes(xc, p, args)#
arelle.FunctionXfi.identical_nodes_test(node1, node2)#
arelle.FunctionXfi.s_equal(xc, p, args)#
arelle.FunctionXfi.s_equal_test(node1, node2)#
arelle.FunctionXfi.u_equal(xc, p, args)#
arelle.FunctionXfi.u_equal_test(modelItem1, modelItem2)#
arelle.FunctionXfi.v_equal(xc, p, args)#
arelle.FunctionXfi.v_equal_test(modelItem1, modelItem2)#
arelle.FunctionXfi.c_equal(xc, p, args)#
arelle.FunctionXfi.c_equal_test(modelItem1, modelItem2)#
arelle.FunctionXfi.identical_node_set(xc, p, args)#
arelle.FunctionXfi.s_equal_set(xc, p, args)#
arelle.FunctionXfi.v_equal_set(xc, p, args)#
arelle.FunctionXfi.c_equal_set(xc, p, args)#
arelle.FunctionXfi.u_equal_set(xc, p, args)#
arelle.FunctionXfi.x_equal(xc, p, args)#
arelle.FunctionXfi.x_equal_test(node1, node2)#
arelle.FunctionXfi.duplicate_item(xc, p, args)#
arelle.FunctionXfi.duplicate_tuple(xc, p, args)#
arelle.FunctionXfi.duplicate_tuple_test(node1, node2, topLevel=True)#
arelle.FunctionXfi.p_equal(xc, p, args)#
arelle.FunctionXfi.p_equal_test(node1, node2)#
arelle.FunctionXfi.cu_equal(xc, p, args)#
arelle.FunctionXfi.cu_equal_test(modelItem1, modelItem2)#
arelle.FunctionXfi.pc_equal(xc, p, args)#
arelle.FunctionXfi.pc_equal_test(modelItem1, modelItem2)#
arelle.FunctionXfi.pcu_equal(xc, p, args)#
arelle.FunctionXfi.pcu_equal_test(modelItem1, modelItem2)#
arelle.FunctionXfi.start_equal(xc, p, args)#
arelle.FunctionXfi.end_equal(xc, p, args)#
arelle.FunctionXfi.taxonomy_refs(xc, p, args)#
arelle.FunctionXfi.date_equal_test(xc, p, args, instantEndDate)#
arelle.FunctionXfi.nodes_correspond(xc, p, args)#
arelle.FunctionXfi.facts_in_instance(xc, p, args)#
arelle.FunctionXfi.items_in_instance(xc, p, args)#
arelle.FunctionXfi.tuples_in_instance(xc, p, args)#
arelle.FunctionXfi.items_in_tuple(xc, p, args)#
arelle.FunctionXfi.tuples_in_tuple(xc, p, args)#
arelle.FunctionXfi.non_nil_facts_in_instance(xc, p, args)#
arelle.FunctionXfi.concept(xc, p, args)#
arelle.FunctionXfi.concept_balance(xc, p, args)#
arelle.FunctionXfi.concept_period_type(xc, p, args)#
arelle.FunctionXfi.concept_custom_attribute(xc, p, args)#
arelle.FunctionXfi.concept_data_type(xc, p, args)#
arelle.FunctionXfi.concept_data_type_derived_from(xc, p, args)#
arelle.FunctionXfi.concept_substitutions(xc, p, args)#
arelle.FunctionXfi.concepts_from_local_name(xc, p, args)#
arelle.FunctionXfi.concepts_from_local_name_pattern(xc, p, args)#
arelle.FunctionXfi.filter_member_network_selection(xc, p, args)#
arelle.FunctionXfi.filter_member_network_members(relationshipSet, fromRels, recurse, members=None, relationships=None, linkQnames=None, arcQnames=None)#
arelle.FunctionXfi.filter_member_DRS_selection(xc, p, args)#
arelle.FunctionXfi.filter_member_DRS_members(xc, fromRels, axis, memConcept, inSelection, visited, memSelectionQnames)#
arelle.FunctionXfi.dimension_default(xc, p, args)#
arelle.FunctionXfi.fact_segment_remainder(xc, p, args)#
arelle.FunctionXfi.fact_scenario_remainder(xc, p, args)#
arelle.FunctionXfi.fact_dim_value(xc, p, args, dimType)#
arelle.FunctionXfi.fact_has_explicit_dimension(xc, p, args)#
arelle.FunctionXfi.fact_has_typed_dimension(xc, p, args)#
arelle.FunctionXfi.fact_explicit_dimension_value_value(xc, p, args)#
arelle.FunctionXfi.fact_has_explicit_dimension_value(xc, p, args)#
arelle.FunctionXfi.fact_explicit_dimension_value(xc, p, args)#
arelle.FunctionXfi.fact_typed_dimension_value(xc, p, args)#
arelle.FunctionXfi.fact_typed_dimension_simple_value(xc, p, args)#
arelle.FunctionXfi.fact_explicit_dimensions(xc, p, args)#
arelle.FunctionXfi.fact_typed_dimensions(xc, p, args)#
arelle.FunctionXfi.fact_dimension_s_equal2(xc, p, args)#
arelle.FunctionXfi.navigate_relationships(xc, p, args)#
arelle.FunctionXfi.concept_label(xc, p, args)#
arelle.FunctionXfi.arcrole_definition(xc, p, args)#
arelle.FunctionXfi.role_definition(xc, p, args)#
arelle.FunctionXfi.fact_footnotes(xc, p, args)#
arelle.FunctionXfi.concept_relationships(xc, p, args, nestResults=False, targetRole=False)#
arelle.FunctionXfi.concept_relationships_step(xc, inst, relationshipSet, rels, axis, generations, result, visited, nestResults, targetRole)#
arelle.FunctionXfi.relationship_from_concept(xc, p, args)#
arelle.FunctionXfi.relationship_to_concept(xc, p, args)#
arelle.FunctionXfi.distinct_nonAbstract_parent_concepts(xc, p, args)#
arelle.FunctionXfi.relationship_element_attribute(xc, p, args, elementParent=False)#
arelle.FunctionXfi.element_attribute(element, attrQname)#
arelle.FunctionXfi.relationship_attribute(xc, p, args)#
arelle.FunctionXfi.element_name(xc, p, args, elementParent=False)#
arelle.FunctionXfi.relationship_name(xc, p, args)#
arelle.FunctionXfi.xbrl_instance(xc, p, args)#
arelle.FunctionXfi.format_number(xc, p, args)#
arelle.FunctionXfi.create_element(xc, p, args)#
arelle.FunctionXfi.any_identifier(xc, p, args)#
arelle.FunctionXfi.unique_identifiers(xc, p, args)#
arelle.FunctionXfi.single_unique_identifier(xc, p, args)#
arelle.FunctionXfi.any_start_date(xc, p, args)#
arelle.FunctionXfi.unique_start_dates(xc, p, args)#
arelle.FunctionXfi.single_unique_start_date(xc, p, args)#
arelle.FunctionXfi.any_end_date(xc, p, args)#
arelle.FunctionXfi.unique_end_dates(xc, p, args)#
arelle.FunctionXfi.single_unique_end_date(xc, p, args)#
arelle.FunctionXfi.any_instant_date(xc, p, args)#
arelle.FunctionXfi.unique_instant_dates(xc, p, args)#
arelle.FunctionXfi.single_unique_instant_date(xc, p, args)#
arelle.FunctionXfi.filingIndicatorValues(inst, filedValue)#
arelle.FunctionXfi.positive_filing_indicators(xc, p, args)#
arelle.FunctionXfi.positive_filing_indicator(xc, p, args)#
arelle.FunctionXfi.negative_filing_indicators(xc, p, args)#
arelle.FunctionXfi.negative_filing_indicator(xc, p, args)#
arelle.FunctionXfi.xfiFunctions#

None