OmniOutliner Module Reference

New in version 0.0.9.

Control OmniOutliner using JXA-like syntax.

Classes:

`XAOmniOutlinerAncestor`(properties)	The rows that this row is contained by, from the top level on down.
`XAOmniOutlinerAncestorList`(properties[, filter])	A wrapper around lists of ancestor rows that employs fast enumeration techniques.
`XAOmniOutlinerApplication`(properties)	A class for managing and interacting with OmniOutliner.app.
`XAOmniOutlinerArchiveData`(properties)	A archive data object.
`XAOmniOutlinerAttribute`(properties)	An attribute of a style.
`XAOmniOutlinerAttributeList`(properties[, filter])	A wrapper around lists of attributes that employs fast enumeration techniques.
`XAOmniOutlinerCell`(properties)	A cell object in OmniOutliner.app.
`XAOmniOutlinerCellList`(properties[, filter])	A wrapper around lists of cells that employs fast enumeration techniques.
`XAOmniOutlinerChild`(properties)	For a document, the top level rows.
`XAOmniOutlinerChildList`(properties[, filter])	A wrapper around lists of child rows that employs fast enumeration techniques.
`XAOmniOutlinerColumFormat`(properties)	A column format in OmniOutliner.app.
`XAOmniOutlinerColumn`(properties)	A column in OmniOutliner.app.
`XAOmniOutlinerColumnList`(properties[, ...])	A wrapper around lists of OmniOutliner columns that employs fast enumeration techniques.
`XAOmniOutlinerConduitSettingDomain`(properties)	A group of custom settings from one external source.
`XAOmniOutlinerConduitSettingDomainList`(...)	A wrapper around lists of conduit setting domains that employs fast enumeration techniques.
`XAOmniOutlinerDocument`(properties)	A document in OmniOutliner.app.
`XAOmniOutlinerDocumentList`(properties[, filter])	A wrapper around lists of OmniOutliner documents that employs fast enumeration techniques.
`XAOmniOutlinerDocumentType`(properties)	A document type in OmniOutliner.app.
`XAOmniOutlinerDocumentTypeList`(properties[, ...])	A wrapper around lists of document types that employs fast enumeration techniques.
`XAOmniOutlinerEnumeration`(properties)	An enumeration in OmniOutliner.app.
`XAOmniOutlinerEnumerationList`(properties[, ...])	A wrapper around lists of enumerations that employs fast enumeration techniques.
`XAOmniOutlinerFileAttachment`(properties)	A file attachment object in OmniOutliner.app.
`XAOmniOutlinerFileAttachmentList`(properties)	A wrapper around lists of file attachments that employs fast enumeration techniques.
`XAOmniOutlinerFollowingSibling`(properties)	The row which follows this row.
`XAOmniOutlinerFollowingSiblingList`(properties)	A wrapper around lists of following siblings that employs fast enumeration techniques.
`XAOmniOutlinerGenericColor`(properties)	A generic color value.
`XAOmniOutlinerLeaf`(properties)	The leaf rows underneath a document or row.
`XAOmniOutlinerLeafList`(properties[, filter])	A wrapper around lists of leaf rows that employs fast enumeration techniques.
`XAOmniOutlinerLevelStyle`(properties)	A level style object in a document.
`XAOmniOutlinerLevelStyleList`(properties[, ...])	A wrapper around lists of level styles that employs fast enumeration techniques.
`XAOmniOutlinerNamedStyle`(properties)	A named style object.
`XAOmniOutlinerNamedStyleList`(properties[, ...])	A wrapper around lists of named styles that employs fast enumeration techniques.
`XAOmniOutlinerPNGData`(properties)	A PNG data object.
`XAOmniOutlinerPathComponent`(properties)	A list of rows up to and including the given row.
`XAOmniOutlinerPathComponentList`(properties)	A wrapper around lists of path components that employs fast enumeration techniques.
`XAOmniOutlinerPoint`(properties)	A point value.
`XAOmniOutlinerPrecedingSibling`(properties)	The row which precedes this row.
`XAOmniOutlinerPrecedingSiblingList`(properties)	A wrapper around lists of preceding siblings that employs fast enumeration techniques.
`XAOmniOutlinerPreference`(properties)	A row object in OmniOutliner.app.
`XAOmniOutlinerPreferenceList`(properties[, ...])	A wrapper around lists of preferences that employs fast enumeration techniques.
`XAOmniOutlinerReadableDocumentType`(properties)	A readable document type in OmniOutliner.app.
`XAOmniOutlinerReadableDocumentTypeList`(...)	A wrapper around lists of readable document types that employs fast enumeration techniques.
`XAOmniOutlinerRichText`(properties)	A row object in OmniOutliner.app.
`XAOmniOutlinerRichTextList`(properties[, filter])	A wrapper around lists of rich texts that employs fast enumeration techniques.
`XAOmniOutlinerRow`(properties)	A row object in OmniOutliner.app.
`XAOmniOutlinerRowList`(properties[, filter, ...])	A wrapper around lists of rows that employs fast enumeration techniques.
`XAOmniOutlinerSection`(properties)	The sections underneath the document or row.
`XAOmniOutlinerSectionList`(properties[, filter])	A wrapper around lists of sections that employs fast enumeration techniques.
`XAOmniOutlinerSelectedColumn`(properties)	A style object in OmniOutliner.app.
`XAOmniOutlinerSelectedColumnList`(properties)	A wrapper around lists of selected columns that employs fast enumeration techniques.
`XAOmniOutlinerSelectedRow`(properties)	The sections underneath the document or row.
`XAOmniOutlinerSelectedRowList`(properties[, ...])	A wrapper around lists of selected rows that employs fast enumeration techniques.
`XAOmniOutlinerStyle`(properties)	A style object in OmniOutliner.app.
`XAOmniOutlinerStyleList`(properties[, ...])	A wrapper around lists of OmniOutliner styles that employs fast enumeration techniques.
`XAOmniOutlinerTIFFData`(properties)	A TIFF data object.
`XAOmniOutlinerWindow`(properties)	A window of OmniOutliner.app.
`XAOmniOutlinerWritableDocumentType`(properties)	A writable document type in OmniOutliner.app.
`XAOmniOutlinerWritableDocumentTypeList`(...)	A wrapper around lists of writable document types that employs fast enumeration techniques.
`XAOmniOutlinerXslTransform`(properties)	This class represents an available XSL transformation that may be applied when loading or saving documents.
`XAOmniOutlinerXslTransformList`(properties[, ...])	A wrapper around lists of XSL transforms that employs fast enumeration techniques.

class PyXA.apps.OmniOutliner.XAOmniOutlinerAncestor(properties)[source]

Bases: XAOmniOutlinerRow

The rows that this row is contained by, from the top level on down.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerAncestorList(properties: dict, filter: dict | None = None)[source]

Bases: XAOmniOutlinerRowList

A wrapper around lists of ancestor rows that employs fast enumeration techniques.

All properties of ancestor rows can be called as methods on the wrapped list, returning a list containing each ancestor row’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerApplication(properties)[source]

Bases: XASBApplication, XACanOpenPath, XACanPrintPath

A class for managing and interacting with OmniOutliner.app.

New in version 0.0.9.

Classes:

`Alignment`(value)	Text alignment types.
`CheckboxState`(value)	Checkbox states.
`ColumnSummaryType`(value)	Column summary types.
`ColumnType`(value)	Column types.
`DisplayType`(value)	Note display types.
`FormatStyle`(value)	Format styles.
`SortOrder`(value)	Sort order directions.

Attributes:

`build_number`	The build number of the application, for example 63.1 or 63.
`frontmost`	Whether OmniOutliner is the active application.
`imported_files_should_store_compressed`	Controls whether OmniOutliner will default imported files to being stored in a compressed format.
`name`	The name of the application.
`prompt_on_file_format_upgrade`	Controls whether OmniOutliner will prompt the user when updating a older file format to a newer one.
`version`	The version of OmniOutliner.app.

Methods:

`document_types`([filter])	Returns a list of document types, as PyXA objects, matching the given filter.
`documents`([filter])	Returns a list of documents, as PyXA objects, matching the given filter.
`preferences`([filter])	Returns a list of preferences, as PyXA objects, matching the given filter.
`readable_document_types`([filter])	Returns a list of readable document types, as PyXA objects, matching the given filter.
`test`()
`writable_document_types`([filter])	Returns a list of writable document types, as PyXA objects, matching the given filter.
`xsl_transforms`([filter])	Returns a list of XSL transforms, as PyXA objects, matching the given filter.

