.. index:: 
  !PointList Class

.. _id3_document_point_list_class:

===============================================================================
PointList Class
===============================================================================

Namespace: :ref:`id3.Document<reference_document>`

.. toctree::
  :hidden:

  add<add>
  clear<clear>
  clone<clone>
  count<count>
  get<get>
  getCount<get_count>
  removeAt<remove_at>
  resize<resize>
  set<set>


Definition
----------
.. line-block::
    Represents a point list.

.. tab-set::

    .. tab-item:: Python
      :sync: Python

      .. code:: Python

        class PointList

    .. tab-item:: Dart
      :sync: Dart

      .. code:: Dart

        class PointList implements Finalizable

    .. tab-item:: C#
      :sync: C#

      .. code:: C#

        public partial class PointList

    .. tab-item:: Java
      :sync: Java

      .. code:: Java

        public class PointList implements AutoCloseable, Serializable

    .. tab-item:: Swift
      :sync: Swift

      .. code:: Swift

        public class PointList

    .. tab-item:: C
      :sync: C

      .. code:: C

        typedef struct id3DocumentPointList *ID3_DOCUMENT_POINT_LIST;



Usage
-----

.. tab-set::

    .. tab-item:: Python
      :sync: Python

      .. code:: Python

        pointListInstance = PointList()
        # ...

      **Explicit destruction**

      .. code:: Python

        # ...
        del pointListInstance

    .. tab-item:: Dart
      :sync: Dart

      .. code:: Dart

        final pointListInstance = sdk.PointList();
        // ...

      **Explicit destruction**

      .. code:: Dart

        // ...
        pointListInstance.dispose()

    .. tab-item:: C#
      :sync: C#

      .. code:: C#

        using (var pointListInstance = new PointList())
        {
           // ...
        }

      **Explicit destruction**

      .. code:: C#

        var pointListInstance = new PointList()
        // ...
        pointListInstance.Dispose()

    .. tab-item:: Java
      :sync: Java

      .. code:: Java

        try (PointList pointListInstance = new PointList()) {
        // ...
        }

      **Explicit destruction**

      .. code:: Java

        PointList pointListInstance = new PointList();
        // ...
        pointListInstance.close();

    .. tab-item:: Swift
      :sync: Swift

      .. code:: Swift

        private var pointListInstance: PointList? = nil
        pointListInstance = try PointList()

    .. tab-item:: C
      :sync: C

      .. code:: C

        ID3_DOCUMENT_POINT_LIST hPointList{};
        int err = id3DocumentPointList_Initialize(&hPointList);
        if (err == ID3_SUCCESS) {
            // ...
            id3DocumentPointList_Dispose(&hPointList);
        }


Properties
----------

.. list-table:: 
  :width: 100%
  :widths: 30 5 65
  :header-rows: 1

  * - Name
    - Type
    - Description
  * - :ref:`count<id3_document_point_list_count_class_member>`
    - int
    - Gets the number of elements contained in the list
  * - operator [int index]
    - :ref:`Point<id3_document_point_struct>`
    - Gets or sets the element at the specified index in the list.

Iteration
---------

This class supports iteration in Dart, C#, Java and Python.


Methods
-------

.. list-table:: 
  :width: 100%
  :widths: 30 70
  :header-rows: 1

  * - Name
    - Description
  * - :ref:`add<id3_document_point_list_add_class_method>`
    - Adds an item to the PointList object.
  * - :ref:`clear<id3_document_point_list_clear_class_method>`
    - Clears the PointList object.
  * - :ref:`clone<id3_document_point_list_clone_class_method>`
    - Clones the PointList object.
  * - :ref:`get<id3_document_point_list_get_class_method>`
    - Gets an item of the PointList object.
  * - :ref:`getCount<id3_document_point_list_get_count_class_method>`
    - Gets the number of elements in the PointList object.
  * - :ref:`removeAt<id3_document_point_list_remove_at_class_method>`
    - Removes an element of the PointList object.
  * - :ref:`resize<id3_document_point_list_resize_class_method>`
    - PointList object.
  * - :ref:`set<id3_document_point_list_set_class_method>`
    - Sets an item of the PointList object.
