removeLabel

Remove label from project

Syntax

removeLabel(proj,projectFiles,categoryName,labelName)

removeLabel(proj,projectFiles,labelName)

removeLabel(proj,projectFiles,labelDefinitions)

removeLabel(category,labels)

removeLabel(fileObject,categoryName,labelName)

removeLabel(fileObject,labelDefinitions)

Description

removeLabel(proj,projectFiles,categoryName,labelName) detaches the specified label in the specified category from the files projectFiles.

removeLabel(proj,projectFiles,labelName) detaches the specified label from the files projectFiles. Use this syntax only if the label name is unique in the project.

removeLabel(proj,projectFiles,labelDefinitions) detaches the label specified by the label definition objects labelDefinitions from the files projectFiles. Before you can remove the label, you need to get the label definition object from the category.LabelDefinitions property or by using findLabel.

removeLabel(category,labels) removes the specified labels from the specified category of labels in the currently loaded project. Use this syntax to remove a label from a category by name.

removeLabel(fileObject,categoryName,labelName) detaches the specified label in the specified category from the specified file. Use this syntax to remove a label from a file by name.

removeLabel(fileObject,labelDefinitions) detaches the label specified by the label definition objects labelDefinitions from the file specified by fileObject. Before you can remove the label, you need to get the label definition object from the category.LabelDefinitions property or by using findLabel.

Examples

Detach a Label from a Project File

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

openExample("matlab/TimesTableProjectExample")
proj = currentProject;

Query the existing labels for a file.

filename = fullfile("source","timesTableGame.m");
myfile = findFiles(proj,filename,OutputFormat="ProjectFile");
existingLabel =  myfile.Labels

existingLabel = 

  Label with properties:

            File: "C:\myProjects\examples\TimesTableApp\source\timesTableGame.m"
        DataType: 'none'
            Data: []
            Name: "Design"
    CategoryName: "Classification"

Detach the label from the file. The file now has no labels.

removeLabel(proj,myfile,existingLabel)
myfile

myfile = 

  ProjectFile with properties:

                   Path: "C:\myProjects\examples\TimesTableApp\source\timesTableGame.m"
                 Labels: [1×0 matlab.project.Label]
               Revision: "286043ae7ee557100902fb645a6c97eca5d50472"
    SourceControlStatus: Unmodified

Delete Label from Project

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

openExample("matlab/TimesTableProjectExample")
proj = currentProject;

Examine the first category.

cat = proj.Categories(1)

cat = 

  Category with properties:

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

Define a new label in the category.

createLabel(cat,"Future");

Delete the new label from the project.

removeLabel(cat,"Future");

Input Arguments

proj — Project

matlab.project.Project object

Project, specified as a matlab.project.Project object.

category — Category of labels

Category object

Category of labels, specified as a Category object. Get a Category object from the proj.Categories property or by using findCategory.

labelName — Name of label

character vector | string scalar | LabelDefinition object

Name of the label to remove, specified as a character vector, a string scalar, or a LabelDefinition object returned by the category.LabelDefinitions property or the findLabel function.

labels — Names of labels

string array | cell array of character vectors | array of LabelDefinition objects

Name of the label to delete, specified as a string array ,a cell array of character vectors, or an array of ProjectFile objects.

projectFiles — Project files to label

string array | cell array of character vectors | array of ProjectFile objects

Project files to label, specified as a cell array of character vectors, a string array, or an array of ProjectFile objects.

fileObject — Objects of project file to remove label from

array of ProjectFile objects

Object of the file to remove the label from, specified as an array of ProjectFile objects. You can get the ProjectFile object by examining the project Files property (proj.Files) or by using findFiles to find a file by name.

categoryName — Name of category that contains label

character vector | string scalar | Category object

Name of the category that contains the label to remove, specified as a character vector, string scalar, or Category object.

labelDefinitions — Labels to remove

array of LabelDefinition objects

Name of the label to remove, specified as an array of LabelDefinition objects returned by the category.LabelDefinitions property or findLabel.

Version History

Introduced in R2019a

R2024b: Detach label from a file set

Starting in R2024b, you can use the removeLabel(proj,filename,categoryName,labelName) syntax to remove a label from multiple files simultaneously.