class Alignment(value)[source]

Bases: Enum

Text alignment types.

Attributes:

`CENTER`
`JUSTIFIED`
`LEFT`
`NATURAL`
`RIGHT`

CENTER = 1330929969

JUSTIFIED = 1330929971

LEFT = 1330929968

NATURAL = 1330929972

RIGHT = 1330929970

class CheckboxState(value)[source]

Bases: Enum

Checkbox states.

Attributes:

`CHECKED`	Checkbox checked
`INDETERMINATE`	Indeterminate checkbox state
`NONE`	No checkbox state
`UNCHECKED`	Checkbox unchecked

CHECKED = 1330598706: Checkbox checked

INDETERMINATE = 1330598705: Indeterminate checkbox state

NONE = 1330605679: No checkbox state

UNCHECKED = 1330598704: Checkbox unchecked

class ColumnSummaryType(value)[source]

Bases: Enum

Column summary types.

Attributes:

`AVERAGE`
`CALCULATED`
`HIDDEN`
`MAXIMUM`
`MINIMUM`
`NONE`
`TOTAL`

AVERAGE = 1332964662

CALCULATED = 1332964658

HIDDEN = 1332964657

MAXIMUM = 1332964660

MINIMUM = 1332964661

NONE = 1330605679

TOTAL = 1332964659

class ColumnType(value)[source]

Bases: Enum

Column types.

Attributes:

`CHECKBOX`
`DATETIME`
`DURATION`
`NUMERIC`
`POPUP`
`STYLED_TEXT`

CHECKBOX = 1331917873

DATETIME = 1331917874

DURATION = 1331917875

NUMERIC = 1331917877

POPUP = 1331917876

STYLED_TEXT = 1331917872

class DisplayType(value)[source]

Bases: Enum

Note display types.

Attributes:

`INLINE`	Inline display type
`OUT_OF_LINE`	Out of line display type

INLINE = 1332634673: Inline display type

OUT_OF_LINE = 1332634674: Out of line display type

class FormatStyle(value)[source]

Bases: Enum

Format styles.

Attributes:

`FULL`
`LONG`
`MEDIUM`
`SHORT`

FULL = 1330595398

LONG = 1330595404

MEDIUM = 1330595405

SHORT = 1330595411

class SortOrder(value)[source]

Bases: Enum

Sort order directions.

Attributes:

`ASCENDING`	Ascending sort order
`DESCENDING`	Descending sort order
`NONE`	No sort direction

ASCENDING = 1330606897: Ascending sort order

DESCENDING = 1330606898: Descending sort order

NONE = 1330605679: No sort direction

property build_number: str: The build number of the application, for example 63.1 or 63. Major and minor versions are separated by a dot, so 63.10 comes after 63.1.

document_types(filter: dict | None = None) → XAOmniOutlinerDocumentTypeList[source]: Returns a list of document types, as PyXA objects, matching the given filter.

New in version 0.0.9.

documents(filter: dict | None = None) → XAOmniOutlinerDocumentList[source]: Returns a list of documents, as PyXA objects, matching the given filter.

New in version 0.0.9.

property frontmost: bool: Whether OmniOutliner is the active application.

property imported_files_should_store_compressed: bool: Controls whether OmniOutliner will default imported files to being stored in a compressed format.

property name: str: The name of the application.

preferences(filter: dict | None = None) → XAOmniOutlinerPreferenceList[source]: Returns a list of preferences, as PyXA objects, matching the given filter.

New in version 0.0.9.

property prompt_on_file_format_upgrade: bool: Controls whether OmniOutliner will prompt the user when updating a older file format to a newer one.

readable_document_types(filter: dict | None = None) → XAOmniOutlinerReadableDocumentTypeList[source]: Returns a list of readable document types, as PyXA objects, matching the given filter.

New in version 0.0.9.

test()[source]

property version: str: The version of OmniOutliner.app.

writable_document_types(filter: dict | None = None) → XAOmniOutlinerWritableDocumentTypeList[source]: Returns a list of writable document types, as PyXA objects, matching the given filter.

New in version 0.0.9.

xsl_transforms(filter: dict | None = None) → XAOmniOutlinerXslTransformList[source]: Returns a list of XSL transforms, as PyXA objects, matching the given filter.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerArchiveData(properties)[source]

Bases: XAObject

A archive data object.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerAttribute(properties)[source]

Bases: XAObject

An attribute of a style.

New in version 0.0.9.

Methods:

clear()

Clears a locally set value for a style attribute.

Attributes:

`default_value`	The default value of the attribute in its style.
`defining_style`	The style responsible for the effective value in this attributes's style.
`has_local_value`	If true, the containing style defines a local value for this attribute.
`name`	The name of the attribute.
`style`	The style to which the attribute refers.
`value`	The value of the attribute in its style.

clear()[source]: Clears a locally set value for a style attribute.

New in version 0.0.9.

property default_value: XAOmniOutlinerGenericColor | XAColor | str | XAURL | float | list[float] | int | bool | XAOmniOutlinerPoint | None: The default value of the attribute in its style.

property defining_style: XAOmniOutlinerStyle: The style responsible for the effective value in this attributes’s style. This processes the local values, inherited styles and cascade chain.

property has_local_value: bool: If true, the containing style defines a local value for this attribute.

property name: str: The name of the attribute.

property style: XAOmniOutlinerStyle: The style to which the attribute refers.

property value: XAOmniOutlinerGenericColor | XAColor | str | XAURL | float | list[float] | int | bool | XAOmniOutlinerPoint | None: The value of the attribute in its style.

class PyXA.apps.OmniOutliner.XAOmniOutlinerAttributeList(properties: dict, filter: dict | None = None)[source]

Bases: XAList

A wrapper around lists of attributes that employs fast enumeration techniques.

All properties of attributes can be called as methods on the wrapped list, returning a list containing each attribute’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerCell(properties)[source]

Bases: XAObject

A cell object in OmniOutliner.app.

New in version 0.0.9.

Attributes:

`column`	Column that this cell is in.
`id`	The unique identifier of the cell within the containing row.
`name`	The name of the cell.
`row`	Row that this cell is in.
`state`	State of the cell.
`text`	Text of the cell.
`value`	Contents of the cell, whatever the type.

Methods:

replace(replacement[, regex_to_find, ...])

Replaces the contents of the cell.

property column: XAOmniOutlinerColumn: Column that this cell is in.

property id: str: The unique identifier of the cell within the containing row. This identifier is the same as the identifier of the cell’s column.

property name: str: The name of the cell. This is the same as the name of the cell’s column.

replace(replacement: str, regex_to_find: str | None = None, string_to_find: str | None = None)[source]

Replaces the contents of the cell.

Parameters:

replacement (str) – The replacement string
regex_to_find (Union[str, None], optional) – The regular expression to find and replace, defaults to None
string_to_find (Union[str, None], optional) – The string to find and replace, defaults to None

New in version 0.0.9.

property row: XAOmniOutlinerRow: Row that this cell is in.

property state: CheckboxState: State of the cell. This is only valid on checkbox columns.

property text: XAOmniOutlinerRichText: Text of the cell. This is only valid on text columns.

property value: str | datetime | int | float | XAOmniOutlinerEnumeration | CheckboxState: Contents of the cell, whatever the type.

class PyXA.apps.OmniOutliner.XAOmniOutlinerCellList(properties: dict, filter: dict | None = None)[source]

Bases: XAList

A wrapper around lists of cells that employs fast enumeration techniques.

All properties of cells can be called as methods on the wrapped list, returning a list containing each cell’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerChild(properties)[source]

Bases: XAOmniOutlinerRow

For a document, the top level rows. For a row, the rows one level below this one.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerChildList(properties: dict, filter: dict | None = None)[source]

Bases: XAOmniOutlinerRowList

A wrapper around lists of child rows that employs fast enumeration techniques.

All properties of child rows can be called as methods on the wrapped list, returning a list containing each child row’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerColumFormat(properties)[source]

Bases: XAObject

A column format in OmniOutliner.app.

New in version 0.0.9.

Attributes:

`calendar`	The calendar to use for date formats.
`currency`	The ISO currency identifier (such as "USD" or "JPY") for columns with a currency format.
`date_style`	The style of date format to use, based off the user's preference.
`format`	The ICU format string.
`id`	The identifier for built-in formats.
`locale`	The locale identifier (such as "en_US" or "ja_JP") for formats.
`time_style`	The style of time format to use, based off the user's preference.
`timezone`	The time zone to use for date formats.

property calendar: str: The calendar to use for date formats.

property currency: The ISO currency identifier (such as “USD” or “JPY”) for columns with a currency format. Must be used with an id of “currency.

property date_style: FormatStyle: The style of date format to use, based off the user’s preference.

property format: str: The ICU format string.

property id: str: The identifier for built-in formats.

property locale: str: The locale identifier (such as “en_US” or “ja_JP”) for formats.

property time_style: FormatStyle: The style of time format to use, based off the user’s preference.

property timezone: str: The time zone to use for date formats.

class PyXA.apps.OmniOutliner.XAOmniOutlinerColumn(properties)[source]

Bases: XAObject

A column in OmniOutliner.app.

New in version 0.0.9.

Attributes:

`alignment`	Default alignment for cells of the column.
`background_color`	The background color of the column.
`column_format`	All aspects of the column's format.
`column_style`	The style of the column.
`column_type`	This is the type of the column.
`document`	The document containing the column.
`format_string`	The format string for formatted columns.
`id`	An identifier for the column that is unique within the document.
`index`	The index of the column in the document.
`name`	The name of the column.
`sort_order`	The sort order of the column.
`summary_type`	This is the summary type of the column.
`title`	The title of the column.
`visible`	Whether the column is visible or not.
`width`	The width of the column in pixels.

Methods:

`enumerations`([filter])	Returns a list of enumerations, as PyXA objects, matching the given filter.
`move_to`(destination)	Moves the column to the specified document.

property alignment: Alignment: Default alignment for cells of the column.

property background_color: XAColor: The background color of the column.

property column_format: XAOmniOutlinerColumFormat: All aspects of the column’s format.

property column_style: XAOmniOutlinerStyle: The style of the column. This is used as the default style for values in the column (but is overriden by any style attributes defined on rows).

property column_type: ColumnType: This is the type of the column.

property document: XAOmniOutlinerDocument: The document containing the column.

enumerations(filter: dict | None = None) → XAOmniOutlinerEnumerationList[source]: Returns a list of enumerations, as PyXA objects, matching the given filter.

New in version 0.0.9.

property format_string: str: The format string for formatted columns. Depends on the type of the column.

property id: str: An identifier for the column that is unique within the document.

property index: int: The index of the column in the document. This includes hidden columns.

move_to(destination: XAOmniOutlinerDocument)[source]

Moves the column to the specified document.

Parameters:: destination (XAOmniOutlinerDocument) – The document to move the column to

New in version 0.0.9.

property name: str: The name of the column. This is currently the same as the title, but in the future the title may be styled while the name will always be a plain string.

property sort_order: SortOrder: The sort order of the column.

property summary_type: ColumnSummaryType: This is the summary type of the column.

property title: str: The title of the column.

property visible: bool: Whether the column is visible or not.

property width: int: The width of the column in pixels.

class PyXA.apps.OmniOutliner.XAOmniOutlinerColumnList(properties: dict, filter: dict | None = None, obj_class=None)[source]

Bases: XAList

A wrapper around lists of OmniOutliner columns that employs fast enumeration techniques.

All properties of columns can be called as methods on the wrapped list, returning a list containing each column’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerConduitSettingDomain(properties)[source]

Bases: XAObject

A group of custom settings from one external source. Note that conduit setting domains should only be referenced by ‘id’. The first time one is referenced it will be created. Any other type of access (by index, every, etc.) will produce an error.

New in version 0.0.9.

Attributes:

`container`	The row or document containing this group of conduit settings.
`external_id`	Identifies the conduit externally to OmniOutliner.
`id`	The unique identifier of the domain.
`settings`	Values must be strings or 'missing value' (removes value).

property container: XAObject: The row or document containing this group of conduit settings.

property external_id: str: Identifies the conduit externally to OmniOutliner. This might be a record identifier in an external database. This will not get copied when duplicating the row, or if a ‘save as’ or ‘save to’ operation is performed instead of a normal ‘save’.

property id: str: The unique identifier of the domain. These should typically be in the reverse-DNS style of bundle identifiers (“com.mycompany.myproduct”).

property settings: list[str | None]: Values must be strings or ‘missing value’ (removes value). To set a single entry, concatenate the current value with the changes and then re-set it. Concatenating an empty and non-empty record crashes AppleScript, so ‘missing value’ will be returned.

class PyXA.apps.OmniOutliner.XAOmniOutlinerConduitSettingDomainList(properties: dict, filter: dict | None = None)[source]

Bases: XAList

A wrapper around lists of conduit setting domains that employs fast enumeration techniques.

All properties of conduit setting domains can be called as methods on the wrapped list, returning a list containing each domain’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerDocument(properties)[source]

Bases: XAObject, XACloseable, XAPrintable

A document in OmniOutliner.app.

New in version 0.0.9.

Methods:

`add`(items)	Adds objects to the document.
`add_to`(destination)	Adds the document to a location.
`children`([filter])	Returns a list of children, as PyXA objects, matching the given filter.
`collapse_all`([items])	Collapse the entire outline of an object.
`columns`([filter])	Returns a list of columns, as PyXA objects, matching the given filter.
`expand_all`([items])	Expand the entire outline of an object.
`export`(file[, type])	Exports the document to the specified location and file type.
`group`([rows])	Increase the outline level of a list of rows by creating a new parent row for them and moving under that new row.
`hoist`([rows])	Hide all rows in the outline, except for the descendants of the row passed to this command.
`leaves`([filter])	Returns a list of leaves, as PyXA objects, matching the given filter.
`level_styles`([filter])	Returns a list of level styles, as PyXA objects, matching the given filter.
`named_styles`([filter])	Returns a list of named styles, as PyXA objects, matching the given filter.
`pbcopy`(items[, type, clipboard_name])	Copies one or more nodes to the clipboard.
`pbpaste`(location[, clipboard_name])	Pastes nodes from the clipboard.
`redo`()	Redoes the most recent undo operation.
`remove`(items)	Remove objects from the document.
`remove_from`(container)	Adds the document to a location.
`rows`([filter])	Returns a list of rows, as PyXA objects, matching the given filter.
`sections`([filter])	Returns a list of sections, as PyXA objects, matching the given filter.
`select`([items, extend])	Selects one or more objects.
`selected_columns`([filter])	Returns a list of selected columns, as PyXA objects, matching the given filter.
`selected_rows`([filter])	Returns a list of selected rows, as PyXA objects, matching the given filter.
`undo`()	Undoes the most recent change.
`ungroup`([rows])	Decrease the outline level of all children of a row, moving them left one step.
`unhoist`([documents, unhoist_all])	Show rows hidden in the last hoist operation on a document.

Attributes:

`alternate_color`	The background color of every other row.
`background_color`	The background color of the document.
`canredo`	Whether the document can redo the most recently undone command.
`canundo`	Whether the document can undo the most recent command.
`children_are_sections`	This is always true for documents.
`column_title_style`	The style of column titles.
`editable`	This lets you know whether the document is editable.
`file`	The location of the file on disk, if it has one.
`folded_editing_enabled`	Whether folded editing of item and inline note text is enabled.
`has_subtopics`	Whether the document has any subtopics.
`horizontal_grid_color`	The color of hairline dividers between rows.
`id`	An identifier unique to the document.
`modified`	Whether the document has been modified since it was last saved.
`name`	The name of the document.
`note_column`	The column of the document that contains the notes for the rows.
`note_display`	Whether notes are displayed inline.
`notescolumnid`	The note column id for newly created documents.
`save_identifier`	A string that changes each time the document is saved.
`save_identifier_enabled`	Controls whether a save identifier will be emitted in the archived document each time the document is saved.
`sorting_postponed`	Whether sorting is currently postponed for the document.
`status_sort_order`	The sort order used for the status checkbox in the topic column.
`status_visible`	Whether the status checkbox is visible in the outline column.
`store_compressed`	Whether xml should be compressed when saved.
`style`	The default style for the document.
`title`	This is the title of the document.
`topic_column`	The column of the document that displays the hierarchy of rows.
`topiccolumnid`	The topic column id for newly created documents.
`undo_enabled`	Controls whether undo is currently enabled in the document.
`vertical_grid_color`	The color hairline dividers between columns.
`visible`	Whether the interface for the document is visible.
`writes_wrapper`	If set to true, this indicates that the document will write itself as a file wrapper (folder).

