Skip to content

Drop deprecated attributes from carpet axis title in v3? #7188

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.

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

Closed
archmoj opened this issue Oct 2, 2024 · 1 comment
Closed

Drop deprecated attributes from carpet axis title in v3? #7188

archmoj opened this issue Oct 2, 2024 · 1 comment
Assignees

Comments

@archmoj
Copy link
Contributor

archmoj commented Oct 2, 2024

_deprecated: {
title: {
valType: 'string',
editType: 'calc',
description: [
'Deprecated in favor of `title.text`.',
'Note that value of `title` is no longer a simple',
'*string* but a set of sub-attributes.'
].join(' ')
},
titlefont: fontAttrs({
editType: 'calc',
description: 'Deprecated in favor of `title.font`.'
}),
titleoffset: {
valType: 'number',
dflt: 10,
editType: 'calc',
description: 'Deprecated in favor of `title.offset`.'
}
},

Instead one should use another title attribues:

title: {
text: {
valType: 'string',
dflt: '',
editType: 'calc',
description: [
'Sets the title of this axis.',
'Note that before the existence of `title.text`, the title\'s',
'contents used to be defined as the `title` attribute itself.',
'This behavior has been deprecated.'
].join(' ')
},
font: fontAttrs({
editType: 'calc',
description: [
'Sets this axis\' title font.',
'Note that the title\'s font used to be set',
'by the now deprecated `titlefont` attribute.'
].join(' ')
}),
// TODO how is this different than `title.standoff`
offset: {
valType: 'number',
dflt: 10,
editType: 'calc',
description: [
'An additional amount by which to offset the title from the tick',
'labels, given in pixels.',
'Note that this used to be set',
'by the now deprecated `titleoffset` attribute.'
].join(' '),
},
editType: 'calc',
},

@archmoj archmoj added this to the v3.0.0 milestone Oct 2, 2024
@archmoj
Copy link
Contributor Author

archmoj commented Oct 2, 2024

Duplicate of #7177.
Closing.

@archmoj archmoj closed this as completed Oct 2, 2024
@archmoj archmoj removed this from the v3.0.0 milestone Oct 2, 2024
@archmoj archmoj self-assigned this Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant