findCategory

Find project category of labels

Syntax

category = findCategory(proj,categoryName)

Description

category = findCategory(proj,categoryName) gets the category from the specified project with the specified name. You need to get a category before you can use the addLabel or removeLabel function.

Examples

Get a Category of Project Labels

Open the Times Table App project. Use currentProject to create a project object from the currently loaded project.

matlab.project.example.timesTable
proj = currentProject;

Use findCategory to get a category of labels by name.

category = findCategory(proj,"Classification")

category = 

  Category with properties:

                Name: "Classification"
        SingleValued: 1
            DataType: "none"
    LabelDefinitions: [1×7 matlab.project.LabelDefinition]

Alternatively, you can get categories by index. Get the first category.

proj.Categories(1)

ans = 

  Category with properties:

                Name: "Classification"
        SingleValued: 1
            DataType: "none"
    LabelDefinitions: [1×7 matlab.project.LabelDefinition]

Find out what you can do with the category.

methods(category)

Methods for class matlab.project.Category:

createLabel  findLabel    removeLabel  

Input Arguments

proj — Project

matlab.project.Project object

Project, specified as a matlab.project.Project object. Use currentProject to create a project object from the currently loaded project.

categoryName — Name of category

character vector | string scalar

Name of the category to get, specified as a character vector or string scalar.

Output Arguments

category — Category of labels

Category object

Category of labels, returned as a Category object that you can query or modify. If the specified category is not found, the function returns an empty array.