add(items: XAObject | list[XAObject])[source]

Adds objects to the document.

Parameters:: items (Union[XABase.XAObject, list[XABase.XAObject]]) – The object(s) to add

New in version 0.0.9.

add_to(destination: XAObject)[source]

Adds the document to a location.

Parameters:: destination (XABase.XAObject) – The container to which to add the document

New in version 0.0.9.

property alternate_color: XAColor: The background color of every other row.

property background_color: XAColor: The background color of the document.

property canredo: bool: Whether the document can redo the most recently undone command.

property canundo: bool: Whether the document can undo the most recent command.

children(filter: dict | None = None) → XAOmniOutlinerChildList[source]: Returns a list of children, as PyXA objects, matching the given filter.

New in version 0.0.9.

property children_are_sections: bool: This is always true for documents. This is here to make it easier to deal with mixed lists of rows and documents.

collapse_all(items: XAOmniOutlinerDocument | XAOmniOutlinerRow | XAOmniOutlinerDocumentList | XAOmniOutlinerRowList | list[XAOmniOutlinerDocument] | list[XAOmniOutlinerRow] | None = None)[source]: Collapse the entire outline of an object.

New in version 0.0.9.

property column_title_style: XAOmniOutlinerStyle: The style of column titles.

columns(filter: dict | None = None) → XAOmniOutlinerColumnList[source]: Returns a list of columns, as PyXA objects, matching the given filter.

New in version 0.0.9.

property editable: bool: This lets you know whether the document is editable. For example, the release notes document is not editable, so your script may want to avoid trying to edit it.

expand_all(items: XAOmniOutlinerDocument | XAOmniOutlinerRow | XAOmniOutlinerDocumentList | XAOmniOutlinerRowList | list[XAOmniOutlinerDocument] | list[XAOmniOutlinerRow] | None = None)[source]: Expand the entire outline of an object.

New in version 0.0.9.

export(file: str | XAPath, type: str | None = None)[source]

Exports the document to the specified location and file type. Unlike the “save” command, this will never set the name of the document or change its modified flag.

Parameters:

file (Union[str, XABase.XAPath]) – Where to place the exported document
type (Union[str, None], optional) – The name of a writable file type to use when writing the document. Defaults to the appropriate type for the path extension on the export destination, defaults to None

New in version 0.0.9.

property file: XAPath: The location of the file on disk, if it has one.

property folded_editing_enabled: bool: Whether folded editing of item and inline note text is enabled.

group(rows: XAOmniOutlinerRow | XAOmniOutlinerRowList | list[XAOmniOutlinerRow] | None = None)[source]

Increase the outline level of a list of rows by creating a new parent row for them and moving under that new row.

Parameters:: rows (Union[XAOmniOutlinerRow, XAOmniOutlinerRowList, list[XAOmniOutlinerRow], None], optional) – The rows to group, defaults to None

New in version 0.0.9.

property has_subtopics: bool: Whether the document has any subtopics.

hoist(rows: XAOmniOutlinerRow | XAOmniOutlinerRowList | list[XAOmniOutlinerRow] | None = None)[source]

Hide all rows in the outline, except for the descendants of the row passed to this command.

Parameters:: rows (Union[XAOmniOutlinerRow, XAOmniOutlinerRowList, list[XAOmniOutlinerRow], None], optional) – The rows to hoist, defaults to None

New in version 0.0.9.

property horizontal_grid_color: XAColor: The color of hairline dividers between rows.

property id: str: An identifier unique to the document.

leaves(filter: dict | None = None) → XAOmniOutlinerLeafList[source]: Returns a list of leaves, as PyXA objects, matching the given filter.

New in version 0.0.9.

level_styles(filter: dict | None = None) → XAOmniOutlinerLevelStyleList[source]: Returns a list of level styles, as PyXA objects, matching the given filter.

New in version 0.0.9.

property modified: bool: Whether the document has been modified since it was last saved.

property name: str: The name of the document.

named_styles(filter: dict | None = None) → XAOmniOutlinerNamedStyleList[source]: Returns a list of named styles, as PyXA objects, matching the given filter.

New in version 0.0.9.

property note_column: XAOmniOutlinerColumn: The column of the document that contains the notes for the rows.

property note_display: DisplayType: Whether notes are displayed inline.

property notescolumnid: str: The note column id for newly created documents.

pbcopy(items: list[XAObject], type: str | list[str] | None = None, clipboard_name: str | None = None)[source]

Copies one or more nodes to the clipboard.

Parameters:

items (list[XABase.XAObject]) – The list of items to copy to the clipboard
type (Union[str, list[str], None], optional) – The list of type identifier to use when copying the trees. If omitted, all writable clipboard types are used, defaults to None
clipboard_name (Union[str, None], optional) – The name of the clipboard to copy to, defaults to None

New in version 0.0.9.

pbpaste(location: XAObject, clipboard_name: str | None = None)[source]

Pastes nodes from the clipboard.

Parameters:

location (XABase.XAObject) – The location at which to paste the nodes
clipboard_name (Union[str, None], optional) – The name of the clipboard to paste from, defaults to None

New in version 0.0.9.

redo()[source]: Redoes the most recent undo operation.

New in version 0.0.9.

remove(items: XAObject | list[XAObject])[source]

Remove objects from the document.

Parameters:: items (Union[XABase.XAObject, list[XABase.XAObject]]) – The object(s) to remove

New in version 0.0.9.

remove_from(container: XAObject)[source]

Adds the document to a location.

Parameters:: container (XABase.XAObject) – The container from which to remove the document

New in version 0.0.9.

rows(filter: dict | None = None) → XAOmniOutlinerRowList[source]: Returns a list of rows, as PyXA objects, matching the given filter.

New in version 0.0.9.

property save_identifier: str: A string that changes each time the document is saved. If the save identifier is disabled, then this returns ‘missing value’.

property save_identifier_enabled: bool: Controls whether a save identifier will be emitted in the archived document each time the document is saved. This is useful for external tools that need to quickly determine whether the document has changed without relying on the file modification time.

sections(filter: dict | None = None) → XAOmniOutlinerSectionList[source]: Returns a list of sections, as PyXA objects, matching the given filter.

New in version 0.0.9.

select(items: XAObject | list[XAObject] | None = None, extend: bool = False)[source]

Selects one or more objects.

Parameters:

items (Union[XABase.XAObject, list[XABase.XAObject], None]) – An object or list of objects to select
extend (bool, optional) – Whether the selection is replaced or extended, defaults to False

New in version 0.0.9.

selected_columns(filter: dict | None = None) → XAOmniOutlinerSelectedColumnList[source]: Returns a list of selected columns, as PyXA objects, matching the given filter.

New in version 0.0.9.

selected_rows(filter: dict | None = None) → XAOmniOutlinerSelectedRowList[source]: Returns a list of selected rows, as PyXA objects, matching the given filter.

New in version 0.0.9.

property sorting_postponed: bool: Whether sorting is currently postponed for the document.

property status_sort_order: SortOrder: The sort order used for the status checkbox in the topic column.

property status_visible: bool: Whether the status checkbox is visible in the outline column.

property store_compressed: bool: Whether xml should be compressed when saved.

property style: XAOmniOutlinerStyle: The default style for the document.

property title: str: This is the title of the document.

property topic_column: XAOmniOutlinerColumn: The column of the document that displays the hierarchy of rows.

property topiccolumnid: str: The topic column id for newly created documents.

undo()[source]: Undoes the most recent change.

New in version 0.0.9.

property undo_enabled: bool: Controls whether undo is currently enabled in the document. This should be used very carefully. If it is set to ‘false’, all previously registered undo events will be removed and any further modifications to the document will not record undo operations.

ungroup(rows: XAOmniOutlinerRow | XAOmniOutlinerRowList | list[XAOmniOutlinerRow] | None = None)[source]

Decrease the outline level of all children of a row, moving them left one step.

Parameters:: rows (Union[XAOmniOutlinerRow, XAOmniOutlinerRowList, list[XAOmniOutlinerRow], None], optional) – The rows to ungroup, defaults to None

New in version 0.0.9.

unhoist(documents: XAOmniOutlinerDocument | XAOmniOutlinerDocumentList | list[XAOmniOutlinerDocument] | None = None, unhoist_all: bool = False)[source]

Show rows hidden in the last hoist operation on a document.

Parameters:

documents (Union[XAOmniOutlinerDocument, XAOmniOutlinerDocumentList, list[XAOmniOutlinerDocument], None], optional) – The documents to unhoist, defaults to None
unhoist_all (bool, optional) – Reverse just the last Hoist operation on the outline, or show items hidden by all previous Hoist operations, defaults to False

New in version 0.0.9.

property vertical_grid_color: XAColor: The color hairline dividers between columns.

property visible: bool: Whether the interface for the document is visible. Note that miniaturized counts as visible. Mostly this isn’t useful to third parties right now.

property writes_wrapper: bool: If set to true, this indicates that the document will write itself as a file wrapper (folder).

class PyXA.apps.OmniOutliner.XAOmniOutlinerDocumentList(properties: dict, filter: dict | None = None)[source]

Bases: XAList

A wrapper around lists of OmniOutliner documents that employs fast enumeration techniques.

All properties of documents can be called as methods on the wrapped list, returning a list containing each document’s value for the property.

New in version 0.0.9.

Methods:

`alternate_color`()
`background_color`()
`canredo`()
`canundo`()
`children_are_sections`()
`column_title_style`()
`editable`()
`file`()
`folded_editing_enabled`()
`has_subtopics`()
`horizontal_grid_color`()
`id`()
`modified`()
`name`()
`note_column`()
`note_display`()
`notecolumnid`()
`save_identifier`()
`save_identifier_enabled`()
`sorting_postponed`()
`status_sort_order`()
`status_visible`()
`store_compressed`()
`style`()
`title`()
`topic_column`()
`topiccolumnid`()
`undo_enabled`()
`verticalGridColor`()
`visible`()
`writes_wrapper`()

alternate_color() → list[XAColor][source]

background_color() → list[XAColor][source]

canredo() → list[bool][source]

canundo() → list[bool][source]

children_are_sections() → list[bool][source]

column_title_style() → XAOmniOutlinerStyleList[source]

editable() → list[bool][source]

file() → list[XAPath][source]

folded_editing_enabled() → list[bool][source]

has_subtopics() → list[bool][source]

horizontal_grid_color() → list[XAColor][source]

id() → list[str][source]

modified() → list[bool][source]

name() → list[str][source]

note_column() → XAOmniOutlinerColumnList[source]

note_display() → list[DisplayType][source]

notecolumnid() → list[str][source]

save_identifier() → list[str][source]

save_identifier_enabled() → list[bool][source]

sorting_postponed() → list[bool][source]

status_sort_order() → list[SortOrder][source]

status_visible() → list[bool][source]

store_compressed() → list[bool][source]

style() → XAOmniOutlinerStyleList[source]

title() → list[str][source]

topic_column() → XAOmniOutlinerColumnList[source]

topiccolumnid() → list[str][source]

undo_enabled() → list[bool][source]

verticalGridColor() → list[XAColor][source]

visible() → list[bool][source]

writes_wrapper() → list[bool][source]

class PyXA.apps.OmniOutliner.XAOmniOutlinerDocumentType(properties)[source]

Bases: XAObject

A document type in OmniOutliner.app.

New in version 0.0.9.

Attributes:

`display_name`	A user-presentable display name for this document type.
`file_extensions`	File extensions for this document type.
`uti`	The Uniform Type Identifier for this document type.

property display_name: str: A user-presentable display name for this document type.

property file_extensions: list[str]: File extensions for this document type.

property uti: str: The Uniform Type Identifier for this document type.

class PyXA.apps.OmniOutliner.XAOmniOutlinerDocumentTypeList(properties: dict, filter: dict | None = None, obj_class=None)[source]

Bases: XAList

A wrapper around lists of document types that employs fast enumeration techniques.

All properties of document types can be called as methods on the wrapped list, returning a list containing each types’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerEnumeration(properties)[source]

Bases: XAObject

An enumeration in OmniOutliner.app.

New in version 0.0.9.

Attributes:

`id`	An identifier for the enumeration that is unique within the column.
`index`	The index of the enumeration member in the column.
`name`	The name of the enumeration.

Methods:

move_to(destination)

Moves the enumeration to a new column.

property id: str: An identifier for the enumeration that is unique within the column.

property index: str: The index of the enumeration member in the column.

move_to(destination: XAOmniOutlinerColumn)[source]

Moves the enumeration to a new column.

Parameters:: destination (XAOmniOutlinerColumn) – The column to move the enumeration to

New in version 0.0.9.

property name: str: The name of the enumeration.

class PyXA.apps.OmniOutliner.XAOmniOutlinerEnumerationList(properties: dict, filter: dict | None = None)[source]

Bases: XAList

A wrapper around lists of enumerations that employs fast enumeration techniques.

All properties of enumerations can be called as methods on the wrapped list, returning a list containing each enumeration’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerFileAttachment(properties)[source]

Bases: XAText

A file attachment object in OmniOutliner.app.

New in version 0.0.9.

Attributes:

`embdedded`	If true, the attached file will reside inside the document on the next save.
`file_name`	The path to the file for the attachment, if the attachment resides outside the document.

property embdedded: bool: If true, the attached file will reside inside the document on the next save.

property file_name: str: The path to the file for the attachment, if the attachment resides outside the document.

class PyXA.apps.OmniOutliner.XAOmniOutlinerFileAttachmentList(properties: dict, filter: dict | None = None)[source]

Bases: XATextList

A wrapper around lists of file attachments that employs fast enumeration techniques.

All properties of file attachments can be called as methods on the wrapped list, returning a list containing attachments texts’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerFollowingSibling(properties)[source]

Bases: XAOmniOutlinerRow

The row which follows this row.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerFollowingSiblingList(properties: dict, filter: dict | None = None)[source]

Bases: XAOmniOutlinerRowList

A wrapper around lists of following siblings that employs fast enumeration techniques.

All properties of following siblings can be called as methods on the wrapped list, returning a list containing each siblings’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerGenericColor(properties)[source]

Bases: XAObject

A generic color value.

New in version 0.0.9.

Attributes:

`a`
`archive`	If the color cannot be represented in any other format, a binary archive is placed in this property.
`b`	If the color is in a RGB color space, this is the calibrated floating point blue component, from zero to one.
`c`	If the color is in a CMYK color space, this is the device-specific floating point cyan component, from zero to one.
`catalog`	If the color is in a catalog color space, this is the name of the catalog.
`g`	If the color is in a RGB color space, this is the calibrated floating point green component, from zero to one.
`h`	If the color is in a HSV color space, this is the calibrated floating point hue component, from zero to one.
`k`	If the color is in a CMYK color space, this is the device-specific floating point black component, from zero to one.
`m`	If the color is in a CMYK color space, this is the device-specific floating point magenta component, from zero to one.
`name`	If the color is in a catalog color space, this is the name of color with in the catalog.
`png`	If the color is in a pattern color space, this is PNG data for the image representing the pattern.
`r`	If the color is in a RGB color space, this is the calibrated floating point red component, from zero to one.
`s`	If the color is in a HSV color space, this is the calibrated floating point saturation component, from zero to one.
`tiff`	If the color is in a pattern color space, this is TIFF data for the image representing the pattern.
`v`	If the color is in a HSV color space, this is the calibrated floating point value component, from zero to on.
`w`	If the color is in a White color space, this is the calibrated floating point white component, from zero to one, with zero being totally black and one being totally white.
`y`	If the color is in a CMYK color space, this is the device-specific floating point yellow component, from zero to one.

property a: float

property archive: XAOmniOutlinerArchiveData: If the color cannot be represented in any other format, a binary archive is placed in this property.

property b: float: If the color is in a RGB color space, this is the calibrated floating point blue component, from zero to one.

