Skip to content

feat: update layer type documentation #556

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dopenguin wants to merge 1 commit into
base: next
Choose a base branch
from
+4 −3
Open

feat: update layer type documentation #556

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions src/core/types/layer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@ export interface LayerConfigurationOptionLayers {
title?: boolean | Record<string, string>
}

// TODO: It should be allowed to set LayerType to a random string to allow for the grouping of different mask layers
export type LayerType = 'background' | 'mask'
export type LayerType = 'background' | 'mask' | (string & {})

export interface LayerConfigurationOptions {
/**
Expand Down Expand Up @@ -73,7 +72,9 @@ export interface LayerConfiguration {
name: string

/**
* Whether the layer is a background layer or a feature layer with specific information.
* Type of layer. Can be background layer, a feature ('mask') layer with
* specific information, or any custom string for grouping different mask layers.
* Custom strings allow for the categorization of layers into arbitrary groups.
*/
type: LayerType

Expand Down
Loading