Skip to content

Latest commit

 

History

History
227 lines (143 loc) · 9.56 KB

internals.rst

File metadata and controls

227 lines (143 loc) · 9.56 KB
Raw

Library Internals

Section Contents

highcharts_gantt.metaclasses

module: .metaclasses <highcharts_gantt.metaclasses>

The .metaclasses <highcharts_gantt.metaclasses> module contains - as one might expect - metaclasses <metaclass> that are used to ensure a consistent interface throughout the Highcharts Gantt for Python library.

class: HighchartsMeta <highcharts_gantt.metaclasses.HighchartsMeta>

HighchartsMeta

Class Inheritance

HighchartsMeta

class: JavaScriptDict <highcharts_gantt.metaclasses.JavaScriptDict>

JavaScriptDict

Class Inheritance

JavaScriptDict

highcharts_gantt.decorators

module: .decorators <highcharts_gantt.decorators>

The .decorators <highcharts_gantt.decorators> module contains decorators and decorator-assisting functions used throughout the Highcharts Gantt for Python library.

decorator: @class_sensitive <highcharts_gantt.decorators.class_sensitive>

class_sensitive

function: validate_types() <highcharts_gantt.decorators.validate_types>

validate_types

highcharts_gantt.js_literal_functions

module:: .js_literal_functions <highcharts_gantt.js_literal_functions>

The .js_literal_functions <highcharts_gantt.js_literal_functions> module contains functions that are used to parse, process, de-serialize, and serialize JavaScript literal notation.

function: serialize_to_js_literal() <highcharts_gantt.js_literal_functions.serialize_to_js_literal>

serialize_to_js_literal

function: attempt_variable_declaration() <highcharts_gantt.js_literal_functions.attempt_variable_declaration>

attempt_variable_declaration

function: is_js_function_or_class() <highcharts_gantt.js_literal_functions.is_js_function_or_class>

is_js_function_or_class

function: get_js_literal() <highcharts_gantt.js_literal_functions.get_js_literal>

get_js_literal

function: assemble_js_literal() <highcharts_gantt.js_literal_functions.assemble_js_literal>

assemble_js_literal

function: convert_js_literal_to_python() <highcharts_gantt.js_literal_functions.convert_js_literal_to_python>

convert_js_literal_to_python

function: convert_js_property_to_python() <highcharts_gantt.js_literal_functions.convert_js_property_to_python>

convert_js_property_to_python

function: convert_js_to_python() <highcharts_gantt.js_literal_functions.convert_js_to_python>

convert_js_to_python

function: get_key_value_pairs() <highcharts_gantt.js_literal_functions.get_key_value_pairs>

get_key_value_pairs

highcharts_gantt.utility_functions

.utility_functions <highcharts_gantt.utility_functions>

The .utility_functions <highcharts_gantt.utility_functions> module contains a small number of functions which serve as utilities across the Highcharts Gantt for Python library. Think of it as a function "catch all" module.

function:: mro_to_dict() <highcharts_gantt.utility_functions.mro_to_dict>

mro_to_dict

function:: get_remaining_mro() <highcharts_gantt.utility_functions.get_remaining_mro>

get_remaining_mro

function:: mro__to_untrimmed_dict() <highcharts_gantt.utility_functions.mro__to_untrimmed_dict>

mro__to_untrimmed_dict

function:: validate_color() <highcharts_gantt.utility_functions.validate_color>

validate_color

function:: to_camelCase() <highcharts_gantt.utility_functions.to_camelCase>

to_camelCase

function:: parse_csv() <highcharts_gantt.utility_functions.parse_csv>

parse_csv

function:: parse_jira_issue() <highcharts_gantt.utility_functions.parse_jira_issue>

parse_jira_issue

highcharts_gantt.monday

module:: .monday <highcharts_gantt.monday>

The .monday <highcharts_gantt.monday> module contains functions that are used to retrieve, parse, process, and de-serialize task items from the Monday.com API.

function: get_tasks() <highcharts_gantt.monday.get_tasks>

get_tasks

function: get_column_definitions() <highcharts_gantt.monday.get_column_definitions>

get_column_definitions

function: convert_item_to_task() <highcharts_gantt.monday.convert_item_to_task>

convert_item_to_task

function: format_column() <highcharts_gantt.monday.format_column>

format_column

function: get_column_title() <highcharts_gantt.monday.get_column_title>

get_column_title

function: get_column_type() <highcharts_gantt.monday.get_column_type>

get_column_type

function: elevate_subtasks() <highcharts_gantt.monday.elevate_subtasks>

elevate_subtasks

function: flatten_columns() <highcharts_gantt.monday.flatten_columns>

flatten_columns