property c: float: If the color is in a CMYK color space, this is the device-specific floating point cyan component, from zero to one. There is currently no support for calibrated CYMK color spaces.

property catalog: str: If the color is in a catalog color space, this is the name of the catalog.

property g: float: If the color is in a RGB color space, this is the calibrated floating point green component, from zero to one.

property h: float: If the color is in a HSV color space, this is the calibrated floating point hue component, from zero to one.

property k: float: If the color is in a CMYK color space, this is the device-specific floating point black component, from zero to one. There is currently no support for calibrated CYMK color spaces.

property m: float: If the color is in a CMYK color space, this is the device-specific floating point magenta component, from zero to one. There is currently no support for calibrated CYMK color spaces.

property name: str: If the color is in a catalog color space, this is the name of color with in the catalog.

property png: XAOmniOutlinerPNGData: If the color is in a pattern color space, this is PNG data for the image representing the pattern.

property r: float: If the color is in a RGB color space, this is the calibrated floating point red component, from zero to one.

property s: float: If the color is in a HSV color space, this is the calibrated floating point saturation component, from zero to one.

property tiff: XAOmniOutlinerTIFFData: If the color is in a pattern color space, this is TIFF data for the image representing the pattern.

property v: float: If the color is in a HSV color space, this is the calibrated floating point value component, from zero to on.

property w: float: If the color is in a White color space, this is the calibrated floating point white component, from zero to one, with zero being totally black and one being totally white.

property y: float: If the color is in a CMYK color space, this is the device-specific floating point yellow component, from zero to one. There is currently no support for calibrated CYMK color spaces.

class PyXA.apps.OmniOutliner.XAOmniOutlinerLeaf(properties)[source]

Bases: XAOmniOutlinerRow

The leaf rows underneath a document or row. Note that a row is not its own leaf, so if you access this on a single row with no children, that row will not be returned (use the command ‘bottom rows’ for that).

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerLeafList(properties: dict, filter: dict | None = None)[source]

Bases: XAOmniOutlinerRowList

A wrapper around lists of leaf rows that employs fast enumeration techniques.

All properties of leaf rows can be called as methods on the wrapped list, returning a list containing each leaf row’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerLevelStyle(properties)[source]

Bases: XAObject

A level style object in a document.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerLevelStyleList(properties: dict, filter: dict | None = None)[source]

Bases: XAOmniOutlinerStyleList

A wrapper around lists of level styles that employs fast enumeration techniques.

All properties of level styles can be called as methods on the wrapped list, returning a list containing each style’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerNamedStyle(properties)[source]

Bases: XAOmniOutlinerStyle

A named style object.

New in version 0.0.9.

Attributes:

`id`	An identifier for the named style that is unique within its document.
`name`	The name of the style.

property id: str: An identifier for the named style that is unique within its document. Currently this identifier is not persistent between two different sessions of editing the document.

property name: str: The name of the style. Must be unique within the containing document.

class PyXA.apps.OmniOutliner.XAOmniOutlinerNamedStyleList(properties: dict, filter: dict | None = None)[source]

Bases: XAOmniOutlinerStyleList

A wrapper around lists of named styles that employs fast enumeration techniques.

All properties of named styles can be called as methods on the wrapped list, returning a list containing each styles’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerPNGData(properties)[source]

Bases: XAObject

A PNG data object.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerPathComponent(properties)[source]

Bases: XAOmniOutlinerRow

A list of rows up to and including the given row.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerPathComponentList(properties: dict, filter: dict | None = None)[source]

Bases: XAOmniOutlinerRowList

A wrapper around lists of path components that employs fast enumeration techniques.

All properties of path components can be called as methods on the wrapped list, returning a list containing each path component’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerPoint(properties)[source]

Bases: XAObject

A point value.

New in version 0.0.9.

Attributes:

`x`	The x coordinate of the point.
`y`	The x coordinate of the point.

property x: float: The x coordinate of the point.

property y: float: The x coordinate of the point.

class PyXA.apps.OmniOutliner.XAOmniOutlinerPrecedingSibling(properties)[source]

Bases: XAOmniOutlinerRow

The row which precedes this row.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerPrecedingSiblingList(properties: dict, filter: dict | None = None)[source]

Bases: XAOmniOutlinerRowList

A wrapper around lists of preceding siblings that employs fast enumeration techniques.

All properties of preceding siblings can be called as methods on the wrapped list, returning a list containing each siblings’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerPreference(properties)[source]

Bases: XAObject

A row object in OmniOutliner.app.

New in version 0.0.9.

Attributes:

`default_value`	The default value of the preference.
`id`	The identifier of the preference.
`value`	The current value of the preference.

property default_value: str | float | int | bool | None: The default value of the preference.

property id: str: The identifier of the preference.

property value: str | float | int | bool | None: The current value of the preference.

class PyXA.apps.OmniOutliner.XAOmniOutlinerPreferenceList(properties: dict, filter: dict | None = None)[source]

Bases: XAList

A wrapper around lists of preferences that employs fast enumeration techniques.

All properties of preferences can be called as methods on the wrapped list, returning a list containing each preference’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerReadableDocumentType(properties)[source]

Bases: XAOmniOutlinerDocumentType

A readable document type in OmniOutliner.app.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerReadableDocumentTypeList(properties: dict, filter: dict | None = None)[source]

Bases: XAOmniOutlinerDocumentTypeList

A wrapper around lists of readable document types that employs fast enumeration techniques.

All properties of document types can be called as methods on the wrapped list, returning a list containing each types’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerRichText(properties)[source]

Bases: XAText, XADeletable

A row object in OmniOutliner.app.

New in version 0.0.9.

Attributes:

`alignment`	Alignment of the text.
`baseline_offset`	Number of pixels shifted above or below the normal baseline.
`style`	The style of the text.
`superscript`	The superscript level of the text.
`underlined`	Is the first character underlined?

Methods:

`bold`()	Bolds the text.
`file_attachments`([filter])	Returns a list of file attachments, as PyXA objects, matching the given filter.
`italicize`()	Italicizes the text.
`replace`(replacement[, regex_to_find, ...])	Replaces the text.
`unbold`()	Unbolds the text.
`underline`()	Underlines the text.
`unitalicize`()	Unitalicizes the text.
`ununderline`()	Ununderlines the text.

property alignment: Alignment: Alignment of the text.

property baseline_offset: float: Number of pixels shifted above or below the normal baseline.

bold()[source]: Bolds the text.

New in version 0.0.9.

file_attachments(filter: dict | None = None) → XAOmniOutlinerFileAttachmentList[source]: Returns a list of file attachments, as PyXA objects, matching the given filter.

New in version 0.0.9.

italicize()[source]: Italicizes the text.

New in version 0.0.9.

replace(replacement: str, regex_to_find: str | None = None, string_to_find: str | None = None)[source]

Replaces the text.

Parameters:

replacement (str) – The replacement strng
regex_to_find (Union[str, None], optional) – Regular expression to find and replace, defaults to None
string_to_find (Union[str, None], optional) – String to find and replace, defaults to None

New in version 0.0.9.

property style: XAOmniOutlinerStyle: The style of the text.

property superscript: int: The superscript level of the text.

unbold()[source]: Unbolds the text.

New in version 0.0.9.

underline()[source]: Underlines the text.

New in version 0.0.9.

property underlined: bool: Is the first character underlined?

unitalicize()[source]: Unitalicizes the text.

New in version 0.0.9.

ununderline()[source]: Ununderlines the text.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerRichTextList(properties: dict, filter: dict | None = None)[source]

Bases: XATextList

A wrapper around lists of rich texts that employs fast enumeration techniques.

All properties of rich texts can be called as methods on the wrapped list, returning a list containing each texts’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerRow(properties)[source]

Bases: XAObject

A row object in OmniOutliner.app.

New in version 0.0.9.

Methods:

