@yworks/react-yfiles-company-ownership 1.0.0

package/LICENSE

@@ -0,0 +1,24 @@
+This source code can be used as part of a yFiles for HTML application.
+https://www.yworks.com/yfileshtml
+Copyright (c) 2000-2024 by yWorks GmbH, Vor dem Kreuzberg 28,
+72070 Tübingen, Germany. All rights reserved.
+
+Any redistribution of the files in this repository in source code or other form, 
+with or without modification, is not permitted. 
+The creation of derivative works is prohibited, unless otherwise explicitly permitted.
+
+Owners of a valid software license for a yFiles for HTML version
+are allowed to use these sources as basis for their own yFiles for HTML powered applications. 
+Use of such programs is governed by the rights and conditions as set out in the 
+yFiles for HTML license agreement.
+
+THIS SOFTWARE IS PROVIDED ''AS IS'' AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
+NO EVENT SHALL yWorks BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,159 @@
+# yFiles React Company Ownership Component
+
+
+[![yFiles React Company Ownership Component](https://raw.githubusercontent.com/yWorks/react-yfiles-company-ownership/main/assets/react-company-ownership-hero.png)](https://docs.yworks.com/react-yfiles-company-ownership)
+
+Welcome to the *yFiles React Company Ownership* component, a powerful and versatile React component based
+on the [yFiles](https://www.yworks.com/yfiles-overview) library.  This component enables seamless integration
+for displaying company ownership charts in your React applications.
+
+## Getting Started
+
+1. **Installation:**
+   Install the component via npm by running the following command in your project directory:
+   ```bash
+   npm install @yworks/react-yfiles-company-ownership
+      ```
+
+   The company-ownership module has some peer dependencies that must be installed somewhere in your project. Since it is a React module, `react` and `react-dom` dependencies are needed.
+
+   Additionally, the component relies on the [yFiles](https://www.yworks.com/yfiles-overview) library which is not published to the public npm registry. You can learn  how to work with the yFiles npm module in our [Developer's Guide](https://docs.yworks.com/yfileshtml/#/dguide/yfiles_npm_module).
+
+   Ensure that the dependencies in the `package.json` file resemble the following:
+   ```json
+   {
+     ...
+     "dependencies": {
+       "@yworks/react-yfiles-company-ownership": "^1.0.0",
+       "react": "^18.2.0",
+       "react-dom": "^18.2.0",
+       "yfiles": "<yFiles package path>/lib/yfiles-26.0.0.tgz",
+       ...
+     }
+   }
+   ```
+
+2. **License:**
+   Before using the component, a valid [yFiles for HTML](https://www.yworks.com/products/yfiles-for-html) version is required. You can evaluate yFiles for 60 days free of charge on [my.yworks.com](https://my.yworks.com/signup?product=YFILES_HTML_EVAL).
+   Be sure to invoke the <TypeLink type="registerLicense" /> function to furnish the license file before utilizing the company-ownership component.
+
+3. **Usage:**
+   Utilize the component in your application. Make sure to import the CSS stylesheet.
+
+   ```tsx
+   import {
+     CompanyOwnership,
+     CompanyOwnershipData,
+     Entity,
+     Ownership,
+     registerLicense
+   } from '@yworks/react-yfiles-company-ownership'
+   
+   import '@yworks/react-yfiles-company-ownership/dist/index.css'
+   
+   import yFilesLicense from './license.json'
+ 
+   function App() {
+     registerLicense(yFilesLicense)
+ 
+     const data: CompanyOwnershipData<Entity, Ownership> = {
+       companies: [
+         {
+           id: 1,
+           name: 'Monster Inc',
+           type: 'Corporation'
+         },
+         {
+           id: 2,
+           name: 'Connect Partner',
+           type: 'RCTB'
+         },
+         {
+           id: 3,
+           name: 'Large Scale Trust',
+           type: 'Trust'
+         }
+       ],
+       connections: [
+         {
+           type: 'Ownership',
+           ownership: 0.4,
+           sourceId: 1,
+           targetId: 2
+         },
+         {
+           type: 'Ownership',
+           ownership: 0.2,
+           sourceId: 1,
+           targetId: 3
+         }
+       ]
+     }
+ 
+     return  <CompanyOwnership data={data}></CompanyOwnership>
+   }
+ 
+   export default App
+   ```
+
+   > **Note:** By default, the `CompanyOwnership` component adjusts its size to match the size of its parent element. Therefore, it is necessary to set the dimensions of the containing element or apply styling directly to the `CompanyOwnership` component. This can be achieved by defining a CSS class or applying inline styles.
+
+## Documentation
+
+Find the full documentation, API and many code examples in our [documentation](https://docs.yworks.com/react-yfiles-company-ownership).
+
+## Live Playground
+
+[![Live Playground](https://raw.githubusercontent.com/yWorks/react-yfiles-company-ownership/main/assets/playground.png)](https://docs.yworks.com/react-yfiles-company-ownership/introduction/welcome)
+
+Try the yFiles React Company Ownership component directly in your browser with our [playground](https://docs.yworks.com/react-yfiles-company-ownership/introduction/welcome)
+
+## Features
+
+The component provides versatile features out of the box that can be further tailored to specific use cases.
+
+<table>
+    <tr>
+        <td>
+            <a href="https://docs.yworks.com/react-yfiles-company-ownership/introduction/welcome"><img src="https://raw.githubusercontent.com/yWorks/react-yfiles-company-ownership/main/assets/default-shapes.png" title="Default Shapes" alt="Default Shapes"></a><br>
+            <a href="https://docs.yworks.com/react-yfiles-company-ownership/introduction/welcome">Default Shapes</a>
+        </td>
+        <td>
+            <a href="https://docs.yworks.com/react-yfiles-company-ownership/features/custom-items"><img src="https://raw.githubusercontent.com/yWorks/react-yfiles-company-ownership/main/assets/custom-visualization.png" title="Custom visualization" alt="Custom visualization"></a><br>
+            <a href="https://docs.yworks.com/react-yfiles-company-ownership/features/custom-items">Custom visualization</a>
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href="https://docs.yworks.com/react-yfiles-company-ownership/introduction/welcome"><img src="https://raw.githubusercontent.com/yWorks/react-yfiles-company-ownership/main/assets/level-of-detail.png" title="Level of detail visualization" alt="Level of detail visualization"></a><br>
+            <a href="https://docs.yworks.com/react-yfiles-company-ownership/introduction/welcome">Level of detail visualization</a>
+        </td>
+        <td>
+            <a href="https://docs.yworks.com/react-yfiles-company-ownership/features/search"><img src="https://raw.githubusercontent.com/yWorks/react-yfiles-company-ownership/main/assets/search.png" title="Search" alt="Search"></a><br>
+            <a href="https://docs.yworks.com/react-yfiles-company-ownership/features/search">Search</a>
+        </td>
+    </tr>
+</table>
+
+Find all features in the [documentation](https://docs.yworks.com/react-yfiles-company-ownership) and try them directly in the
+browser with our integrated code playground.
+
+## Licensing
+
+All owners of a valid software license for [yFiles for HTML](https://www.yworks.com/products/yfiles-for-html)
+are allowed to use these sources as the basis for their own [yFiles for HTML](https://www.yworks.com/products/yfiles-for-html)
+powered applications.
+
+Use of such programs is governed by the rights and conditions as set out in the
+[yFiles for HTML license agreement](https://www.yworks.com/products/yfiles-for-html/sla).
+
+You can evaluate yFiles for 60 days free of charge on [my.yworks.com](https://my.yworks.com/signup?product=YFILES_HTML_EVAL).
+
+For more information, see the `LICENSE` file. 
+
+## Learn More
+
+Explore the possibilities of visualizing large ownership hierarchies with the yFiles Company Ownership Component.
+For further information about [yFiles for HTML](https://www.yworks.com/yfiles-overview) and our company, please visit [yWorks.com](https://www.yworks.com).
+
+For support or feedback, please reach out to [our support team](https://www.yworks.com/contact) or open an [issue on GitHub](https://github.com/yWorks/react-yfiles-company-ownership/issues). Happy diagramming!

package/dist/WebWorkerSupport-Dd8hdLID.d.ts

@@ -0,0 +1,505 @@
+import { GraphComponent, ILayoutAlgorithm } from 'yfiles';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { CSSProperties, ComponentType, PropsWithChildren } from 'react';
+import { EdgeStyle, RenderNodeProps, RenderTooltipProps, ContextMenuItemProvider, RenderContextMenuProps, ExportSettings, PrintSettings } from '@yworks/react-yfiles-core';
+
+/**
+ * The item's unique id.
+ */
+type EntityId = string | number;
+/**
+ * The basic actor in a company ownership chart. This could be (among others) a company, a bank, or
+ * an individual. See the {@link EntityType} for the available types.
+ */
+interface Entity {
+    /**
+     * The item's unique id.
+     */
+    id: EntityId;
+    /**
+     * The entity's optional type.
+     * The type determines the color and shape of an entity in the default visualization.
+     */
+    type?: EntityType;
+    /**
+     * The optional render width of this item. If the width is not specified, it is determined by measuring the
+     * item visualization unless a default size is defined by {@link CompanyOwnershipProps.nodeSize}.
+     */
+    width?: number;
+    /**
+     * The optional render height of this item. If the height is not specified, it is determined by measuring the
+     * item visualization unless a default size is defined by {@link CompanyOwnershipProps.nodeSize}.
+     */
+    height?: number;
+    /**
+     * An optional name of the entity. The default visualization renders the name as a label on the entity.
+     */
+    name?: string;
+    /**
+     * The optional CSS class name that can be accessed in a custom component that renders the item.
+     */
+    className?: string;
+    /**
+     * The optional CSS style that can be accessed in a custom component that renders the item.
+     */
+    style?: CSSProperties;
+}
+/**
+ * The basic data type for the connections between entities visualized by the {@link CompanyOwnership} component.
+ */
+interface Connection {
+    /**
+     * The id of the connection source entity
+     */
+    sourceId: EntityId;
+    /**
+     * The id of the connection target entity
+     */
+    targetId: EntityId;
+    /**
+     * The optional type of the connection.
+     * The type determines the default visualization of the connection.
+     */
+    type?: ConnectionType;
+}
+/**
+ * A connection representing an ownership relation.
+ */
+interface Ownership extends Connection {
+    type: 'Ownership';
+    ownership?: number;
+}
+/**
+ * The various types an entity can have.
+ * Every type is mapped to a default node visualization.
+ */
+type EntityType = 'Asset' | 'Bank' | 'Branch' | 'CTB' | 'Corporation' | 'Disregarded' | 'Dual Resident' | 'Individual' | 'Multiple' | 'Octagon' | 'PE_Risk' | 'Partnership' | 'RCTB' | 'Third Party' | 'Trapezoid' | 'Trust' | 'Unknown';
+/**
+ * A connection can either be a simple "Relation" or an "Ownership" connection, which additionally
+ * has a numerical ownership property.
+ */
+type ConnectionType = 'Ownership' | 'Relation';
+/**
+ * A data type that combines custom data props with the {@link Entity}. Data needs to fit in
+ * this type so the component can handle the structure of the company ownership chart correctly.
+ */
+type UserEntity<TCustomProps = Record<string, unknown>> = TCustomProps & Entity;
+/**
+ * A data type that combines custom data props with the {@link Connection}. Data needs to fit in
+ * this type so the component can handle the structure of the company ownership chart correctly.
+ */
+type UserConnection<TCustomProps = Record<string, unknown>> = TCustomProps & Connection;
+/**
+ * A function type that provides connection styles for company ownership links.
+ *
+ * The connection property is the {@link Connection}, the source and target properties
+ * represent the start and end {@link Entity} of the connection, respectively.
+ */
+type ConnectionStyleProvider<TEntity extends Entity = Entity, TConnection extends Connection = Connection> = (data: {
+    source: TEntity;
+    target: TEntity;
+    connection: TConnection;
+}) => EdgeStyle | undefined;
+/**
+ * A callback type invoked when an item has been focused.
+ */
+type ItemFocusedListener<TEntity extends Entity | Connection> = (item: TEntity | null) => void;
+/**
+ * A callback type invoked when an item has been selected or deselected.
+ */
+type ItemSelectedListener<TEntity extends Entity | Connection> = (selectedItems: TEntity[]) => void;
+/**
+ * A callback type invoked when the hovered item has changed.
+ */
+type ItemHoveredListener<TEntity extends Entity | Connection> = (item: TEntity | null, oldItem?: TEntity | null) => void;
+/**
+ * A function that returns whether the given item matches the search needle.
+ */
+type SearchFunction<TEntity extends Entity | Connection, TNeedle = string> = (item: TEntity, needle: TNeedle) => boolean;
+/**
+ * A simple label description.
+ */
+type SimpleLabel = {
+    /**
+     * The CSS class name to be used for the label.
+     */
+    className?: string;
+    /**
+     * The text to be displayed on the label.
+     */
+    text: string;
+    /**
+     * The basic shape of the label. The default is 'round-rectangle'.
+     */
+    labelShape?: 'hexagon' | 'pill' | 'rectangle' | 'round-rectangle';
+};
+/**
+ * A function that provides text to display as a label on a connection.
+ */
+type ConnectionLabelProvider<TConnection extends Connection> = (item: TConnection, companyOwnershipModel: CompanyOwnershipModel) => SimpleLabel | undefined;
+/**
+ * A function that provides text to display as a label on an entity.
+ */
+type EntityLabelProvider<TEntity extends Entity> = (item: TEntity, companyOwnershipModel: CompanyOwnershipModel) => SimpleLabel | undefined;
+/**
+ * The company ownership data consisting of {@link Entity}s and {@link Connection}s.
+ */
+type CompanyOwnershipData<TEntity extends Entity = Entity, TConnection extends Connection = Connection> = {
+    companies: TEntity[];
+    connections: TConnection[];
+};
+/**
+ * Configures the direction of the flow for the layout.
+ */
+type LayoutDirection = 'left-to-right' | 'right-to-left' | 'top-to-bottom' | 'bottom-to-top';
+/**
+ * Style describing the visual representation of an edge in the graph.
+ * See {@link https://docs.yworks.com/yfileshtml/#/api/HierarchicLayoutEdgeRoutingStyle}
+ */
+type EdgeRoutingStyle = 'orthogonal' | 'curved' | 'octilinear' | 'polyline';
+/**
+ * Configuration options for the Company Ownership diagram layout.
+ */
+interface LayoutOptions {
+    /**
+     * The direction for the flow in the graph.
+     */
+    direction?: LayoutDirection;
+    /**
+     * The style edges are routed in.
+     */
+    routingStyle?: EdgeRoutingStyle;
+    /**
+     * The minimum distance between the layers in the hierarchy.
+     */
+    minimumLayerDistance?: number;
+    /**
+     * The minimum length for the first segment of an edge.
+     */
+    minimumFirstSegmentLength?: number;
+    /**
+     * The minimum length for the last segment of an edge.
+     */
+    minimumLastSegmentLength?: number;
+    /**
+     * Limits the time the layout algorithm can use to the provided number of milliseconds.
+     * This is an expert option. The main application is for graphs with many edges, where usually
+     * the part of the layout calculations that takes the longest time is the edge routing.
+     */
+    maximumDuration?: number;
+}
+/**
+ * The props for the {@link CompanyOwnership} component.
+ */
+interface CompanyOwnershipProps<TEntity extends Entity, TConnection extends Connection, TNeedle> {
+    /**
+     * The data items visualized by the company ownership.
+     */
+    data: CompanyOwnershipData<TEntity, TConnection>;
+    /**
+     * An optional callback that's called when an item is focused.
+     *
+     * Note that the focused item is not changed if the empty canvas is clicked.
+     */
+    onItemFocus?: ItemFocusedListener<TEntity | TConnection>;
+    /**
+     * An optional callback that's called when an item is selected or deselected.
+     */
+    onItemSelect?: ItemSelectedListener<TEntity | TConnection>;
+    /**
+     * An optional callback that's called when the hovered item has changed.
+     */
+    onItemHover?: ItemHoveredListener<TEntity | TConnection>;
+    /**
+     * A string or a complex object to search for.
+     *
+     * The default search implementation can only handle strings and searches on the properties of the
+     * data item. For more complex search logic, provide an {@link CompanyOwnership.onSearch} callback.
+     */
+    searchNeedle?: TNeedle;
+    /**
+     * An optional callback that returns whether the given item matches the search needle.
+     *
+     * The default search implementation only supports string needles and searches all properties of the data item.
+     * Provide this callback to implement custom search logic.
+     */
+    onSearch?: SearchFunction<TEntity | TConnection, TNeedle>;
+    /**
+     * A custom render component used for rendering the given data item.
+     */
+    renderEntity?: ComponentType<RenderNodeProps<TEntity>>;
+    /**
+     * A function that provides a style configuration for the given connection.
+     */
+    connectionStyleProvider?: ConnectionStyleProvider<TEntity, TConnection>;
+    /**
+     * Specifies the CSS class used for the {@link CompanyOwnership} component.
+     */
+    className?: string;
+    /**
+     * Specifies the CSS style used for the {@link CompanyOwnership} component.
+     */
+    style?: CSSProperties;
+    /**
+     * Specifies the default item size used when no explicit width and height are provided.
+     */
+    itemSize?: {
+        width: number;
+        height: number;
+    };
+    /**
+     * An optional component that can be used for rendering a custom tooltip.
+     */
+    renderTooltip?: ComponentType<RenderTooltipProps<TEntity | TConnection>>;
+    /**
+     * An optional function specifying the context menu items for a data item.
+     */
+    contextMenuItems?: ContextMenuItemProvider<TEntity | TConnection>;
+    /**
+     * An optional component that renders a custom context menu.
+     */
+    renderContextMenu?: ComponentType<RenderContextMenuProps<TEntity>>;
+    /**
+     * Options for configuring the layout style and behavior.
+     */
+    layoutOptions?: LayoutOptions;
+    /**
+     * State setter used to indicate whether the layout is running.
+     */
+    setLayoutRunning?: React.Dispatch<React.SetStateAction<boolean>>;
+    /**
+     * Provides a label description for connections.
+     */
+    connectionLabelProvider?: ConnectionLabelProvider<TConnection>;
+    /**
+     * Provides a label description for entities.
+     * The label is not added if renderEntity is set.
+     */
+    entityLabelProvider?: EntityLabelProvider<TEntity>;
+    /**
+     * Optional Web Worker to run the layout calculation.
+     * This requires the initialization of a Web Worker, see {@link initializeWebWorker}.
+     */
+    layoutWorker?: Worker;
+    /**
+     * Sets the styling options for the different highlight indicators.
+     */
+    highlightOptions?: HighlightOptions;
+}
+/**
+ * Configuration options for styling the hover, selection and neighborhood highlight
+ */
+type HighlightOptions = {
+    /**
+     * The stroke color of the neighborhood highlight
+     */
+    neighborhoodHighlightColor?: string;
+    /**
+     * A CSS class that can be used to style the neighborhood highlight
+     */
+    neighborhoodHighlightCssClass?: string;
+    /**
+     * The stroke color of the hover highlight
+     */
+    hoverHighlightColor?: string;
+    /**
+     * A CSS class that can be used to style the hover highlight
+     */
+    hoverHighlightCssClass?: string;
+    /**
+     * The stroke color of the selection highlight
+     */
+    selectionHighlightColor?: string;
+    /**
+     * A CSS class that can be used to style the selection highlight
+     */
+    selectionHighlightCssClass?: string;
+};
+/**
+ * The CompanyOwnership component visualizes the given data as a company ownership chart.
+ * All data items have to be included in the [data]{@link CompanyOwnershipProps.data}.
+ *
+ * ```tsx
+ * function CompanyOwnershipChart() {
+ *   return (
+ *     <CompanyOwnership data={data}> </CompanyOwnership>
+ *   )
+ * }
+ * ```
+ */
+declare function CompanyOwnership<TEntity extends Entity = UserEntity, TConnection extends Connection = UserConnection, TNeedle = string>(props: CompanyOwnershipProps<TEntity, TConnection, TNeedle> & PropsWithChildren): react_jsx_runtime.JSX.Element;
+
+/**
+ * The CompanyOwnershipModel provides common functionality to interact with the {@link CompanyOwnership} component.
+ */
+interface CompanyOwnershipModel {
+    /**
+     * The [yFiles GraphComponent]{@link http://docs.yworks.com/yfileshtml/#/api/GraphComponent} used
+     * by the {@link CompanyOwnership} component to display the graph.
+     *
+     * This property is intended for advanced users who have a familiarity with the
+     * [yFiles for HTML]{@link https://www.yworks.com/products/yfiles-for-html} library.
+     */
+    graphComponent: GraphComponent;
+    /**
+     * Whether the item is a connection.
+     */
+    isConnection(item: any): item is Connection;
+    /**
+     * Highlights an item and all other items connected to it.
+     * Two items are connected when there exists an edge path
+     * between them, even if there are several hops (items)
+     * on the path.
+     */
+    highlightConnectedItems(item: Entity): void;
+    /**
+     * Whether there is currently a connected items
+     * highlight visualized in the graph that can be cleared.
+     */
+    canClearConnectedItemsHighlight(): boolean;
+    /**
+     * Clears the connected items highlight visualization.
+     */
+    clearConnectedItemsHighlight(): void;
+    /**
+     * Shows all items in the company ownership.
+     */
+    showAll(): void;
+    /**
+     * Whether there are any hidden items to show.
+     */
+    canShowAll(): boolean;
+    /**
+     * Refreshes the company ownership layout.
+     * If the incremental parameter is set to true, the layout considers certain
+     * items as fixed and arranges only the items contained in the incrementalItems array.
+     */
+    applyLayout(incremental?: boolean, incrementalItems?: Entity[], fixedItem?: Entity, fitViewport?: boolean): Promise<void>;
+    /**
+     * Pans the viewport to the center of the given items.
+     */
+    zoomTo(items: (Entity | Connection)[]): void;
+    /**
+     * Increases the zoom level.
+     */
+    zoomIn(): void;
+    /**
+     * Decreases the zoom level.
+     */
+    zoomOut(): void;
+    /**
+     * Fits the chart inside the viewport.
+     */
+    fitContent(insets?: number): void;
+    /**
+     * Resets the zoom level to 1.
+     */
+    zoomToOriginal(): void;
+    /**
+     * Retrieves the items that match the search currently.
+     */
+    getSearchHits: () => Entity[];
+    /**
+     * Exports the company ownership chart to an SVG file.
+     * @throws Exception if the diagram cannot be exported.
+     * The exception may occur when the diagram contains images from cross-origin sources.
+     * In this case, disable {@link ExportSettings.inlineImages} and encode the icons manually to base64.
+     */
+    exportToSvg(exportSettings?: ExportSettings): Promise<void>;
+    /**
+     * Exports the company ownership chart to a PNG Image.
+     * @throws Exception if the diagram cannot be exported.
+     * The exception may occur when the diagram contains images from cross-origin sources.
+     * In this case, disable {@link ExportSettings.inlineImages} and encode the icons manually to base64.
+     */
+    exportToPng(exportSettings?: ExportSettings): Promise<void>;
+    /**
+     * Exports and prints the company ownership chart.
+     */
+    print(printSettings?: PrintSettings): Promise<void>;
+    /**
+     * Triggers a re-rendering of the chart.
+     * This may become useful if properties in the data change and the
+     * visualization should update accordingly.
+     */
+    refresh(): void;
+    /**
+     * Filters the graph for all items that are connected to
+     * the given item.
+     * Connections can be over multiple hops.
+     */
+    showGenealogy(item: Entity): void;
+    /**
+     * Adds a listener called whenever companies are shown or hidden.
+     */
+    addGraphUpdatedListener(listener: () => void): void;
+    /**
+     * Removes a listener added in {@link CompanyOwnershipModel.addGraphUpdatedListener}.
+     */
+    removeGraphUpdatedListener(listener: () => void): void;
+    /**
+     * Returns the currently visible items of the company ownership chart.
+     */
+    getVisibleItems(): Entity[];
+    /**
+     * Shows the predecessors of the given item.
+     */
+    showPredecessors(item: Entity): Promise<void>;
+    /**
+     * Whether the predecessors of the given item is hidden.
+     */
+    canShowPredecessors(item: Entity): boolean;
+    /**
+     * Hides the predecessors of the given item.
+     */
+    hidePredecessors(item: Entity): Promise<void>;
+    /**
+     * Whether the predecessors of the given item is visible.
+     */
+    canHidePredecessors(item: Entity): boolean;
+    /**
+     * Shows the successors of the given item.
+     */
+    showSuccessors(item: Entity): Promise<void>;
+    /**
+     * Whether the successors of the given item are hidden.
+     */
+    canShowSuccessors(item: Entity): boolean;
+    /**
+     * Hides the successors of the given item.
+     */
+    hideSuccessors(item: Entity): Promise<void>;
+    /**
+     * Whether the successors of the given item are visible.
+     */
+    canHideSuccessors(item: Entity): boolean;
+}
+
+declare function createLayout(incremental: boolean, layoutOptions: LayoutOptions): ILayoutAlgorithm;
+/**
+ * Initializes the Web Worker for the layout calculation.
+ *
+ * Web Workers must be provided by the application using the company ownership component,
+ * if worker layout is required. The Worker itself is very bare-bones and the Worker
+ * layout feature can be used as follows:
+ *
+ * ```ts
+ * // in LayoutWorker.ts
+ * import { initializeWebWorker } from '@yworks/react-yfiles-company-ownership/WebWorkerSupport'
+ * initializeWebWorker(self)
+ * ```
+ *
+ * ```tsx
+ * // in index.tsx
+ * const layoutWorker = new Worker(new URL('./LayoutWorker', import.meta.url), {
+ *   type: 'module'
+ * })
+ *
+ * // ...
+ *
+ * return <CompanyOwnership data={data} layoutWorker={layoutWorker}></CompanyOwnership>
+ * ```
+ */
+declare function initializeWebWorker(self: Window): void;
+
+export { type CompanyOwnershipModel as C, type Entity as E, type HighlightOptions as H, type ItemFocusedListener as I, type LayoutDirection as L, type Ownership as O, type SearchFunction as S, type UserEntity as U, type Connection as a, type EntityId as b, type EntityType as c, type ConnectionType as d, type UserConnection as e, type ConnectionStyleProvider as f, type ItemSelectedListener as g, type ItemHoveredListener as h, initializeWebWorker as i, type SimpleLabel as j, type ConnectionLabelProvider as k, type EntityLabelProvider as l, type CompanyOwnershipData as m, type EdgeRoutingStyle as n, type LayoutOptions as o, type CompanyOwnershipProps as p, CompanyOwnership as q, createLayout as r };