Skip to content
Merged
Changes from 1 commit
Commits
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
25 changes: 20 additions & 5 deletions src/plots/polar/legacy/axis_attributes.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ var axesAttrs = require('../../cartesian/layout_attributes');
var extendFlat = require('../../../lib/extend').extendFlat;
var overrideAll = require('../../../plot_api/edit_types').overrideAll;

var deprecationWarning = 'Legacy polar charts are deprecated!';

var domainAttr = extendFlat({}, axesAttrs.domain, {
description: [
'Polar chart subplots are not supported yet.',
Expand All @@ -26,6 +28,7 @@ function mergeAttrs(axisName, nonCommonAttrs) {
valType: 'boolean',
role: 'style',
description: [
deprecationWarning,
'Determines whether or not the line bounding this',
axisName, 'axis',
'will be shown on the figure.'
Expand All @@ -35,6 +38,7 @@ function mergeAttrs(axisName, nonCommonAttrs) {
valType: 'boolean',
role: 'style',
description: [
deprecationWarning,
'Determines whether or not the',
axisName, 'axis ticks',
'will feature tick labels.'
Expand All @@ -45,6 +49,7 @@ function mergeAttrs(axisName, nonCommonAttrs) {
values: ['horizontal', 'vertical'],
role: 'style',
description: [
deprecationWarning,
'Sets the orientation (from the paper perspective)',
'of the', axisName, 'axis tick labels.'
].join(' ')
Expand All @@ -54,31 +59,36 @@ function mergeAttrs(axisName, nonCommonAttrs) {
min: 0,
role: 'style',
description: [
deprecationWarning,
'Sets the length of the tick lines on this', axisName, 'axis.'
].join(' ')
},
tickcolor: {
valType: 'color',
role: 'style',
description: [
deprecationWarning,
'Sets the color of the tick lines on this', axisName, 'axis.'
].join(' ')
},
ticksuffix: {
valType: 'string',
role: 'style',
description: [
deprecationWarning,
'Sets the length of the tick lines on this', axisName, 'axis.'
].join(' ')
},
endpadding: {
valType: 'number',
role: 'style'
role: 'style',
description: deprecationWarning,
},
visible: {
valType: 'boolean',
role: 'info',
description: [
deprecationWarning,
'Determines whether or not this axis will be visible.'
].join(' ')
}
Expand All @@ -97,6 +107,7 @@ module.exports = overrideAll({
{ valType: 'number' }
],
description: [
deprecationWarning,
'Defines the start and end point of this radial axis.'
].join(' ')
},
Expand All @@ -105,6 +116,7 @@ module.exports = overrideAll({
valType: 'number',
role: 'style',
description: [
deprecationWarning,
'Sets the orientation (an angle with respect to the origin)',
'of the radial axis.'
].join(' ')
Expand All @@ -120,6 +132,7 @@ module.exports = overrideAll({
{ valType: 'number', dflt: 360 }
],
description: [
deprecationWarning,
'Defines the start and end point of this angular axis.'
].join(' ')
},
Expand All @@ -133,16 +146,18 @@ module.exports = overrideAll({
values: ['clockwise', 'counterclockwise'],
role: 'info',
description: [
'For polar plots only.',
'Sets the direction corresponding to positive angles.'
deprecationWarning,
'Sets the direction corresponding to positive angles',
'in legacy polar charts.'
].join(' ')
},
orientation: {
valType: 'angle',
role: 'info',
description: [
'For polar plots only.',
'Rotates the entire polar by the given angle.'
deprecationWarning,
'Rotates the entire polar by the given angle',
'in legacy polar charts.'
].join(' ')
}
}
Expand Down