`add`(items)	Adds objects to the row.
`add_to`(destination)	Adds the row to a location.
`ancestors`([filter])	Returns a list of ancestors, as PyXA objects, matching the given filter.
`cells`([filter])	Returns a list of cells, as PyXA objects, matching the given filter.
`children`([filter])	Returns a list of children, as PyXA objects, matching the given filter.
`collapse_all`([items])	Collapses a row or list of rows.
`conduit_setting_domains`([filter])	Returns a list of conduit setting domains, as PyXA objects, matching the given filter.
`expand_all`([items])	Expands a row or list of rows.
`following_siblings`([filter])	Returns a list of following siblings, as PyXA objects, matching the given filter.
`group`([rows])	Increase the outline level of a list of rows by creating a new parent row for them and moving under that new row.
`hoist`([rows])	Hide all rows in the outline, except for the descendants of the row passed to this command.
`import_file`(file)	Imports a file, as rows, to a specified location.
`indent`()	Indents the row.
`leaves`([filter])	Returns a list of leaves, as PyXA objects, matching the given filter.
`outdent`()	Outdents the row.
`paragraphs`([filter])	Returns a list of paragraphs, as PyXA objects, matching the given filter.
`pbcopy`(items[, type, clipboard_name])	Copies one or more nodes to the clipboard.
`pbpaste`(location[, clipboard_name])	Pastes nodes from the clipboard.
`preceding_siblings`([filter])	Returns a list of preceding siblings, as PyXA objects, matching the given filter.
`remove`(items)	Remove objects from the row.
`remove_from`(container)	Removes the row from a location.
`rowpath`([filter])	Returns a row path, or list of path components as PyXA objects, matching the given filter.
`rows`([filter])	Returns a list of rows, as PyXA objects, matching the given filter.
`sections`([filter])	Returns a list of sections, as PyXA objects, matching the given filter.
`selected_rows`([filter])	Returns a list of selected rows, as PyXA objects, matching the given filter.
`ungroup`([rows])	Decrease the outline level of all children of a row, moving them left one step.

Attributes:

`children_are_sections`	Whether the row's children are treated as separate sections.
`document`	The document containing the row.
`expanded`	Whether the row's subtopics are visible.
`has_subtopics`	Whether the row has any subtopics.
`id`	An identifier for the row that is unique within the document.
`index`	The index of the row among its siblings.
`level`	How 'deep' this item is.
`name`	The name of the row (just a plain string version of the topic).
`note`	Contents of the note column.
`note_cell`	The cell for the note column in the row.
`note_expanded`	Whether inline note is currently displayed.
`parent`	The row that contains this row.
`selected`	This is true if the row is selected.
`state`	The state of the check box for this row.
`style`	The style of the row.
`topic`	Contents of the outline column.
`topic_cell`	The cell for the topic column in the row.
`visible`	Whether this row is in the outline view.

add(items: XAObject | list[XAObject])[source]

Adds objects to the row.

Parameters:: items (Union[XABase.XAObject, list[XABase.XAObject]]) – The object(s) to add

New in version 0.0.9.

add_to(destination: XAObject)[source]

Adds the row to a location.

Parameters:: destination (XABase.XAObject) – The container to which to add the row

New in version 0.0.9.

ancestors(filter: dict | None = None) → XAOmniOutlinerAncestorList[source]: Returns a list of ancestors, as PyXA objects, matching the given filter.

New in version 0.0.9.

cells(filter: dict | None = None) → XAOmniOutlinerCellList[source]: Returns a list of cells, as PyXA objects, matching the given filter.

New in version 0.0.9.

children(filter: dict | None = None) → XAOmniOutlinerChildList[source]: Returns a list of children, as PyXA objects, matching the given filter.

New in version 0.0.9.

property children_are_sections: bool: Whether the row’s children are treated as separate sections.

collapse_all(items: XAOmniOutlinerRow | XAOmniOutlinerRowList | list[XAOmniOutlinerRow] | None = None)[source]

Collapses a row or list of rows.

Parameters:: items (Union[XAOmniOutlinerRow, list[XAOmniOutlinerRow], XAOmniOutlinerRowList, None], optional) – The row(s) to collapse, defaults to None

New in version 0.0.9.

conduit_setting_domains(filter: dict | None = None) → XAOmniOutlinerConduitSettingDomainList[source]: Returns a list of conduit setting domains, as PyXA objects, matching the given filter.

New in version 0.0.9.

property document: XAOmniOutlinerDocument: The document containing the row.

expand_all(items: XAOmniOutlinerRow | XAOmniOutlinerRowList | list[XAOmniOutlinerRow] | None = None)[source]

Expands a row or list of rows.

Parameters:: items (Union[XAOmniOutlinerRow, list[XAOmniOutlinerRow], XAOmniOutlinerRowList, None], optional) – The row(s) to expand, defaults to None

New in version 0.0.9.

property expanded: bool: Whether the row’s subtopics are visible.

following_siblings(filter: dict | None = None) → XAOmniOutlinerFollowingSiblingList[source]: Returns a list of following siblings, as PyXA objects, matching the given filter.

New in version 0.0.9.

group(rows: XAOmniOutlinerRow | XAOmniOutlinerRowList | list[XAOmniOutlinerRow] | None = None)[source]

Increase the outline level of a list of rows by creating a new parent row for them and moving under that new row.

Parameters:: rows (Union[XAOmniOutlinerRow, XAOmniOutlinerRowList, list[XAOmniOutlinerRow], None], optional) – The rows to group, defaults to None

New in version 0.0.9.

property has_subtopics: bool: Whether the row has any subtopics.

hoist(rows: XAOmniOutlinerRow | XAOmniOutlinerRowList | list[XAOmniOutlinerRow] | None = None)[source]

Hide all rows in the outline, except for the descendants of the row passed to this command.

Parameters:: rows (Union[XAOmniOutlinerRow, XAOmniOutlinerRowList, list[XAOmniOutlinerRow], None], optional) – The rows to hoist, defaults to None

New in version 0.0.9.

property id: str: An identifier for the row that is unique within the document.

import_file(file: str | XAPath)[source]

Imports a file, as rows, to a specified location. Returns the list of imported rows.

Parameters:: file (Union[str, XABase.XAPath]) – The file to import

New in version 0.0.9.

indent()[source]: Indents the row.

New in version 0.0.9.

property index: int: The index of the row among its siblings.

leaves(filter: dict | None = None) → XAOmniOutlinerLeafList[source]: Returns a list of leaves, as PyXA objects, matching the given filter.

New in version 0.0.9.

property level: int: How ‘deep’ this item is. Top-level rows are level 1, subtopics of those rows are level 2, and so on.

property name: str: The name of the row (just a plain string version of the topic).

property note: XAOmniOutlinerRichText: Contents of the note column.

property note_cell: XAOmniOutlinerCell: The cell for the note column in the row.

property note_expanded: bool: Whether inline note is currently displayed.

outdent()[source]: Outdents the row.

New in version 0.0.9.

paragraphs(filter: dict | None = None) → XAParagraphList[source]: Returns a list of paragraphs, as PyXA objects, matching the given filter.

New in version 0.0.9.

property parent: XAOmniOutlinerRow: The row that contains this row.

pbcopy(items: list[XAObject], type: str | list[str] | None = None, clipboard_name: str | None = None)[source]

Copies one or more nodes to the clipboard.

Parameters:

items (list[XABase.XAObject]) – The list of items to copy to the clipboard
type (Union[str, list[str], None], optional) – The list of type identifier to use when copying the trees. If omitted, all writable clipboard types are used, defaults to None
clipboard_name (Union[str, None], optional) – The name of the clipboard to copy to, defaults to None

New in version 0.0.9.

pbpaste(location: XAObject, clipboard_name: str | None = None)[source]

Pastes nodes from the clipboard.

Parameters:

location (XABase.XAObject) – The location at which to paste the nodes
clipboard_name (Union[str, None], optional) – The name of the clipboard to paste from, defaults to None

New in version 0.0.9.

preceding_siblings(filter: dict | None = None) → XAOmniOutlinerPrecedingSiblingList[source]: Returns a list of preceding siblings, as PyXA objects, matching the given filter.

New in version 0.0.9.

remove(items: XAObject | list[XAObject])[source]

Remove objects from the row.

Parameters:: items (Union[XABase.XAObject, list[XABase.XAObject]]) – The object(s) to remove

New in version 0.0.9.

remove_from(container: XAObject)[source]

Removes the row from a location.

Parameters:: container (XABase.XAObject) – The container from which to remove the row

New in version 0.0.9.

rowpath(filter: dict | None = None) → XAOmniOutlinerPathComponentList[source]: Returns a row path, or list of path components as PyXA objects, matching the given filter.

New in version 0.0.9.

rows(filter: dict | None = None) → XAOmniOutlinerRowList[source]: Returns a list of rows, as PyXA objects, matching the given filter.

New in version 0.0.9.

sections(filter: dict | None = None) → XAOmniOutlinerSectionList[source]: Returns a list of sections, as PyXA objects, matching the given filter.

New in version 0.0.9.

property selected: bool: This is true if the row is selected. Note that attempts to set this while the row is not visible (collapsed parent, hoisted root isn’t an ancestor, etc.) will silently do nothing.

selected_rows(filter: dict | None = None) → XAOmniOutlinerSelectedRowList[source]: Returns a list of selected rows, as PyXA objects, matching the given filter.

New in version 0.0.9.

property state: CheckboxState: The state of the check box for this row.

property style: XAOmniOutlinerStyle: The style of the row.

property topic: XAOmniOutlinerRichText: Contents of the outline column.

property topic_cell: XAOmniOutlinerCell: The cell for the topic column in the row.

ungroup(rows: XAOmniOutlinerRow | XAOmniOutlinerRowList | list[XAOmniOutlinerRow] | None = None)[source]

Decrease the outline level of all children of a row, moving them left one step.

Parameters:: rows (Union[XAOmniOutlinerRow, XAOmniOutlinerRowList, list[XAOmniOutlinerRow], None], optional) – The rows to ungroup, defaults to None

New in version 0.0.9.

property visible: bool: Whether this row is in the outline view. It must be a descendent of the current root item taking hoisting into account, with no collapsed ancestors below the current root. Hoisted rows are visible in the outline and so are considered visible.

class PyXA.apps.OmniOutliner.XAOmniOutlinerRowList(properties: dict, filter: dict | None = None, obj_class=None)[source]

Bases: XAList

A wrapper around lists of rows that employs fast enumeration techniques.

All properties of rows can be called as methods on the wrapped list, returning a list containing each row’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerSection(properties)[source]

Bases: XAOmniOutlinerRow

The sections underneath the document or row. Note that a row is not a section of itself, so if you access this on a single row, an empty list will be returned.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerSectionList(properties: dict, filter: dict | None = None)[source]

Bases: XAOmniOutlinerRowList

A wrapper around lists of sections that employs fast enumeration techniques.

All properties of sections can be called as methods on the wrapped list, returning a list containing each section’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerSelectedColumn(properties)[source]

Bases: XAObject

A style object in OmniOutliner.app.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerSelectedColumnList(properties: dict, filter: dict | None = None)[source]

Bases: XAOmniOutlinerColumnList

A wrapper around lists of selected columns that employs fast enumeration techniques.

All properties of columns can be called as methods on the wrapped list, returning a list containing each column’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerSelectedRow(properties)[source]

Bases: XAOmniOutlinerRow

The sections underneath the document or row. Note that a row is not a section of itself, so if you access this on a single row, an empty list will be returned.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerSelectedRowList(properties: dict, filter: dict | None = None)[source]

Bases: XAOmniOutlinerRowList

A wrapper around lists of selected rows that employs fast enumeration techniques.

All properties of selected rows can be called as methods on the wrapped list, returning a list containing each selected row’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerStyle(properties)[source]

Bases: XAObject

A style object in OmniOutliner.app.

New in version 0.0.9.

Methods:

`attributes`([filter])	Returns a list of attributes, as PyXA objects, matching the given filter.
`named_styles`([filter])	Returns a list of named styles, as PyXA objects, matching the given filter.

Attributes:

`container`	The object owning the style.
`font`	The name of the font of the style.

attributes(filter: dict | None = None) → XAOmniOutlinerAttributeList[source]: Returns a list of attributes, as PyXA objects, matching the given filter.

New in version 0.0.9.

property container: XAObject: The object owning the style.

property font: str: The name of the font of the style.

named_styles(filter: dict | None = None) → XAOmniOutlinerNamedStyleList[source]: Returns a list of named styles, as PyXA objects, matching the given filter.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerStyleList(properties: dict, filter: dict | None = None, obj_class=None)[source]

Bases: XAList

A wrapper around lists of OmniOutliner styles that employs fast enumeration techniques.

All properties of styles can be called as methods on the wrapped list, returning a list containing each style’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerTIFFData(properties)[source]

Bases: XAObject

A TIFF data object.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerWindow(properties)[source]

Bases: XASBWindow

A window of OmniOutliner.app.

New in version 0.0.9.

Attributes:

document

The document whose contents are currently displayed in the window.

property document: XAOmniOutlinerDocument: The document whose contents are currently displayed in the window.

class PyXA.apps.OmniOutliner.XAOmniOutlinerWritableDocumentType(properties)[source]

Bases: XAOmniOutlinerDocumentType

A writable document type in OmniOutliner.app.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerWritableDocumentTypeList(properties: dict, filter: dict | None = None)[source]

Bases: XAOmniOutlinerDocumentTypeList

A wrapper around lists of writable document types that employs fast enumeration techniques.

All properties of document types can be called as methods on the wrapped list, returning a list containing each types’s value for the property.

New in version 0.0.9.

class PyXA.apps.OmniOutliner.XAOmniOutlinerXslTransform(properties)[source]

Bases: XAObject

This class represents an available XSL transformation that may be applied when loading or saving documents.

New in version 0.0.9.

Attributes:

`directory_extension`	The prefered file extension for file-system representations of wrapped file documents handled by this plugin.
`directory_index_file_name`	When writing a document with attachments, this specifies the name of the index file written inside the directory containing the transformed XML.
`display_name`	The human readable name for the transform.
`file_extension`	The preferred file extension for file-system representations of flat file documents handled by this plugin.
`id`	A unique identifier for the transform to be used as the 'as' parameter of the 'save' command.
`is_export`	Returns true if the source format is a native format for OmniOutliner.
`is_import`	Returns true if the result format is a native format for OmniOutliner.
`parameter_names`	Names of all XSL parameters set on this transform.
`result_format`	A description of the data type produced by this transform.
`source_format`	A description of the data type consumed by this transform.
`stylesheet`	The XSL source for the transform.
`write_attachments`	When writing a document with attachments, this specifies whether the attachments will be written to the output location.

Methods:

`get_parameter`(parameter_name)	Gets the XPath expression currently set for a XSL parameter
`set_parameter`(parameter_name, value)	Sets the XPath expression for a parameter.

property directory_extension: str: The prefered file extension for file-system representations of wrapped file documents handled by this plugin.

property directory_index_file_name: str: When writing a document with attachments, this specifies the name of the index file written inside the directory containing the transformed XML.

property display_name: str: The human readable name for the transform.

property file_extension: str: The preferred file extension for file-system representations of flat file documents handled by this plugin.

get_parameter(parameter_name: str) → str[source]

Gets the XPath expression currently set for a XSL parameter

Parameters:: parameter_name (str) – The name of the parameter
Returns:: The XPath expression currently set for the parameter
Return type:: str

New in version 0.0.9.

property id: str: A unique identifier for the transform to be used as the ‘as’ parameter of the ‘save’ command.

property is_export: bool: Returns true if the source format is a native format for OmniOutliner.

property is_import: bool: Returns true if the result format is a native format for OmniOutliner.

property parameter_names: str: Names of all XSL parameters set on this transform.

property result_format: str: A description of the data type produced by this transform. For XML data types, this is the DTD public identifier.

set_parameter(parameter_name: str, value: str)[source]

Sets the XPath expression for a parameter. Note that to set a string constant you must quote the string. For example “foo” means “element foo” but “‘foo’” means “constant string ‘foo’”.

Parameters:

parameter_name (str) – The name of the parameter
value (str) – The value of the parameter

New in version 0.0.9.

property source_format: str: A description of the data type consumed by this transform. For XML data types, this is the DTD public identifier.

property stylesheet: str: The XSL source for the transform.

property write_attachments: bool: When writing a document with attachments, this specifies whether the attachments will be written to the output location.

class PyXA.apps.OmniOutliner.XAOmniOutlinerXslTransformList(properties: dict, filter: dict | None = None)[source]

Bases: XAList

A wrapper around lists of XSL transforms that employs fast enumeration techniques.

All properties of XSL transforms can be called as methods on the wrapped list, returning a list containing each transforms’s value for the property.

New in version 0.0.9.